Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Executable Library

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-executablelibrary Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIExecutableLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.25

The CRMI Execuable Library profile defines the must support elements for an executable library used to support artifact logic

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0, exc-1
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Required dependencies
Library.parameter This element must be supported. 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement This element must be supported. 0..* DataRequirement What data is referenced by this library
Library.dataRequirement.Slices for extension Content/Rules for all slices
Library.dataRequirement.Slices for extension.extension:fhirQueryPattern 0..* string What FHIR query?
URL: http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern
Library.dataRequirement.type This element is included in summaries. 1..1 code The type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Library.content This element must be supported. This element is included in summaries. 1..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.dataRequirement.​type Base required FHIRAllTypes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error Library If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
lib-0 warning Library 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}')

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: exc-1
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Required dependencies
Library.parameter This element must be supported. 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement.Slices for extension Content/Rules for all slices
Library.dataRequirement.Slices for extension.extension:fhirQueryPattern 0..* string What FHIR query?
URL: http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern
Library.content This element must be supported. 1..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
exc-1 error Library If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0, exc-1
Library.id This element is included in summaries. 0..1 id Logical id of this artifact
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Library.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.contained 0..* Resource Contained, inline Resources
Library.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.url This element is included in summaries. 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.identifier This element is included in summaries. 0..* Identifier Additional identifier for the library
Library.version This element is included in summaries. 0..1 string Business version of the library
Library.name This element is included in summaries. C 0..1 string Name for this library (computer friendly)
Library.title This element is included in summaries. 0..1 string Name for this library (human friendly)
Library.subtitle 0..1 string Subordinate title of the library
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
Library.subject[x].subjectCodeableConcept CodeableConcept
Library.subject[x].subjectReference Reference(Group)
Library.date This element is included in summaries. 0..1 dateTime Date last changed
Library.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
Library.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Library.description This element is included in summaries. 0..1 markdown Natural language description of the library
Library.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose 0..1 markdown Why this library is defined
Library.usage 0..1 string Describes the clinical usage of the library
Library.copyright 0..1 markdown Use and/or publishing restrictions
Library.approvalDate 0..1 date When the library was approved by publisher
Library.lastReviewDate 0..1 date When the library was last reviewed
Library.effectivePeriod This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author 0..* ContactDetail Who authored the content
Library.editor 0..* ContactDetail Who edited the content
Library.reviewer 0..* ContactDetail Who reviewed the content
Library.endorser 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Required dependencies
Library.parameter This element must be supported. 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement This element must be supported. 0..* DataRequirement What data is referenced by this library
Library.dataRequirement.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.Slices for extension.extension:fhirQueryPattern 0..* string What FHIR query?
URL: http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern
Library.dataRequirement.type This element is included in summaries. 1..1 code The type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Library.dataRequirement.profile This element is included in summaries. 0..* canonical(StructureDefinition) The profile of the required data
Library.dataRequirement.subject[x] This element is included in summaries. 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Library.dataRequirement.subject[x].subjectCodeableConcept CodeableConcept
Library.dataRequirement.subject[x].subjectReference Reference(Group)
Library.dataRequirement.mustSupport This element is included in summaries. 0..* string Indicates specific structure elements that are referenced by the knowledge module
Library.dataRequirement.codeFilter This element is included in summaries. C 0..* Element What codes are expected
Constraints: drq-1
Library.dataRequirement.codeFilter.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.codeFilter.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.codeFilter.path This element is included in summaries. 0..1 string A code-valued attribute to filter on
Library.dataRequirement.codeFilter.searchParam This element is included in summaries. 0..1 string A coded (token) parameter to search on
Library.dataRequirement.codeFilter.valueSet This element is included in summaries. 0..1 canonical(ValueSet) Valueset for the filter
Library.dataRequirement.codeFilter.code This element is included in summaries. 0..* Coding What code is expected
Library.dataRequirement.dateFilter This element is included in summaries. C 0..* Element What dates/date ranges are expected
Constraints: drq-2
Library.dataRequirement.dateFilter.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.dateFilter.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.dateFilter.path This element is included in summaries. 0..1 string A date-valued attribute to filter on
Library.dataRequirement.dateFilter.searchParam This element is included in summaries. 0..1 string A date valued parameter to search on
Library.dataRequirement.dateFilter.value[x] This element is included in summaries. 0..1 The value of the filter, as a Period, DateTime, or Duration value
Library.dataRequirement.dateFilter.value[x].valueDateTime dateTime
Library.dataRequirement.dateFilter.value[x].valuePeriod Period
Library.dataRequirement.dateFilter.value[x].valueDuration Duration
Library.dataRequirement.limit This element is included in summaries. 0..1 positiveInt Number of results
Library.dataRequirement.sort This element is included in summaries. 0..* Element Order of the results
Library.dataRequirement.sort.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.sort.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.sort.path This element is included in summaries. 1..1 string The name of the attribute to perform the sort
Library.dataRequirement.sort.direction This element is included in summaries. 1..1 code ascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.
Library.content This element must be supported. This element is included in summaries. 1..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.dataRequirement.​type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
Library.dataRequirement.​subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.dataRequirement.​sort.direction Base required SortDirection 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
drq-1 error Library.dataRequirement.codeFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
drq-2 error Library.dataRequirement.dateFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error Library If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
lib-0 warning Library 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}')

This structure is derived from Library

Summary

Mandatory: 1 element
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0, exc-1
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Required dependencies
Library.parameter This element must be supported. 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement This element must be supported. 0..* DataRequirement What data is referenced by this library
Library.dataRequirement.Slices for extension Content/Rules for all slices
Library.dataRequirement.Slices for extension.extension:fhirQueryPattern 0..* string What FHIR query?
URL: http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern
Library.dataRequirement.type This element is included in summaries. 1..1 code The type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Library.content This element must be supported. This element is included in summaries. 1..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.dataRequirement.​type Base required FHIRAllTypes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error Library If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
lib-0 warning Library 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}')

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: exc-1
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Required dependencies
Library.parameter This element must be supported. 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement This element must be supported. 0..* DataRequirement What data is referenced by this library
Library.dataRequirement.Slices for extension Content/Rules for all slices
Library.dataRequirement.Slices for extension.extension:fhirQueryPattern 0..* string What FHIR query?
URL: http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern
Library.content This element must be supported. 1..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
exc-1 error Library If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0, exc-1
Library.id This element is included in summaries. 0..1 id Logical id of this artifact
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Library.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.contained 0..* Resource Contained, inline Resources
Library.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.url This element is included in summaries. 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.identifier This element is included in summaries. 0..* Identifier Additional identifier for the library
Library.version This element is included in summaries. 0..1 string Business version of the library
Library.name This element is included in summaries. C 0..1 string Name for this library (computer friendly)
Library.title This element is included in summaries. 0..1 string Name for this library (human friendly)
Library.subtitle 0..1 string Subordinate title of the library
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
Library.subject[x].subjectCodeableConcept CodeableConcept
Library.subject[x].subjectReference Reference(Group)
Library.date This element is included in summaries. 0..1 dateTime Date last changed
Library.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
Library.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Library.description This element is included in summaries. 0..1 markdown Natural language description of the library
Library.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose 0..1 markdown Why this library is defined
Library.usage 0..1 string Describes the clinical usage of the library
Library.copyright 0..1 markdown Use and/or publishing restrictions
Library.approvalDate 0..1 date When the library was approved by publisher
Library.lastReviewDate 0..1 date When the library was last reviewed
Library.effectivePeriod This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author 0..* ContactDetail Who authored the content
Library.editor 0..* ContactDetail Who edited the content
Library.reviewer 0..* ContactDetail Who reviewed the content
Library.endorser 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Required dependencies
Library.parameter This element must be supported. 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement This element must be supported. 0..* DataRequirement What data is referenced by this library
Library.dataRequirement.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.Slices for extension.extension:fhirQueryPattern 0..* string What FHIR query?
URL: http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern
Library.dataRequirement.type This element is included in summaries. 1..1 code The type of the required data
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Library.dataRequirement.profile This element is included in summaries. 0..* canonical(StructureDefinition) The profile of the required data
Library.dataRequirement.subject[x] This element is included in summaries. 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Library.dataRequirement.subject[x].subjectCodeableConcept CodeableConcept
Library.dataRequirement.subject[x].subjectReference Reference(Group)
Library.dataRequirement.mustSupport This element is included in summaries. 0..* string Indicates specific structure elements that are referenced by the knowledge module
Library.dataRequirement.codeFilter This element is included in summaries. C 0..* Element What codes are expected
Constraints: drq-1
Library.dataRequirement.codeFilter.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.codeFilter.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.codeFilter.path This element is included in summaries. 0..1 string A code-valued attribute to filter on
Library.dataRequirement.codeFilter.searchParam This element is included in summaries. 0..1 string A coded (token) parameter to search on
Library.dataRequirement.codeFilter.valueSet This element is included in summaries. 0..1 canonical(ValueSet) Valueset for the filter
Library.dataRequirement.codeFilter.code This element is included in summaries. 0..* Coding What code is expected
Library.dataRequirement.dateFilter This element is included in summaries. C 0..* Element What dates/date ranges are expected
Constraints: drq-2
Library.dataRequirement.dateFilter.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.dateFilter.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.dateFilter.path This element is included in summaries. 0..1 string A date-valued attribute to filter on
Library.dataRequirement.dateFilter.searchParam This element is included in summaries. 0..1 string A date valued parameter to search on
Library.dataRequirement.dateFilter.value[x] This element is included in summaries. 0..1 The value of the filter, as a Period, DateTime, or Duration value
Library.dataRequirement.dateFilter.value[x].valueDateTime dateTime
Library.dataRequirement.dateFilter.value[x].valuePeriod Period
Library.dataRequirement.dateFilter.value[x].valueDuration Duration
Library.dataRequirement.limit This element is included in summaries. 0..1 positiveInt Number of results
Library.dataRequirement.sort This element is included in summaries. 0..* Element Order of the results
Library.dataRequirement.sort.id 0..1 string Unique id for inter-element referencing
Library.dataRequirement.sort.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.dataRequirement.sort.path This element is included in summaries. 1..1 string The name of the attribute to perform the sort
Library.dataRequirement.sort.direction This element is included in summaries. 1..1 code ascending | descending
Binding: SortDirection (required): The possible sort directions, ascending or descending.
Library.content This element must be supported. This element is included in summaries. 1..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.dataRequirement.​type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
Library.dataRequirement.​subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.dataRequirement.​sort.direction Base required SortDirection 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
drq-1 error Library.dataRequirement.codeFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
drq-2 error Library.dataRequirement.dateFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error Library If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
lib-0 warning Library 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}')

This structure is derived from Library

Summary

Mandatory: 1 element
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron