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

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

A Manifest Library provides dependency version management for a collection of artifacts. The manifest is an asset-collection library whose components identify the artifacts in the collection, while the dependency relationships are used to manage version dependencies of those components.

The manifest is also used to specify expansion parameters, providing details for how value set expansion should be performed for any value sets in the collection or referenced by artifacts in the collection.

In addition, the manifest can be used to specify CQL translator options for any CQL libraries in the collection (or referenced by artifacts in the collection).

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
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:directReferenceCode This element must be supported. 0..* (Complex) A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
Library.Slices for extension.extension:directReferenceCode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:directReferenceCode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"
Library.Slices for extension.extension:directReferenceCode.value[x] 1..1 Coding Value of extension
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension.extension:referenceSource This element must be supported. 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
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:cqlOptions This element must be supported. 0..1 Reference(Parameters) What options
URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
Library.Slices for extension.extension:expansionParameters This element must be supported. 0..1 (Complex) What versions SHOULD be used
URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
Library.Slices for extension.extension:expansionParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters"
Library.Slices for extension.extension:expansionParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:inputParameters This element must be supported. 0..1 (Complex) What author-pinned dependency versions
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
Library.Slices for extension.extension:inputParameters.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:inputParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
Library.Slices for extension.extension:inputParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:endpoints This element must be supported. 0..1 (Complex) Where to access artifacts
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration
Library.Slices for extension.extension:endpoints.url 1..1 uri "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration"
Library.Slices for extension.extension:endpoints.value[x] 1..1 Reference(CRMI Endpoint Configuration Parameters) Value of extension
Library.Slices for extension.extension:messages This element must be supported. 0..1 Reference(OperationOutcome) What messages from packaging
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
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 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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/library-type",
      "code" : "asset-collection"
    }
  ]
}
Library.Slices for relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:component This element must be supported. 0..* RelatedArtifact What components are in the manifest
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:isOwned This element must be supported. 0..1 boolean Whether or not the referenced artifact is owned by the referencing artifact.
URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:component.type This element must be supported. 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.
Fixed Value: composed-of (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:component.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the component artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency This element must be supported. 0..* RelatedArtifact What dependencies are referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:referenceSource 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:dependencyRole 0..* code What role
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-dependencyRole
Binding: Dependency Role (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:packageSource 0..* (Complex) What package
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.Slices for relatedArtifact.relatedArtifact:dependency.type This element must be supported. 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.
Fixed Value: depends-on (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:dependency.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the dependency artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)

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.relatedArtifact:component.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:dependency.​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}')

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library 0..* Library Represents a library of quality improvement components
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode This element must be supported. 0..* (Complex) A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
Library.Slices for extension.extension:directReferenceCode.value[x]
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension.extension:referenceSource This element must be supported. 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
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:cqlOptions This element must be supported. 0..1 Reference(Parameters) What options
URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
Library.Slices for extension.extension:expansionParameters This element must be supported. 0..1 (Complex) What versions SHOULD be used
URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
Library.Slices for extension.extension:expansionParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:inputParameters This element must be supported. 0..1 (Complex) What author-pinned dependency versions
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
Library.Slices for extension.extension:inputParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:endpoints This element must be supported. 0..1 (Complex) Where to access artifacts
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration
Library.Slices for extension.extension:endpoints.value[x] 1..1 Reference(CRMI Endpoint Configuration Parameters) Value of extension
Library.Slices for extension.extension:messages This element must be supported. 0..1 Reference(OperationOutcome) What messages from packaging
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
Library.type This element must be supported. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/library-type",
      "code" : "asset-collection"
    }
  ]
}
Library.Slices for relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:component This element must be supported. 0..* RelatedArtifact What components are in the manifest
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:isOwned This element must be supported. 0..1 boolean Whether or not the referenced artifact is owned by the referencing artifact.
URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:intendedUsageContext This element must be supported. 0..* UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:component.type This element must be supported. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: composed-of (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:component.display This element must be supported. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource This element must be supported. 1..1 canonical(Resource) A reference to the component artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x]
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency This element must be supported. 0..* RelatedArtifact What dependencies are referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:intendedUsageContext This element must be supported. 0..* UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:referenceSource 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:dependencyRole 0..* code What role
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-dependencyRole
Binding: Dependency Role (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:packageSource 0..* (Complex) What package
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.Slices for relatedArtifact.relatedArtifact:dependency.type This element must be supported. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: depends-on (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:dependency.display This element must be supported. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource This element must be supported. 1..1 canonical(Resource) A reference to the dependency artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x]
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
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:directReferenceCode This element must be supported. 0..* (Complex) A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
Library.Slices for extension.extension:directReferenceCode.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:directReferenceCode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:directReferenceCode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"
Library.Slices for extension.extension:directReferenceCode.value[x] 1..1 Coding Value of extension
Library.Slices for extension.extension:directReferenceCode.value[x].id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension.extension:referenceSource This element must be supported. 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for extension.extension:directReferenceCode.value[x].system This element is included in summaries. 0..1 uri Identity of the terminology system
Library.Slices for extension.extension:directReferenceCode.value[x].version This element is included in summaries. 0..1 string Version of the system - if relevant
Library.Slices for extension.extension:directReferenceCode.value[x].code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Library.Slices for extension.extension:directReferenceCode.value[x].display This element is included in summaries. 0..1 string Representation defined by the system
Library.Slices for extension.extension:directReferenceCode.value[x].userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
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:cqlOptions This element must be supported. 0..1 Reference(Parameters) What options
URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
Library.Slices for extension.extension:expansionParameters This element must be supported. 0..1 (Complex) What versions SHOULD be used
URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
Library.Slices for extension.extension:expansionParameters.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:expansionParameters.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:expansionParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters"
Library.Slices for extension.extension:expansionParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:inputParameters This element must be supported. 0..1 (Complex) What author-pinned dependency versions
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
Library.Slices for extension.extension:inputParameters.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:inputParameters.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:inputParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
Library.Slices for extension.extension:inputParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:endpoints This element must be supported. 0..1 (Complex) Where to access artifacts
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration
Library.Slices for extension.extension:endpoints.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:endpoints.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:endpoints.url 1..1 uri "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration"
Library.Slices for extension.extension:endpoints.value[x] 1..1 Reference(CRMI Endpoint Configuration Parameters) Value of extension
Library.Slices for extension.extension:messages This element must be supported. 0..1 Reference(OperationOutcome) What messages from packaging
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
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 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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/library-type",
      "code" : "asset-collection"
    }
  ]
}
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.Slices for relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:component This element must be supported. 0..* RelatedArtifact What components are in the manifest
Library.Slices for relatedArtifact.relatedArtifact:component.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:isOwned This element must be supported. 0..1 boolean Whether or not the referenced artifact is owned by the referencing artifact.
URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:component.type This element must be supported. 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.
Fixed Value: composed-of (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:component.label This element is included in summaries. 0..1 string Short label
Library.Slices for relatedArtifact.relatedArtifact:component.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:component.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.Slices for relatedArtifact.relatedArtifact:component.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.Slices for relatedArtifact.relatedArtifact:component.document This element is included in summaries. 0..1 Attachment What document is being referenced
Library.Slices for relatedArtifact.relatedArtifact:component.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the component artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource.id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].value 0..1 uri Primitive value for uri
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.value 0..1 string Primitive value for canonical
Library.Slices for relatedArtifact.relatedArtifact:dependency This element must be supported. 0..* RelatedArtifact What dependencies are referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:referenceSource 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:dependencyRole 0..* code What role
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-dependencyRole
Binding: Dependency Role (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:packageSource 0..* (Complex) What package
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.Slices for relatedArtifact.relatedArtifact:dependency.type This element must be supported. 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.
Fixed Value: depends-on (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:dependency.label This element is included in summaries. 0..1 string Short label
Library.Slices for relatedArtifact.relatedArtifact:dependency.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.Slices for relatedArtifact.relatedArtifact:dependency.document This element is included in summaries. 0..1 Attachment What document is being referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the dependency artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].value 0..1 uri Primitive value for uri
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.value 0..1 string Primitive value for canonical
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library

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.relatedArtifact:component.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:dependency.​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}')

This structure is derived from Library

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
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:directReferenceCode This element must be supported. 0..* (Complex) A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
Library.Slices for extension.extension:directReferenceCode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:directReferenceCode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"
Library.Slices for extension.extension:directReferenceCode.value[x] 1..1 Coding Value of extension
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension.extension:referenceSource This element must be supported. 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
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:cqlOptions This element must be supported. 0..1 Reference(Parameters) What options
URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
Library.Slices for extension.extension:expansionParameters This element must be supported. 0..1 (Complex) What versions SHOULD be used
URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
Library.Slices for extension.extension:expansionParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters"
Library.Slices for extension.extension:expansionParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:inputParameters This element must be supported. 0..1 (Complex) What author-pinned dependency versions
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
Library.Slices for extension.extension:inputParameters.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:inputParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
Library.Slices for extension.extension:inputParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:endpoints This element must be supported. 0..1 (Complex) Where to access artifacts
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration
Library.Slices for extension.extension:endpoints.url 1..1 uri "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration"
Library.Slices for extension.extension:endpoints.value[x] 1..1 Reference(CRMI Endpoint Configuration Parameters) Value of extension
Library.Slices for extension.extension:messages This element must be supported. 0..1 Reference(OperationOutcome) What messages from packaging
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
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 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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/library-type",
      "code" : "asset-collection"
    }
  ]
}
Library.Slices for relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:component This element must be supported. 0..* RelatedArtifact What components are in the manifest
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:isOwned This element must be supported. 0..1 boolean Whether or not the referenced artifact is owned by the referencing artifact.
URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:component.type This element must be supported. 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.
Fixed Value: composed-of (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:component.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the component artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency This element must be supported. 0..* RelatedArtifact What dependencies are referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:referenceSource 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:dependencyRole 0..* code What role
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-dependencyRole
Binding: Dependency Role (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:packageSource 0..* (Complex) What package
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.Slices for relatedArtifact.relatedArtifact:dependency.type This element must be supported. 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.
Fixed Value: depends-on (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:dependency.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the dependency artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)

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.relatedArtifact:component.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:dependency.​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}')

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library 0..* Library Represents a library of quality improvement components
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode This element must be supported. 0..* (Complex) A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
Library.Slices for extension.extension:directReferenceCode.value[x]
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension.extension:referenceSource This element must be supported. 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
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:cqlOptions This element must be supported. 0..1 Reference(Parameters) What options
URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
Library.Slices for extension.extension:expansionParameters This element must be supported. 0..1 (Complex) What versions SHOULD be used
URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
Library.Slices for extension.extension:expansionParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:inputParameters This element must be supported. 0..1 (Complex) What author-pinned dependency versions
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
Library.Slices for extension.extension:inputParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:endpoints This element must be supported. 0..1 (Complex) Where to access artifacts
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration
Library.Slices for extension.extension:endpoints.value[x] 1..1 Reference(CRMI Endpoint Configuration Parameters) Value of extension
Library.Slices for extension.extension:messages This element must be supported. 0..1 Reference(OperationOutcome) What messages from packaging
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
Library.type This element must be supported. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/library-type",
      "code" : "asset-collection"
    }
  ]
}
Library.Slices for relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:component This element must be supported. 0..* RelatedArtifact What components are in the manifest
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:isOwned This element must be supported. 0..1 boolean Whether or not the referenced artifact is owned by the referencing artifact.
URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:intendedUsageContext This element must be supported. 0..* UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:component.type This element must be supported. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: composed-of (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:component.display This element must be supported. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource This element must be supported. 1..1 canonical(Resource) A reference to the component artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x]
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency This element must be supported. 0..* RelatedArtifact What dependencies are referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:intendedUsageContext This element must be supported. 0..* UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:referenceSource 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:dependencyRole 0..* code What role
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-dependencyRole
Binding: Dependency Role (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:packageSource 0..* (Complex) What package
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.Slices for relatedArtifact.relatedArtifact:dependency.type This element must be supported. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: depends-on (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:dependency.display This element must be supported. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource This element must be supported. 1..1 canonical(Resource) A reference to the dependency artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x]
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.content 0..0 Contents of the library, either embedded or referenced

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
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:directReferenceCode This element must be supported. 0..* (Complex) A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
Library.Slices for extension.extension:directReferenceCode.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:directReferenceCode.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:directReferenceCode.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"
Library.Slices for extension.extension:directReferenceCode.value[x] 1..1 Coding Value of extension
Library.Slices for extension.extension:directReferenceCode.value[x].id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:directReferenceCode.value[x].Slices for extension.extension:referenceSource This element must be supported. 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for extension.extension:directReferenceCode.value[x].system This element is included in summaries. 0..1 uri Identity of the terminology system
Library.Slices for extension.extension:directReferenceCode.value[x].version This element is included in summaries. 0..1 string Version of the system - if relevant
Library.Slices for extension.extension:directReferenceCode.value[x].code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Library.Slices for extension.extension:directReferenceCode.value[x].display This element is included in summaries. 0..1 string Representation defined by the system
Library.Slices for extension.extension:directReferenceCode.value[x].userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
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:cqlOptions This element must be supported. 0..1 Reference(Parameters) What options
URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions
Library.Slices for extension.extension:expansionParameters This element must be supported. 0..1 (Complex) What versions SHOULD be used
URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters
Library.Slices for extension.extension:expansionParameters.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:expansionParameters.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:expansionParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters"
Library.Slices for extension.extension:expansionParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:inputParameters This element must be supported. 0..1 (Complex) What author-pinned dependency versions
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
Library.Slices for extension.extension:inputParameters.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:inputParameters.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:inputParameters.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
Library.Slices for extension.extension:inputParameters.value[x] 1..1 Reference(CRMI Manifest Parameters) Value of extension
Library.Slices for extension.extension:endpoints This element must be supported. 0..1 (Complex) Where to access artifacts
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration
Library.Slices for extension.extension:endpoints.id 0..1 string Unique id for inter-element referencing
Library.Slices for extension.extension:endpoints.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:endpoints.url 1..1 uri "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration"
Library.Slices for extension.extension:endpoints.value[x] 1..1 Reference(CRMI Endpoint Configuration Parameters) Value of extension
Library.Slices for extension.extension:messages This element must be supported. 0..1 Reference(OperationOutcome) What messages from packaging
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
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 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.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/library-type",
      "code" : "asset-collection"
    }
  ]
}
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.Slices for relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:component This element must be supported. 0..* RelatedArtifact What components are in the manifest
Library.Slices for relatedArtifact.relatedArtifact:component.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:isOwned This element must be supported. 0..1 boolean Whether or not the referenced artifact is owned by the referencing artifact.
URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned
Library.Slices for relatedArtifact.relatedArtifact:component.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:component.type This element must be supported. 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.
Fixed Value: composed-of (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:component.label This element is included in summaries. 0..1 string Short label
Library.Slices for relatedArtifact.relatedArtifact:component.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:component.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.Slices for relatedArtifact.relatedArtifact:component.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.Slices for relatedArtifact.relatedArtifact:component.document This element is included in summaries. 0..1 Attachment What document is being referenced
Library.Slices for relatedArtifact.relatedArtifact:component.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the component artifact
Library.Slices for relatedArtifact.relatedArtifact:component.resource.id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:uriReference.value[x].value 0..1 uri Primitive value for uri
Library.Slices for relatedArtifact.relatedArtifact:component.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:component.resource.value 0..1 string Primitive value for canonical
Library.Slices for relatedArtifact.relatedArtifact:dependency This element must be supported. 0..* RelatedArtifact What dependencies are referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:intendedUsageContext This element must be supported. 0..1 UsageContext Intended Usage Context
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-intendedUsageContext
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:referenceSource 0..* (Complex) Originated in
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:dependencyRole 0..* code What role
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-dependencyRole
Binding: Dependency Role (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.Slices for extension.extension:packageSource 0..* (Complex) What package
URL: http://hl7.org/fhir/StructureDefinition/package-source
Library.Slices for relatedArtifact.relatedArtifact:dependency.type This element must be supported. 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.
Fixed Value: depends-on (no extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:dependency.label This element is included in summaries. 0..1 string Short label
Library.Slices for relatedArtifact.relatedArtifact:dependency.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.Slices for relatedArtifact.relatedArtifact:dependency.document This element is included in summaries. 0..1 Attachment What document is being referenced
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource This element must be supported. This element is included in summaries. 1..1 canonical(Resource) A reference to the dependency artifact
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference 0..1 (Complex) Uri for non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.id 0..1 string Unique id for inter-element referencing
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-uriReference"
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x] 1..1 uri Value of extension
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].id 0..1 string xml:id (or equivalent in JSON)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].Slices for extension.extension:uriResourceType 0..1 code What type of non-canonical artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:uriReference.value[x].value 0..1 uri Primitive value for uri
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.Slices for extension.extension:resourceType 0..1 code What type of artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType
Binding: AllResourceTypes (required)
Library.Slices for relatedArtifact.relatedArtifact:dependency.resource.value 0..1 string Primitive value for canonical
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library

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.relatedArtifact:component.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:dependency.​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}')

This structure is derived from Library

 

Other representations of profile: CSV, Excel, Schematron