{ "resourceType": "StructureDefinition", "id": "nexus-criteria-requirements", "extension": [ { "url": "https://fhir.apps.health/StructureDefinition/effective-date", "extension": [ { "url": "none", "valueBoolean": true } ] } ], "url": "https://fhir.apps.health/StructureDefinition/nexus-criteria-requirements", "name": "NexusCriteriaRequirements", "title": "Criteria Requirements Library Profile", "status": "draft", "experimental": false, "description": "The data-requirements manifest generated for a compiled clinical criterion: a FHIR R4 Library with `type = module-definition`, declaring the resource types the logic retrieves, the profiles they must satisfy, the code and value-set filters applied, and the elements read. Derived from the compiled logic rather than authored beside it, so it cannot drift from the criteria it describes. A deployment artifact verified when a consuming host starts, not an API surface an application reaches.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "objimpl", "uri": "http://hl7.org/fhir/object-implementation", "name": "Object Implementation Information" } ], "kind": "resource", "abstract": false, "type": "Library", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Library", "derivation": "constraint", "snapshot": { "element": [ { "id": "Library", "path": "Library", "short": "Criteria data requirements (module-definition Library)", "definition": "What data one compiled clinical criterion reads: which resource types it retrieves, which\nprofiles those must satisfy, which code and value-set filters it applies, and which of their\nelements the logic touches.\n\nDerived from the compiled logic by static analysis, never authored beside it. A criteria\nlibrary that also carries a hand-written `dataRequirement` has two answers to the same\nquestion and no way to tell which one the logic actually obeys; this is the one that cannot\nbe wrong.", "min": 0, "max": "*", "base": { "path": "Library", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "lib-0", "severity": "warning", "human": "Name should be usable as an identifier for the module by machine processing applications such as code generation", "expression": "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')", "xpath": "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[classCode=GROUPER;moodCode=EVN]" } ] }, { "id": "Library.id", "path": "Library.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "isModifier": false, "isSummary": true }, { "id": "Library.meta", "path": "Library.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.implicitRules", "path": "Library.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true }, { "id": "Library.language", "path": "Library.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } }, { "id": "Library.text", "path": "Library.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Library.contained", "path": "Library.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Library.extension", "path": "Library.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "ordered": false, "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 1, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Library.extension:criteriaRelativeDate", "path": "Library.extension", "sliceName": "criteriaRelativeDate", "short": "Whether membership can change through the passage of time alone -- always present", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "Required, including when false. Reading an absent value as false would silently skip a periodic sweep that a time-anchored cohort needed, and the cohort would go stale with every surface still reporting success.", "alias": [ "extensions", "user content" ], "min": 1, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.apps.health/StructureDefinition/criteria-relative-date" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": true, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Library.extension:criteriaElementsRead", "path": "Library.extension", "sliceName": "criteriaElementsRead", "short": "One element path per repetition, bounding what a projection must materialise", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "Repeats, one path per occurrence, and never packs several into one delimited string. Paths are flat across every resource type the manifest retrieves and carry no type prefix, so sizing a per-resource projection means intersecting this list with the types in `dataRequirement` rather than reading it directly.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.apps.health/StructureDefinition/criteria-elements-read" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": true, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Library.modifierExtension", "path": "Library.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Library.url", "path": "Library.url", "short": "Canonical URL of this manifest, minted per criterion", "definition": "An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.", "comment": "Minted from the pack's canonical base as `.../Library/-requirements`, so it is stable for a given criterion and derivable without opening the file. Two criteria in one pack claiming one canonical is a pack whose consumer cannot resolve an include, and is refused at generation.", "requirements": "Allows the library to be referenced by a single globally unique identifier.", "min": 1, "max": "1", "base": { "path": "Library.url", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".identifier[scope=BUSN;reliability=ISS]" } ] }, { "id": "Library.identifier", "path": "Library.identifier", "short": "Additional identifier for the library", "definition": "A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.", "comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.", "requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.", "min": 0, "max": "*", "base": { "path": "Library.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".identifier" }, { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Library.version", "path": "Library.version", "short": "The compiled library's own version", "definition": "The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", "comment": "Also read back out of the compiled logic. Together with `name` this is the identity an `include` in another criteria library resolves against.", "min": 1, "max": "1", "base": { "path": "Library.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "w5", "map": "FiveWs.version" }, { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.name", "path": "Library.name", "short": "The compiled library's own identifier, machine-readable", "definition": "A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.", "comment": "Read back out of the compiled logic rather than restated: it is the identifier the criteria library declares for itself, so a manifest and the ELM beside it cannot disagree about which criterion they describe.", "requirements": "Support human navigation and code generation.", "min": 1, "max": "1", "base": { "path": "Library.name", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "inv-0" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Library.title", "path": "Library.title", "short": "Name for this library (human friendly)", "definition": "A short, descriptive, user-friendly title for the library.", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min": 0, "max": "1", "base": { "path": "Library.title", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" }, { "identity": "rim", "map": ".title" } ] }, { "id": "Library.subtitle", "path": "Library.subtitle", "short": "Subordinate title of the library", "definition": "An explanatory or alternate title for the library giving additional information about its content.", "min": 0, "max": "1", "base": { "path": "Library.subtitle", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false }, { "id": "Library.status", "path": "Library.status", "short": "Always `active` -- a manifest exists only for a criterion that compiled", "definition": "The status of this library. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of libraries that are appropriate for use vs. not.", "min": 1, "max": "1", "base": { "path": "Library.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "fixedCode": "active", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PublicationStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The lifecycle status of an artifact.", "valueSet": "http://hl7.org/fhir/ValueSet/publication-status|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Definition.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": ".status" } ] }, { "id": "Library.experimental", "path": "Library.experimental", "short": "For testing purposes, not real usage", "definition": "A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", "comment": "Allows filtering of librarys that are appropriate for use versus not.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level library.", "min": 0, "max": "1", "base": { "path": "Library.experimental", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.type", "path": "Library.type", "short": "Always `module-definition` -- this Library declares requirements, it does not carry content", "definition": "Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.", "comment": "The element that separates this shape from the other Library kind published here. A `model-definition` Library carries a ModelInfo attachment and no `dataRequirement`, and is a different resource with a different purpose; do not read one as the other.", "min": 1, "max": "1", "base": { "path": "Library.type", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "patternCodeableConcept": { "coding": [ { "code": "module-definition", "system": "http://terminology.hl7.org/CodeSystem/library-type" } ] }, "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "LibraryType" } ], "strength": "extensible", "description": "The type of knowledge asset this library contains.", "valueSet": "http://hl7.org/fhir/ValueSet/library-type" }, "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": ".code" } ] }, { "id": "Library.subject[x]", "path": "Library.subject[x]", "short": "Type of individual the library content is focused on", "definition": "A code or group definition that describes the intended subject of the contents of the library.", "min": 0, "max": "1", "base": { "path": "Library.subject[x]", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "meaningWhenMissing": "Patient", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubjectType" } ], "strength": "extensible", "description": "The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).", "valueSet": "http://hl7.org/fhir/ValueSet/subject-type" } }, { "id": "Library.date", "path": "Library.date", "short": "Date last changed", "definition": "The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.", "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.", "alias": [ "Revision Date" ], "min": 0, "max": "1", "base": { "path": "Library.date", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ] }, { "id": "Library.publisher", "path": "Library.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the organization or individual that published the library.", "comment": "Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the library. May also allow for contact.", "min": 0, "max": "1", "base": { "path": "Library.publisher", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher" }, { "identity": "w5", "map": "FiveWs.witness" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] }, { "id": "Library.contact", "path": "Library.contact", "short": "Contact details for the publisher", "definition": "Contact details to assist a user in finding and communicating with the publisher.", "comment": "May be a web site, an email address, a telephone number, etc.", "min": 0, "max": "*", "base": { "path": "Library.contact", "min": 0, "max": "*" }, "type": [ { "code": "ContactDetail" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" }, { "identity": "rim", "map": ".participation[typeCode=CALLBCK].role" } ] }, { "id": "Library.description", "path": "Library.description", "short": "Natural language description of the library", "definition": "A free text natural language description of the library from a consumer's perspective.", "comment": "This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).", "min": 0, "max": "1", "base": { "path": "Library.description", "min": 0, "max": "1" }, "type": [ { "code": "markdown" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.description" }, { "identity": "rim", "map": ".text" } ] }, { "id": "Library.useContext", "path": "Library.useContext", "short": "The context that the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.", "comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "base": { "path": "Library.useContext", "min": 0, "max": "*" }, "type": [ { "code": "UsageContext" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" }, { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.jurisdiction", "path": "Library.jurisdiction", "short": "Intended jurisdiction for library (if applicable)", "definition": "A legal or geographic region in which the library is intended to be used.", "comment": "It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "base": { "path": "Library.jurisdiction", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Jurisdiction" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Countries and regions within which this artifact is targeted for use.", "valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction" }, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" }, { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.purpose", "path": "Library.purpose", "short": "Why this library is defined", "definition": "Explanation of why this library is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.", "min": 0, "max": "1", "base": { "path": "Library.purpose", "min": 0, "max": "1" }, "type": [ { "code": "markdown" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".reasonCode.text" }, { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Library.usage", "path": "Library.usage", "short": "Describes the clinical usage of the library", "definition": "A detailed description of how the library is used from a clinical perspective.", "min": 0, "max": "1", "base": { "path": "Library.usage", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.copyright", "path": "Library.copyright", "short": "Use and/or publishing restrictions", "definition": "A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.", "requirements": "Consumers must be able to determine any legal restrictions on the use of the library and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "base": { "path": "Library.copyright", "min": 0, "max": "1" }, "type": [ { "code": "markdown" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.copyright" }, { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Library.approvalDate", "path": "Library.approvalDate", "short": "When the library was approved by publisher", "definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "comment": "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.", "min": 0, "max": "1", "base": { "path": "Library.approvalDate", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.approvalDate" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime" }, { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Library.lastReviewDate", "path": "Library.lastReviewDate", "short": "When the library was last reviewed", "definition": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", "comment": "If specified, this date follows the original approval date.", "requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.", "min": 0, "max": "1", "base": { "path": "Library.lastReviewDate", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.lastReviewDate" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime" }, { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Library.effectivePeriod", "path": "Library.effectivePeriod", "short": "When the library is expected to be used", "definition": "The period during which the library content was or is planned to be in active use.", "comment": "The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.", "requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the library are or are expected to be used instead.", "min": 0, "max": "1", "base": { "path": "Library.effectivePeriod", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.effectivePeriod" }, { "identity": "rim", "map": "N/A (to add?)" }, { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Library.topic", "path": "Library.topic", "short": "E.g. Education, Treatment, Assessment, etc.", "definition": "Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.", "requirements": "Repositories must be able to determine how to categorize the library so that it can be found by topical searches.", "min": 0, "max": "*", "base": { "path": "Library.topic", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DefinitionTopic" } ], "strength": "example", "description": "High-level categorization of the definition, used for searching, sorting, and filtering.", "valueSet": "http://hl7.org/fhir/ValueSet/definition-topic" }, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.author", "path": "Library.author", "short": "Who authored the content", "definition": "An individiual or organization primarily involved in the creation and maintenance of the content.", "min": 0, "max": "*", "base": { "path": "Library.author", "min": 0, "max": "*" }, "type": [ { "code": "ContactDetail" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT]" } ] }, { "id": "Library.editor", "path": "Library.editor", "short": "Who edited the content", "definition": "An individual or organization primarily responsible for internal coherence of the content.", "min": 0, "max": "*", "base": { "path": "Library.editor", "min": 0, "max": "*" }, "type": [ { "code": "ContactDetail" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false }, { "id": "Library.reviewer", "path": "Library.reviewer", "short": "Who reviewed the content", "definition": "An individual or organization primarily responsible for review of some aspect of the content.", "min": 0, "max": "*", "base": { "path": "Library.reviewer", "min": 0, "max": "*" }, "type": [ { "code": "ContactDetail" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}" } ] }, { "id": "Library.endorser", "path": "Library.endorser", "short": "Who endorsed the content", "definition": "An individual or organization responsible for officially endorsing the content for use in some setting.", "min": 0, "max": "*", "base": { "path": "Library.endorser", "min": 0, "max": "*" }, "type": [ { "code": "ContactDetail" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}" } ] }, { "id": "Library.relatedArtifact", "path": "Library.relatedArtifact", "short": "Additional documentation, citations, etc.", "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.", "comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.", "requirements": "Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.", "min": 0, "max": "*", "base": { "path": "Library.relatedArtifact", "min": 0, "max": "*" }, "type": [ { "code": "RelatedArtifact" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}" } ] }, { "id": "Library.parameter", "path": "Library.parameter", "short": "Parameters defined by the library", "definition": "The parameter element defines parameters used by the library.", "min": 0, "max": "*", "base": { "path": "Library.parameter", "min": 0, "max": "*" }, "type": [ { "code": "ParameterDefinition" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.dataRequirement", "path": "Library.dataRequirement", "short": "The resource types the logic retrieves, with their profiles and filters", "definition": "One entry per distinct retrieve the compiled logic performs. `type` is the FHIR resource type,\n`profile` names the profile the retrieve was bound against, and `codeFilter` carries the code or\nvalue-set restriction applied to it.\n\nThis is what bounds a FETCH: union `type` across a deployment's criteria estate and the result is\nthe set of resource types an initial load has to cover. What bounds a PROJECTION is finer and is\ncarried separately, on the `criteriaElementsRead` extension below.", "comment": "Never empty. A manifest with no data requirement is not a criterion with no inputs, it is an analysis that produced nothing useful, and the two are indistinguishable from the artifact alone.", "min": 1, "max": "*", "base": { "path": "Library.dataRequirement", "min": 0, "max": "*" }, "type": [ { "code": "DataRequirement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A (to add?)" } ] }, { "id": "Library.dataRequirement.id", "path": "Library.dataRequirement.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.extension", "path": "Library.dataRequirement.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.type", "path": "Library.dataRequirement.type", "short": "The type of the required data", "definition": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.", "min": 1, "max": "1", "base": { "path": "DataRequirement.type", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRAllTypes" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.", "valueSet": "http://hl7.org/fhir/ValueSet/all-types|4.0.1" } }, { "id": "Library.dataRequirement.profile", "path": "Library.dataRequirement.profile", "short": "The profile of the required data", "definition": "The profile of the required data, specified as the uri of the profile definition.", "min": 0, "max": "*", "base": { "path": "DataRequirement.profile", "min": 0, "max": "*" }, "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.subject[x]", "path": "Library.dataRequirement.subject[x]", "short": "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device", "definition": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.", "comment": "The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.", "min": 0, "max": "1", "base": { "path": "DataRequirement.subject[x]", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "meaningWhenMissing": "Patient", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubjectType" } ], "strength": "extensible", "description": "The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).", "valueSet": "http://hl7.org/fhir/ValueSet/subject-type" } }, { "id": "Library.dataRequirement.mustSupport", "path": "Library.dataRequirement.mustSupport", "short": "Indicates specific structure elements that are referenced by the knowledge module", "definition": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. \n\nThe value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).", "min": 0, "max": "*", "base": { "path": "DataRequirement.mustSupport", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.codeFilter", "path": "Library.dataRequirement.codeFilter", "short": "What codes are expected", "definition": "Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.", "min": 0, "max": "*", "base": { "path": "DataRequirement.codeFilter", "min": 0, "max": "*" }, "type": [ { "code": "Element" } ], "constraint": [ { "key": "drq-1", "severity": "error", "human": "Either a path or a searchParam must be provided, but not both", "expression": "path.exists() xor searchParam.exists()", "xpath": "(exists(f:path) and not(exists(f:searchParam))) or (not(exists(f:path)) and exists(f:searchParam))" }, { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.codeFilter.id", "path": "Library.dataRequirement.codeFilter.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.codeFilter.extension", "path": "Library.dataRequirement.codeFilter.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.codeFilter.path", "path": "Library.dataRequirement.codeFilter.path", "short": "The element the codes apply to -- always present on a generated manifest", "definition": "The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.", "comment": "A path relative to the retrieved resource (`code`, `medication`). Where the retrieved profile declares a primary code path, this is that element; where it declares none, a bare code filter is refused at generation rather than quietly matched against the wrong element. `searchParam` is not used as an alternative here.", "min": 1, "max": "1", "base": { "path": "DataRequirement.codeFilter.path", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.codeFilter.searchParam", "path": "Library.dataRequirement.codeFilter.searchParam", "short": "A coded (token) parameter to search on", "definition": "A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.", "min": 0, "max": "1", "base": { "path": "DataRequirement.codeFilter.searchParam", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.codeFilter.valueSet", "path": "Library.dataRequirement.codeFilter.valueSet", "short": "Valueset for the filter", "definition": "The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.", "min": 0, "max": "1", "base": { "path": "DataRequirement.codeFilter.valueSet", "min": 0, "max": "1" }, "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ValueSet" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.codeFilter.code", "path": "Library.dataRequirement.codeFilter.code", "short": "What code is expected", "definition": "The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.", "min": 0, "max": "*", "base": { "path": "DataRequirement.codeFilter.code", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.dateFilter", "path": "Library.dataRequirement.dateFilter", "short": "What dates/date ranges are expected", "definition": "Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.", "min": 0, "max": "*", "base": { "path": "DataRequirement.dateFilter", "min": 0, "max": "*" }, "type": [ { "code": "Element" } ], "constraint": [ { "key": "drq-2", "severity": "error", "human": "Either a path or a searchParam must be provided, but not both", "expression": "path.exists() xor searchParam.exists()", "xpath": "(exists(f:path) and not(exists(f:searchParam))) or (not(exists(f:path)) and exists(f:searchParam))" }, { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.dateFilter.id", "path": "Library.dataRequirement.dateFilter.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.dateFilter.extension", "path": "Library.dataRequirement.dateFilter.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.dateFilter.path", "path": "Library.dataRequirement.dateFilter.path", "short": "A date-valued attribute to filter on", "definition": "The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.", "comment": "The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.", "min": 0, "max": "1", "base": { "path": "DataRequirement.dateFilter.path", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.dateFilter.searchParam", "path": "Library.dataRequirement.dateFilter.searchParam", "short": "A date valued parameter to search on", "definition": "A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.", "min": 0, "max": "1", "base": { "path": "DataRequirement.dateFilter.searchParam", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.dateFilter.value[x]", "path": "Library.dataRequirement.dateFilter.value[x]", "short": "The value of the filter, as a Period, DateTime, or Duration value", "definition": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.", "min": 0, "max": "1", "base": { "path": "DataRequirement.dateFilter.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Duration" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.limit", "path": "Library.dataRequirement.limit", "short": "Number of results", "definition": "Specifies a maximum number of results that are required (uses the _count search parameter).", "comment": "This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\".", "requirements": "Enables the requirement \"most recent 5 results\" to be expressed.", "min": 0, "max": "1", "base": { "path": "DataRequirement.limit", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.sort", "path": "Library.dataRequirement.sort", "short": "Order of the results", "definition": "Specifies the order of the results to be returned.", "comment": "This element can be used in combination with the sort element to specify quota requirements such as \"the most recent 5\" or \"the highest 5\". When multiple sorts are specified, they are applied in the order they appear in the resource.", "requirements": "Enables the requirement \"most recent 5 results\" to be expressed.", "min": 0, "max": "*", "base": { "path": "DataRequirement.sort", "min": 0, "max": "*" }, "type": [ { "code": "Element" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.sort.id", "path": "Library.dataRequirement.sort.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.sort.extension", "path": "Library.dataRequirement.sort.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Library.dataRequirement.sort.path", "path": "Library.dataRequirement.sort.path", "short": "The name of the attribute to perform the sort", "definition": "The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.", "min": 1, "max": "1", "base": { "path": "DataRequirement.sort.path", "min": 1, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Library.dataRequirement.sort.direction", "path": "Library.dataRequirement.sort.direction", "short": "ascending | descending", "definition": "The direction of the sort, ascending or descending.", "min": 1, "max": "1", "base": { "path": "DataRequirement.sort.direction", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SortDirection" } ], "strength": "required", "description": "The possible sort directions, ascending or descending.", "valueSet": "http://hl7.org/fhir/ValueSet/sort-direction|4.0.1" } }, { "id": "Library.content", "path": "Library.content", "short": "Contents of the library, either embedded or referenced", "definition": "The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.", "min": 0, "max": "*", "base": { "path": "Library.content", "min": 0, "max": "*" }, "type": [ { "code": "Attachment" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] } ] }, "differential": { "element": [ { "id": "Library", "path": "Library", "short": "Criteria data requirements (module-definition Library)", "definition": "What data one compiled clinical criterion reads: which resource types it retrieves, which\nprofiles those must satisfy, which code and value-set filters it applies, and which of their\nelements the logic touches.\n\nDerived from the compiled logic by static analysis, never authored beside it. A criteria\nlibrary that also carries a hand-written `dataRequirement` has two answers to the same\nquestion and no way to tell which one the logic actually obeys; this is the one that cannot\nbe wrong." }, { "id": "Library.extension", "path": "Library.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "ordered": false, "rules": "open" }, "min": 1 }, { "id": "Library.extension:criteriaRelativeDate", "path": "Library.extension", "sliceName": "criteriaRelativeDate", "short": "Whether membership can change through the passage of time alone -- always present", "comment": "Required, including when false. Reading an absent value as false would silently skip a periodic sweep that a time-anchored cohort needed, and the cohort would go stale with every surface still reporting success.", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.apps.health/StructureDefinition/criteria-relative-date" ] } ], "mustSupport": true }, { "id": "Library.extension:criteriaElementsRead", "path": "Library.extension", "sliceName": "criteriaElementsRead", "short": "One element path per repetition, bounding what a projection must materialise", "comment": "Repeats, one path per occurrence, and never packs several into one delimited string. Paths are flat across every resource type the manifest retrieves and carry no type prefix, so sizing a per-resource projection means intersecting this list with the types in `dataRequirement` rather than reading it directly.", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "https://fhir.apps.health/StructureDefinition/criteria-elements-read" ] } ], "mustSupport": true }, { "id": "Library.url", "path": "Library.url", "short": "Canonical URL of this manifest, minted per criterion", "comment": "Minted from the pack's canonical base as `.../Library/-requirements`, so it is stable for a given criterion and derivable without opening the file. Two criteria in one pack claiming one canonical is a pack whose consumer cannot resolve an include, and is refused at generation.", "min": 1, "mustSupport": true }, { "id": "Library.version", "path": "Library.version", "short": "The compiled library's own version", "comment": "Also read back out of the compiled logic. Together with `name` this is the identity an `include` in another criteria library resolves against.", "min": 1, "mustSupport": true }, { "id": "Library.name", "path": "Library.name", "short": "The compiled library's own identifier, machine-readable", "comment": "Read back out of the compiled logic rather than restated: it is the identifier the criteria library declares for itself, so a manifest and the ELM beside it cannot disagree about which criterion they describe.", "min": 1, "mustSupport": true }, { "id": "Library.status", "path": "Library.status", "short": "Always `active` -- a manifest exists only for a criterion that compiled", "fixedCode": "active", "mustSupport": true }, { "id": "Library.type", "path": "Library.type", "short": "Always `module-definition` -- this Library declares requirements, it does not carry content", "comment": "The element that separates this shape from the other Library kind published here. A `model-definition` Library carries a ModelInfo attachment and no `dataRequirement`, and is a different resource with a different purpose; do not read one as the other.", "patternCodeableConcept": { "coding": [ { "code": "module-definition", "system": "http://terminology.hl7.org/CodeSystem/library-type" } ] }, "mustSupport": true }, { "id": "Library.dataRequirement", "path": "Library.dataRequirement", "short": "The resource types the logic retrieves, with their profiles and filters", "definition": "One entry per distinct retrieve the compiled logic performs. `type` is the FHIR resource type,\n`profile` names the profile the retrieve was bound against, and `codeFilter` carries the code or\nvalue-set restriction applied to it.\n\nThis is what bounds a FETCH: union `type` across a deployment's criteria estate and the result is\nthe set of resource types an initial load has to cover. What bounds a PROJECTION is finer and is\ncarried separately, on the `criteriaElementsRead` extension below.", "comment": "Never empty. A manifest with no data requirement is not a criterion with no inputs, it is an analysis that produced nothing useful, and the two are indistinguishable from the artifact alone.", "min": 1, "mustSupport": true }, { "id": "Library.dataRequirement.codeFilter.path", "path": "Library.dataRequirement.codeFilter.path", "short": "The element the codes apply to -- always present on a generated manifest", "comment": "A path relative to the retrieved resource (`code`, `medication`). Where the retrieved profile declares a primary code path, this is that element; where it declares none, a bare code filter is refused at generation rather than quietly matched against the wrong element. `searchParam` is not used as an alternative here.", "min": 1, "mustSupport": true } ] } }