Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary | Version: 2.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).
Knowledge artifacts must be able to specify versioning information for all the dependencies used in a particular release to enable stable expansion of value sets and consistent resolution of dependencies. For example, the versions of code systems used in value sets referenced by the artifacts must be identified so that terminology servers performing expansions can unambiguously select the version of each code system used to perform the expansion.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Library |
C | 0..* | Library | Represents a library of quality improvement components Constraints: lib-0 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:directReferenceCode |
S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
| extension:logicDefinition |
S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
| extension:cqlOptions |
S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions |
 extension:expansionParameters |
S | 0..1 | (Complex) | What pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters |
  url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters" | |
  value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:inputParameters |
S | 0..1 | (Complex) | What author-pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters" | |
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:endpoints |
S | 0..1 | (Complex) | Where to access artifacts URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration |
| url |
1..1 | uri | "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration" | |
| value[x] |
1..1 | Reference(CRMI Endpoint Configuration Parameters) | Value of extension | |
 extension:messages |
S | 0..1 | Reference(Parameters) | What messages from packaging URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
 type |
SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
 Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
 relatedArtifact:component |
S | 0..* | RelatedArtifact | What components are in the manifest |
 Slices for extension |
Content/Rules for all slices | |||
 extension:isOwned |
S | 0..1 | boolean | Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned |
| type |
SΣ | 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 |
| display |
SΣ | 0..1 | string | Brief description of the related artifact |
 resource |
SΣ | 1..1 | canonical(Resource) | A reference to the component artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
 relatedArtifact:dependency |
S | 0..* | RelatedArtifact | What dependencies are referenced |
| type |
SΣ | 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 |
| display |
SΣ | 0..1 | string | Brief description of the related artifact |
| resource |
SΣ | 1..1 | canonical(Resource) | A reference to the dependency artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
| extension:referenceSource |
0..* | (Complex) | Originated in URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| Library.type | extensible | Pattern Value: asset-collectionhttp://hl7.org/fhir/ValueSet/library-typeFrom the FHIR Standard | |
| Library.relatedArtifact:component.type | required | Fixed Value: composed-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | |
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-onhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
0..* | Library | Represents a library of quality improvement components | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:directReferenceCode |
S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
| extension:logicDefinition |
S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
| extension:cqlOptions |
S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions |
| extension:expansionParameters |
S | 0..1 | (Complex) | What pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters |
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:inputParameters |
S | 0..1 | (Complex) | What author-pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:endpoints |
S | 0..1 | (Complex) | Where to access artifacts URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration |
| value[x] |
1..1 | Reference(CRMI Endpoint Configuration Parameters) | Value of extension | |
| extension:messages |
S | 0..1 | Reference(Parameters) | What messages from packaging URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
| type |
S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:component |
S | 0..* | RelatedArtifact | What components are in the manifest |
| Slices for extension |
Content/Rules for all slices | |||
| extension:isOwned |
S | 0..1 | boolean | Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of |
 display |
S | 0..1 | string | Brief description of the related artifact |
| resource |
S | 1..1 | canonical(Resource) | A reference to the component artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
| relatedArtifact:dependency |
S | 0..* | RelatedArtifact | What dependencies are referenced |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
| display |
S | 0..1 | string | Brief description of the related artifact |
| resource |
S | 1..1 | canonical(Resource) | A reference to the dependency artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
| extension:referenceSource |
0..* | (Complex) | Originated in URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource | |
| content |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Library |
C | 0..* | Library | Represents a library of quality improvement components Constraints: lib-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:directReferenceCode |
S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode | ||||
| extension:logicDefinition |
S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition | ||||
| extension:cqlOptions |
S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions | ||||
| extension:expansionParameters |
S | 0..1 | (Complex) | What pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters" | |||||
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |||||
| extension:inputParameters |
S | 0..1 | (Complex) | What author-pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters" | |||||
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |||||
| extension:endpoints |
S | 0..1 | (Complex) | Where to access artifacts URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration" | |||||
| value[x] |
1..1 | Reference(CRMI Endpoint Configuration Parameters) | Value of extension | |||||
| extension:messages |
S | 0..1 | Reference(Parameters) | What messages from packaging URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
Σ | 0..1 | string | Business version of the library | ||||
| name |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the library | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| type |
SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
 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.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the library | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this library is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the library | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the library was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the library was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the library is expected to be used | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type | ||||
| relatedArtifact:component |
S | 0..* | RelatedArtifact | What components are in the manifest | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:isOwned |
S | 0..1 | boolean | Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned | ||||
| type |
SΣ | 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 | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 1..1 | canonical(Resource) | A reference to the component artifact | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| relatedArtifact:dependency |
S | 0..* | RelatedArtifact | What dependencies are referenced | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 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 | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 1..1 | canonical(Resource) | A reference to the dependency artifact | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |||||
| extension:referenceSource |
0..* | (Complex) | Originated in URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| parameter |
0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement |
0..* | DataRequirement | What data is referenced by this library | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Library.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| Library.type | extensible | Pattern Value: asset-collectionhttp://hl7.org/fhir/ValueSet/library-typeFrom the FHIR Standard | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typeFrom the FHIR Standard | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionFrom the FHIR Standard | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicFrom the FHIR Standard | ||||
| Library.relatedArtifact:component.type | required | Fixed Value: composed-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | ||||
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-onhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 18 elements
Fixed: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
C | 0..* | Library | Represents a library of quality improvement components Constraints: lib-0 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:directReferenceCode |
S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
| extension:logicDefinition |
S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
| extension:cqlOptions |
S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions |
| extension:expansionParameters |
S | 0..1 | (Complex) | What pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters |
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters" | |
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:inputParameters |
S | 0..1 | (Complex) | What author-pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters" | |
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:endpoints |
S | 0..1 | (Complex) | Where to access artifacts URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration |
| url |
1..1 | uri | "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration" | |
| value[x] |
1..1 | Reference(CRMI Endpoint Configuration Parameters) | Value of extension | |
| extension:messages |
S | 0..1 | Reference(Parameters) | What messages from packaging URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| type |
SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:component |
S | 0..* | RelatedArtifact | What components are in the manifest |
| Slices for extension |
Content/Rules for all slices | |||
| extension:isOwned |
S | 0..1 | boolean | Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned |
| type |
SΣ | 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 |
| display |
SΣ | 0..1 | string | Brief description of the related artifact |
| resource |
SΣ | 1..1 | canonical(Resource) | A reference to the component artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
| relatedArtifact:dependency |
S | 0..* | RelatedArtifact | What dependencies are referenced |
| type |
SΣ | 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 |
| display |
SΣ | 0..1 | string | Brief description of the related artifact |
| resource |
SΣ | 1..1 | canonical(Resource) | A reference to the dependency artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
| extension:referenceSource |
0..* | (Complex) | Originated in URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| Library.type | extensible | Pattern Value: asset-collectionhttp://hl7.org/fhir/ValueSet/library-typeFrom the FHIR Standard | |
| Library.relatedArtifact:component.type | required | Fixed Value: composed-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | |
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-onhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
0..* | Library | Represents a library of quality improvement components | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:directReferenceCode |
S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode |
| extension:logicDefinition |
S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition |
| extension:cqlOptions |
S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions |
| extension:expansionParameters |
S | 0..1 | (Complex) | What pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters |
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:inputParameters |
S | 0..1 | (Complex) | What author-pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |
| extension:endpoints |
S | 0..1 | (Complex) | Where to access artifacts URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration |
| value[x] |
1..1 | Reference(CRMI Endpoint Configuration Parameters) | Value of extension | |
| extension:messages |
S | 0..1 | Reference(Parameters) | What messages from packaging URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters |
| type |
S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
| relatedArtifact:component |
S | 0..* | RelatedArtifact | What components are in the manifest |
| Slices for extension |
Content/Rules for all slices | |||
| extension:isOwned |
S | 0..1 | boolean | Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of |
| display |
S | 0..1 | string | Brief description of the related artifact |
| resource |
S | 1..1 | canonical(Resource) | A reference to the component artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
| relatedArtifact:dependency |
S | 0..* | RelatedArtifact | What dependencies are referenced |
| type |
S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
| display |
S | 0..1 | string | Brief description of the related artifact |
| resource |
S | 1..1 | canonical(Resource) | A reference to the dependency artifact |
| Slices for extension |
Content/Rules for all slices | |||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |
| extension:referenceSource |
0..* | (Complex) | Originated in URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource | |
| content |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Library |
C | 0..* | Library | Represents a library of quality improvement components Constraints: lib-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:directReferenceCode |
S | 0..* | Coding | A code directly referenced by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode | ||||
| extension:logicDefinition |
S | 0..* | (Complex) | A logic definition used in the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition | ||||
| extension:cqlOptions |
S | 0..1 | Reference(Parameters) | What options URL: http://hl7.org/fhir/StructureDefinition/cqf-cqlOptions | ||||
| extension:expansionParameters |
S | 0..1 | (Complex) | What pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-expansionParameters" | |||||
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |||||
| extension:inputParameters |
S | 0..1 | (Complex) | What author-pinned dependency versions URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters" | |||||
| value[x] |
1..1 | Reference(CRMI Manifest Parameters) | Value of extension | |||||
| extension:endpoints |
S | 0..1 | (Complex) | Where to access artifacts URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-endpointConfiguration" | |||||
| value[x] |
1..1 | Reference(CRMI Endpoint Configuration Parameters) | Value of extension | |||||
| extension:messages |
S | 0..1 | Reference(Parameters) | What messages from packaging URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
Σ | 0..1 | string | Business version of the library | ||||
| name |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the library | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| type |
SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the library | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this library is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the library | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the library was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the library was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the library is expected to be used | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| Slices for relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type | ||||
| relatedArtifact:component |
S | 0..* | RelatedArtifact | What components are in the manifest | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:isOwned |
S | 0..1 | boolean | Whether or not the referenced artifact is owned by the referencing artifact. URL: http://hl7.org/fhir/StructureDefinition/artifact-isOwned | ||||
| type |
SΣ | 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 | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 1..1 | canonical(Resource) | A reference to the component artifact | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| relatedArtifact:dependency |
S | 0..* | RelatedArtifact | What dependencies are referenced | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 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 | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
SΣ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
SΣ | 1..1 | canonical(Resource) | A reference to the dependency artifact | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:uriReference |
0..1 | uri | Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
| extension:resourceType |
0..1 | code | What type of artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required) | |||||
| extension:referenceSource |
0..* | (Complex) | Originated in URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-referenceSource | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| parameter |
0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement |
0..* | DataRequirement | What data is referenced by this library | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Library.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| Library.type | extensible | Pattern Value: asset-collectionhttp://hl7.org/fhir/ValueSet/library-typeFrom the FHIR Standard | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typeFrom the FHIR Standard | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionFrom the FHIR Standard | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicFrom the FHIR Standard | ||||
| Library.relatedArtifact:component.type | required | Fixed Value: composed-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard | ||||
| Library.relatedArtifact:dependency.type | required | Fixed Value: depends-onhttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 18 elements
Fixed: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-08-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change