Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1

Publication Build: This will be filled in by the publication tooling

## Resource Profile: CRMIModuleDefinitionLibrary - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 3

Definitions for the crmi-moduledefinitionlibrary resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Library
Must Support | false
2. Library.extension:directReferenceCode
Slice Name | directReferenceCode
Control | 0..*
Type | Extension(Direct reference code) (Extension Type: Coding)
Must Support | true
Requirements | A module definition library must describe the direct-reference codes it uses.
4. Library.extension:logicDefinition
Slice Name | logicDefinition
Control | 0..*
Type | Extension(Logic definition) (Complex Extension)
Must Support | true
Requirements | A module definition library must be able to describe the logic definitions it uses.
6. Library.extension:inputParameters
Slice Name | inputParameters
Control | 0..1
Type | Extension(Input parameters) (Extension Type: Reference(Parameters))
Must Support | true
8. Library.type
Control | 1..1
Type | CodeableConcept
Must Support | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/library-type", "code" : "module-definition" }] }`
10. Library.subject[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
Requirements | A module definition library must report the subject it operates on.
12. Library.relatedArtifact
Definition | Any referenced dependencies including other logic libraries, model definitions, or terminologies.
Short | Dependencies used by the artifact
Must Support | true
Requirements | A module definition library must describe the dependencies it requires.
14. Library.parameter
Must Support | true
Requirements | A module definition library must define any input and output parameters.
16. Library.parameter.extension:defaultValue
Slice Name | defaultValue
Control | 0..1
Type | Extension(Default Value) (Extension Type: Choice of: string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, Quantity, Ratio)
Must Support | true
18. Library.dataRequirement
Comments | Include data requirements for any data referenced by logic in the module. Systems MAY include a profile reference in the data requirement if the logic expects a specific profile. When elements are referenced in the logic, systems MAY communicate this using the mustSupport element of the data requirement. If the element is an extension, the mustSupport will be a FHIRPath referencing the extension (e.g. `extension('http://example.org/fhir/StructureDefinition/example-extension')`), and the mustSupport list will include a `rendered-value` extension with the slice name of the extension for human-readable views. For CQL-based logic, refer to the Parameters and DataRequirements topic in the Using CQL With FHIR IG.
Must Support | true
Requirements | A module definition library must declare any data requirements.
20. Library.dataRequirement.extension:isSelective
Slice Name | isSelective
Definition | specifies whether a given DataRequirement is "selective", meaning that it can be used, along with other selective requirements, to determine whether an artifact is applicable to a particular subject.
Short | specifies whether a given DataRequirement is "selective"
Comments | Although this extension may be used by artifact authors as a way to indicate expected selectivity of a data requirement, it will more typically be used by implementers and downstream packaging repositories to indicate selectivity of a data requirement given known data heuristics in particular datasets.
Control | 0..1
Type | Extension(Is Selective) (Extension Type: boolean)
Must Support | true
22. Library.dataRequirement.extension:valueFilter
Slice Name | valueFilter
Comments | Supports describing additional filtering information for the data requirement. For example a restriction of encounter data to `finished` encounters.
Control | 0..*
Type | Extension(Value Filter) (Complex Extension)
Must Support | true
24. Library.dataRequirement.extension:fhirQueryPattern
Slice Name | fhirQueryPattern
Control | 0..*
Type | Extension(FHIR Query Pattern) (Extension Type: string)
Must Support | false
26. Library.content
Control | 0..0
Must Support | false

Guidance on how to interpret the contents of this table can be found here

0. Library
Definition | The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
Short | Represents a library of quality improvement components
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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 (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()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (`name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`) lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. Library.implicitRules
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.
Short | A set of rules under which this content was created
Comments | 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.
Control | 0..1
Type | uri
Is Modifier | true because 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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Library.extension:directReferenceCode
Slice Name | directReferenceCode
Definition | Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of `depends-on`. However, direct-reference codes cannot be represented in the relatedArtifact element, so this extension provides a means to support communicating direct-reference code dependencies of knowledge artifacts. As with value set dependencies, direct-reference codes may be the terminology target of a data requirement.
Short | A code directly referenced by the artifact
Control | 0..*
Type | Extension(Direct reference code) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Requirements | A module definition library must describe the direct-reference codes it uses.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Library.extension:logicDefinition
Slice Name | logicDefinition
Definition | Represents a specific logic definition used by the artifact. When logic is referenced from knowledge artifacts, this extension allows each referenced definition to be represented independently so that consumers know which specific expressions are being referenced (i.e. not all expressions in a given library are always used), as well as allows processing applications (such as narrative generation) to easily surface the definitions to provide capabilities such as navigation.
Short | A logic definition used in the artifact
Control | 0..*
Type | Extension(Logic definition) (Complex Extension)
Is Modifier | false
Must Support | true
Requirements | A module definition library must be able to describe the logic definitions it uses.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Library.extension:inputParameters
Slice Name | inputParameters
Definition | Specifies the input parameters to the operation (such as a test case description or a data requirements or evaluate operation). This extension can be used as part of the result of an operation to indicate what the parameters were, but it can also be used as part of the definition of a test case to specify what the input parameters are expected to be for the test case.
Short | What parameters
Control | 0..1
Type | Extension(Input parameters) (Extension Type: Reference(Parameters))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Library.modifierExtension
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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Library.status
Definition | The status of this library. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of libraries that are appropriate for use vs. not.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Library.type
Definition | Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
Short | logic-library | model-definition | asset-collection | module-definition
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from LibraryType http://hl7.org/fhir/ValueSet/library-type (extensible to `http://hl7.org/fhir/ValueSet/library-type` ) The type of knowledge asset this library contains.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/library-type", "code" : "module-definition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Library.subject[x]
Definition | A code or group definition that describes the intended subject of the contents of the library.
Short | Type of individual the library content is focused on
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType http://hl7.org/fhir/ValueSet/subject-type (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Requirements | A module definition library must report the subject it operates on.
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Library.relatedArtifact
Definition | Any referenced dependencies including other logic libraries, model definitions, or terminologies. Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Dependencies used by the artifactAdditional documentation, citations, etc.
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | A module definition library must describe the dependencies it requires. 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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Library.parameter
Definition | The parameter element defines parameters used by the library.
Short | Parameters defined by the library
Control | 0..*
Type | ParameterDefinition
Is Modifier | false
Must Support | true
Summary | false
Requirements | A module definition library must define any input and output parameters.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Library.parameter.extension:defaultValue
Slice Name | defaultValue
Definition | An Extension
Short | Extension
Control | 0..1
Type | Extension(Default Value) (Extension Type: Choice of: string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, Quantity, Ratio)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Library.parameter.use
Definition | Whether the parameter is input or output for the module.
Short | in | out
Control | 1..1
Binding | The codes SHALL be taken from OperationParameterUse http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1` ) Whether the parameter is input or output.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Library.parameter.type
Definition | The type of the parameter.
Short | What type of value
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Library.dataRequirement
Definition | Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
Short | What data is referenced by this library
Comments | Include data requirements for any data referenced by logic in the module. Systems MAY include a profile reference in the data requirement if the logic expects a specific profile. When elements are referenced in the logic, systems MAY communicate this using the mustSupport element of the data requirement. If the element is an extension, the mustSupport will be a FHIRPath referencing the extension (e.g. `extension('http://example.org/fhir/StructureDefinition/example-extension')`), and the mustSupport list will include a `rendered-value` extension with the slice name of the extension for human-readable views. For CQL-based logic, refer to the Parameters and DataRequirements topic in the Using CQL With FHIR IG.
Control | 0..*
Type | DataRequirement
Is Modifier | false
Must Support | true
Summary | false
Requirements | A module definition library must declare any data requirements.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Library.dataRequirement.extension:isSelective
Slice Name | isSelective
Definition | specifies whether a given DataRequirement is "selective", meaning that it can be used, along with other selective requirements, to determine whether an artifact is applicable to a particular subject.
Short | specifies whether a given DataRequirement is "selective"
Comments | Although this extension may be used by artifact authors as a way to indicate expected selectivity of a data requirement, it will more typically be used by implementers and downstream packaging repositories to indicate selectivity of a data requirement given known data heuristics in particular datasets.
Control | 0..1
Type | Extension(Is Selective) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Library.dataRequirement.extension:valueFilter
Slice Name | valueFilter
Definition | Allows additional value-based filters to be specified as part of a data requirement.
Short | Extension
Comments | Supports describing additional filtering information for the data requirement. For example a restriction of encounter data to `finished` encounters.
Control | 0..*
Type | Extension(Value Filter) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. Library.dataRequirement.extension:fhirQueryPattern
Slice Name | fhirQueryPattern
Definition | A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId.
Short | What FHIR query?
Comments | Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.
Control | 0..*
Type | Extension(FHIR Query Pattern) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Library.dataRequirement.type
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.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Library.content
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.
Short | Contents of the library, either embedded or referenced
Control | 0..0*
Type | Attachment
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Library
Definition | The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
Short | Represents a library of quality improvement components
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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 (`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()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (`name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`)
2. Library.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. Library.meta
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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Library.implicitRules
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.
Short | A set of rules under which this content was created
Comments | 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.
Control | 0..1
Type | uri
Is Modifier | true because 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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Library.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | 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).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Library.text
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.
Short | Text summary of the resource, for human interpretation
Comments | 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.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Library.contained
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.
Short | Contained, inline Resources
Comments | 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.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Library.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Library.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. Library.extension:directReferenceCode
Slice Name | directReferenceCode
Definition | Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of `depends-on`. However, direct-reference codes cannot be represented in the relatedArtifact element, so this extension provides a means to support communicating direct-reference code dependencies of knowledge artifacts. As with value set dependencies, direct-reference codes may be the terminology target of a data requirement.
Short | A code directly referenced by the artifact
Control | 0..*
Type | Extension(Direct reference code) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Requirements | A module definition library must describe the direct-reference codes it uses.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Library.extension:logicDefinition
Slice Name | logicDefinition
Definition | Represents a specific logic definition used by the artifact. When logic is referenced from knowledge artifacts, this extension allows each referenced definition to be represented independently so that consumers know which specific expressions are being referenced (i.e. not all expressions in a given library are always used), as well as allows processing applications (such as narrative generation) to easily surface the definitions to provide capabilities such as navigation.
Short | A logic definition used in the artifact
Control | 0..*
Type | Extension(Logic definition) (Complex Extension)
Is Modifier | false
Must Support | true
Requirements | A module definition library must be able to describe the logic definitions it uses.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. Library.extension:inputParameters
Slice Name | inputParameters
Definition | Specifies the input parameters to the operation (such as a test case description or a data requirements or evaluate operation). This extension can be used as part of the result of an operation to indicate what the parameters were, but it can also be used as part of the definition of a test case to specify what the input parameters are expected to be for the test case.
Short | What parameters
Control | 0..1
Type | Extension(Input parameters) (Extension Type: Reference(Parameters))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. Library.modifierExtension
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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. Library.url
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.
Short | Canonical identifier for this library, represented as a URI (globally unique)
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the library to be referenced by a single globally unique identifier.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Library.identifier
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.
Short | Additional identifier for the library
Comments | 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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Library.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.
Short | Business version of the library
Comments | There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version].
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Library.name
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.
Short | Name for this library (computer friendly)
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Control | 0..1 This element is affected by the following invariants: inv-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Support human navigation and code generation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Library.title
Definition | A short, descriptive, user-friendly title for the library.
Short | Name for this library (human friendly)
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Library.subtitle
Definition | An explanatory or alternate title for the library giving additional information about its content.
Short | Subordinate title of the library
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Library.status
Definition | The status of this library. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of libraries that are appropriate for use vs. not.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. Library.experimental
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.
Short | For testing purposes, not real usage
Comments | Allows filtering of librarys that are appropriate for use versus not.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level library.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Library.type
Definition | Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
Short | logic-library | model-definition | asset-collection | module-definition
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from LibraryType (extensible to `http://hl7.org/fhir/ValueSet/library-type` ) The type of knowledge asset this library contains.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/library-type", "code" : "module-definition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Library.subject[x]
Definition | A code or group definition that describes the intended subject of the contents of the library.
Short | Type of individual the library content is focused on
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Requirements | A module definition library must report the subject it operates on.
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Library.date
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.
Short | Date last changed
Comments | 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.
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Revision Date
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Library.publisher
Definition | The name of the organization or individual that published the library.
Short | Name of the publisher (organization or individual)
Comments | 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Helps establish the "authority/credibility" of the library. May also allow for contact.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Library.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Library.description
Definition | A free text natural language description of the library from a consumer's perspective.
Short | Natural language description of the library
Comments | 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).
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Library.useContext
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.
Short | The context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Library.jurisdiction
Definition | A legal or geographic region in which the library is intended to be used.
Short | Intended jurisdiction for library (if applicable)
Comments | It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to `http://hl7.org/fhir/ValueSet/jurisdiction` ) Countries and regions within which this artifact is targeted for use.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Library.purpose
Definition | Explanation of why this library is needed and why it has been designed as it has.
Short | Why this library is defined
Comments | 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.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Library.usage
Definition | A detailed description of how the library is used from a clinical perspective.
Short | Describes the clinical usage of the library
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Library.copyright
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.
Short | Use and/or publishing restrictions
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Consumers must be able to determine any legal restrictions on the use of the library and/or its content.
Alternate Names | License, Restrictions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Library.approvalDate
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Short | When the library was approved by publisher
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Library.lastReviewDate
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Short | When the library was last reviewed
Comments | If specified, this date follows the original approval date.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Library.effectivePeriod
Definition | The period during which the library content was or is planned to be in active use.
Short | When the library is expected to be used
Comments | 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.
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Library.topic
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.
Short | E.g. Education, Treatment, Assessment, etc.
Control | 0..*
Binding | For example codes, see DefinitionTopic (example to `http://hl7.org/fhir/ValueSet/definition-topic` ) High-level categorization of the definition, used for searching, sorting, and filtering.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Repositories must be able to determine how to categorize the library so that it can be found by topical searches.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Library.author
Definition | An individiual or organization primarily involved in the creation and maintenance of the content.
Short | Who authored the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Library.editor
Definition | An individual or organization primarily responsible for internal coherence of the content.
Short | Who edited the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Library.reviewer
Definition | An individual or organization primarily responsible for review of some aspect of the content.
Short | Who reviewed the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Library.endorser
Definition | An individual or organization responsible for officially endorsing the content for use in some setting.
Short | Who endorsed the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Library.relatedArtifact
Definition | Any referenced dependencies including other logic libraries, model definitions, or terminologies.
Short | Dependencies used by the artifact
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | A module definition library must describe the dependencies it requires.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. Library.parameter
Definition | The parameter element defines parameters used by the library.
Short | Parameters defined by the library
Control | 0..*
Type | ParameterDefinition
Is Modifier | false
Must Support | true
Summary | false
Requirements | A module definition library must define any input and output parameters.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. Library.parameter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
84. Library.parameter.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Library.parameter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
86. Library.parameter.extension:defaultValue
Slice Name | defaultValue
Definition | An Extension
Short | Extension
Control | 0..1
Type | Extension(Default Value) (Extension Type: Choice of: string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, Quantity, Ratio)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
88. Library.parameter.name
Definition | The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
Short | Name used to access the parameter value
Control | 0..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. Library.parameter.use
Definition | Whether the parameter is input or output for the module.
Short | in | out
Control | 1..1
Binding | The codes SHALL be taken from OperationParameterUse (required to `http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1` ) Whether the parameter is input or output.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. Library.parameter.min
Definition | The minimum number of times this parameter SHALL appear in the request or response.
Short | Minimum cardinality
Control | 0..1
Type | integer
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. Library.parameter.max
Definition | The maximum number of times this element is permitted to appear in the request or response.
Short | Maximum cardinality (a number of *)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. Library.parameter.documentation
Definition | A brief discussion of what the parameter is for and how it is used by the module.
Short | A brief description of the parameter
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. Library.parameter.type
Definition | The type of the parameter.
Short | What type of value
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Library.parameter.profile
Definition | If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
Short | What profile the value is expected to be
Control | 0..1
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. Library.dataRequirement
Definition | Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
Short | What data is referenced by this library
Comments | Include data requirements for any data referenced by logic in the module. Systems MAY include a profile reference in the data requirement if the logic expects a specific profile. When elements are referenced in the logic, systems MAY communicate this using the mustSupport element of the data requirement. If the element is an extension, the mustSupport will be a FHIRPath referencing the extension (e.g. `extension('http://example.org/fhir/StructureDefinition/example-extension')`), and the mustSupport list will include a `rendered-value` extension with the slice name of the extension for human-readable views. For CQL-based logic, refer to the Parameters and DataRequirements topic in the Using CQL With FHIR IG.
Control | 0..*
Type | DataRequirement
Is Modifier | false
Must Support | true
Summary | false
Requirements | A module definition library must declare any data requirements.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. Library.dataRequirement.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
106. Library.dataRequirement.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Library.dataRequirement.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
108. Library.dataRequirement.extension:isSelective
Slice Name | isSelective
Definition | specifies whether a given DataRequirement is "selective", meaning that it can be used, along with other selective requirements, to determine whether an artifact is applicable to a particular subject.
Short | specifies whether a given DataRequirement is "selective"
Comments | Although this extension may be used by artifact authors as a way to indicate expected selectivity of a data requirement, it will more typically be used by implementers and downstream packaging repositories to indicate selectivity of a data requirement given known data heuristics in particular datasets.
Control | 0..1
Type | Extension(Is Selective) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
110. Library.dataRequirement.extension:valueFilter
Slice Name | valueFilter
Definition | Allows additional value-based filters to be specified as part of a data requirement.
Short | Extension
Comments | Supports describing additional filtering information for the data requirement. For example a restriction of encounter data to `finished` encounters.
Control | 0..*
Type | Extension(Value Filter) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
112. Library.dataRequirement.extension:fhirQueryPattern
Slice Name | fhirQueryPattern
Definition | A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId.
Short | What FHIR query?
Comments | Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.
Control | 0..*
Type | Extension(FHIR Query Pattern) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
114. Library.dataRequirement.type
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.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. Library.dataRequirement.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. Library.dataRequirement.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | 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.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. Library.dataRequirement.mustSupport
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. The 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 for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. Library.dataRequirement.codeFilter
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.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. Library.dataRequirement.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
126. Library.dataRequirement.codeFilter.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Library.dataRequirement.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
128. Library.dataRequirement.codeFilter.path
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 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.
Short | A code-valued attribute to filter on
Comments | The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. Library.dataRequirement.codeFilter.searchParam
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.
Short | A coded (token) parameter to search on
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. Library.dataRequirement.codeFilter.valueSet
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.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. Library.dataRequirement.codeFilter.code
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.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. Library.dataRequirement.dateFilter
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.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. Library.dataRequirement.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
140. Library.dataRequirement.dateFilter.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Library.dataRequirement.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
142. Library.dataRequirement.dateFilter.path
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 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.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. Library.dataRequirement.dateFilter.searchParam
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.
Short | A date valued parameter to search on
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. Library.dataRequirement.dateFilter.value[x]
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.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. Library.dataRequirement.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | 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".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. Library.dataRequirement.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | 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.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. Library.dataRequirement.sort.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
154. Library.dataRequirement.sort.extension
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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Library.dataRequirement.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
156. Library.dataRequirement.sort.path
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.
Short | The name of the attribute to perform the sort
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. Library.dataRequirement.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. Library.content
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.
Short | Contents of the library, either embedded or referenced
Control | 0..0
Type | Attachment
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)