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 Publishable Library

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

Supports declaration of the library metadata required by HL7 and other organizations that share and publish libraries with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

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 1..1 Library Represents a library of quality improvement components
Constraints: lib-0, pub-1
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.meta.Slices for extension Content/Rules for all slices
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for 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.type This element must be supported. 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.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Library.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Library.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.Slices for extension Content/Rules for all slices
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being 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.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact.​type Base required RelatedArtifactType 📍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()
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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 Library Represents a library of quality improvement components
Constraints: pub-1
Library.meta
Library.meta.Slices for extension Content/Rules for all slices
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Library.identifier This element must be supported. 0..* Identifier Additional identifier for the library
Library.date This element must be supported. 1..1 dateTime Date last changed
Library.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
Library.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Library.purpose This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Library.author This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.Slices for extension Content/Rules for all slices
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Library.relatedArtifact.display This element must be supported. 0..1 string Brief description of the related artifact
Library.relatedArtifact.document This element must be supported. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 Library Represents a library of quality improvement components
Constraints: lib-0, pub-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.meta.id 0..1 string Unique id for inter-element referencing
Library.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Library.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Library.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Library.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Library.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Library.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
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 must be supported. 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 must be supported. 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 must be supported. This element is included in summaries. 1..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 must be supported. 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 must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.id 0..1 string Unique id for inter-element referencing
Library.relatedArtifact.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.label This element is included in summaries. 0..1 string Short label
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.relatedArtifact.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library
Library.content This element is included in summaries. 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Library.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
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.relatedArtifact.​type Base required RelatedArtifactType 📍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()
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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 Library Represents a library of quality improvement components
Constraints: lib-0, pub-1
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.meta.Slices for extension Content/Rules for all slices
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for 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.type This element must be supported. 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.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Library.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Library.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.Slices for extension Content/Rules for all slices
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being 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.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact.​type Base required RelatedArtifactType 📍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()
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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 Library Represents a library of quality improvement components
Constraints: pub-1
Library.meta
Library.meta.Slices for extension Content/Rules for all slices
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Library.identifier This element must be supported. 0..* Identifier Additional identifier for the library
Library.type This element must be supported. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Library.date This element must be supported. 1..1 dateTime Date last changed
Library.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
Library.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Library.purpose This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Library.author This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.Slices for extension Content/Rules for all slices
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Library.relatedArtifact.display This element must be supported. 0..1 string Brief description of the related artifact
Library.relatedArtifact.document This element must be supported. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format

Constraints

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

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 Library Represents a library of quality improvement components
Constraints: lib-0, pub-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.meta.id 0..1 string Unique id for inter-element referencing
Library.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Library.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Library.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Library.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Library.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Library.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
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 must be supported. 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 must be supported. 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 must be supported. This element is included in summaries. 1..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 must be supported. 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 must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.id 0..1 string Unique id for inter-element referencing
Library.relatedArtifact.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.label This element is included in summaries. 0..1 string Short label
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.relatedArtifact.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library
Library.content This element is included in summaries. 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Library.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
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.relatedArtifact.​type Base required RelatedArtifactType 📍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()
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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

 

Other representations of profile: CSV, Excel, Schematron