Content Management Infrastructure Implementation Guide, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/Content-Management-Infrastructure-IG/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publishablelibrary | Version: 0.1.0 | |||
Active as of 2021-11-27 | Computable Name: CMIPublishableLibrary |
The CMI Publishable Library profile defines the must support elements in a library used to support eCQM logic
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CMILibrary
Summary
Mandatory: 6 elements
Must-Support: 24 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from CMILibrary
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | CMILibrary | Represents a library of quality improvement components | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
title | S | 1..1 | string | Name for this library (human friendly) |
date | S | 1..1 | dateTime | Date last changed |
Slices for useContext | S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | S | 1..1 | UsageContext | The context that the content is intended to support |
code | S | 1..1 | Coding | Type of context being specified Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
value[x] | S | 1..1 | CodeableConcept | Value that defines the context Binding: http://hl7.org/fhir/uv/cmi/ValueSet/quality-programs (extensible): The quality programs |
purpose | S | 0..1 | markdown | Why this library is defined |
usage | S | 0..1 | string | Describes the clinical usage of the library |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. |
author | S | 0..* | ContactDetail | Who authored the content |
editor | S | 0..* | ContactDetail | Who edited the content |
reviewer | S | 0..* | ContactDetail | Who reviewed the content |
endorser | S | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | S | 0..* | RelatedArtifact | Any referenced CQL libraries or additional documentation, citations, etc. |
cmi-publicationStatus | S | 0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact |
cmi-publicationDate | S | 0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationDate |
display | S | 0..1 | string | Brief description of the related artifact |
url | S | 0..1 | url | Where the artifact can be accessed |
resource | S | 0..1 | canonical(Resource) | What resource is being referenced |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Library | I | 1..1 | CMILibrary | Represents a library of quality improvement components | ||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | S | 1..1 | Narrative | Text summary of the resource, for human interpretation | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extension:comment | S | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
identifier | SΣ | 0..* | Identifier | Additional identifier for the library | ||||
version | Σ | 1..1 | string | Business version of the library | ||||
name | ΣI | 1..1 | string | Name for this library (computer friendly) | ||||
title | SΣ | 1..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 | Σ | 1..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. | ||||
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 | SΣ | 1..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 1..1 | markdown | Natural language description of the library | ||||
Slices for useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
useContext:qualityProgram | SΣ | 1..1 | UsageContext | The context that the content is intended to support | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
code | SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
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/usage-context-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
value[x] | SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: http://hl7.org/fhir/uv/cmi/ValueSet/quality-programs (extensible): The quality programs | ||||
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | S | 0..1 | markdown | Why this library is defined | ||||
usage | S | 0..1 | string | Describes the clinical usage of the library | ||||
copyright | S | 0..1 | markdown | Use and/or publishing restrictions | ||||
approvalDate | S | 0..1 | date | When the library was approved by publisher | ||||
lastReviewDate | S | 0..1 | date | When the library was last reviewed | ||||
effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used | ||||
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | ||||
author | S | 0..* | ContactDetail | Who authored the content | ||||
editor | S | 0..* | ContactDetail | Who edited the content | ||||
reviewer | S | 0..* | ContactDetail | Who reviewed the content | ||||
endorser | S | 0..* | ContactDetail | Who endorsed the content | ||||
relatedArtifact | S | 0..* | RelatedArtifact | Any referenced CQL libraries or additional documentation, citations, etc. | ||||
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 | |||||
cmi-publicationStatus | S | 0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | ||||
cmi-publicationDate | S | 0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationDate | ||||
type | Σ | 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. | ||||
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 | SΣ | 0..1 | url | Where the artifact can be accessed | ||||
document | Σ | 0..1 | Attachment | What document is being referenced | ||||
resource | SΣ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |||||
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | CMILibrary | Represents a library of quality improvement components |
meta | Σ | 1..1 | Meta | Metadata about the resource |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
extension:comment | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment | |
identifier | Σ | 0..* | Identifier | Additional identifier for the library |
title | Σ | 1..1 | string | Name for this library (human friendly) |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
date | Σ | 1..1 | dateTime | Date last changed |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
Slices for useContext | Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | Σ | 1..1 | UsageContext | The context that the content is intended to support |
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: http://hl7.org/fhir/uv/cmi/ValueSet/quality-programs (extensible): The quality programs |
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 | |
relatedArtifact | 0..* | RelatedArtifact | Any referenced CQL libraries or additional documentation, citations, etc. | |
cmi-publicationStatus | 0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |
cmi-publicationDate | 0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationDate | |
display | Σ | 0..1 | string | Brief description of the related artifact |
url | Σ | 0..1 | url | Where the artifact can be accessed |
resource | Σ | 0..1 | canonical(Resource) | What resource is being referenced |
Documentation for this format |
This structure is derived from CMILibrary
Summary
Mandatory: 6 elements
Must-Support: 24 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CMILibrary
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | CMILibrary | Represents a library of quality improvement components | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
title | S | 1..1 | string | Name for this library (human friendly) |
date | S | 1..1 | dateTime | Date last changed |
Slices for useContext | S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | S | 1..1 | UsageContext | The context that the content is intended to support |
code | S | 1..1 | Coding | Type of context being specified Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
value[x] | S | 1..1 | CodeableConcept | Value that defines the context Binding: http://hl7.org/fhir/uv/cmi/ValueSet/quality-programs (extensible): The quality programs |
purpose | S | 0..1 | markdown | Why this library is defined |
usage | S | 0..1 | string | Describes the clinical usage of the library |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. |
author | S | 0..* | ContactDetail | Who authored the content |
editor | S | 0..* | ContactDetail | Who edited the content |
reviewer | S | 0..* | ContactDetail | Who reviewed the content |
endorser | S | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | S | 0..* | RelatedArtifact | Any referenced CQL libraries or additional documentation, citations, etc. |
cmi-publicationStatus | S | 0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact |
cmi-publicationDate | S | 0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationDate |
display | S | 0..1 | string | Brief description of the related artifact |
url | S | 0..1 | url | Where the artifact can be accessed |
resource | S | 0..1 | canonical(Resource) | What resource is being referenced |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Library | I | 1..1 | CMILibrary | Represents a library of quality improvement components | ||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | S | 1..1 | Narrative | Text summary of the resource, for human interpretation | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extension:comment | S | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment]] | Extension URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-artifactComment | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
identifier | SΣ | 0..* | Identifier | Additional identifier for the library | ||||
version | Σ | 1..1 | string | Business version of the library | ||||
name | ΣI | 1..1 | string | Name for this library (computer friendly) | ||||
title | SΣ | 1..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 | Σ | 1..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. | ||||
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 | SΣ | 1..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 1..1 | markdown | Natural language description of the library | ||||
Slices for useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
useContext:qualityProgram | SΣ | 1..1 | UsageContext | The context that the content is intended to support | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
code | SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
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/usage-context-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
value[x] | SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: http://hl7.org/fhir/uv/cmi/ValueSet/quality-programs (extensible): The quality programs | ||||
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | S | 0..1 | markdown | Why this library is defined | ||||
usage | S | 0..1 | string | Describes the clinical usage of the library | ||||
copyright | S | 0..1 | markdown | Use and/or publishing restrictions | ||||
approvalDate | S | 0..1 | date | When the library was approved by publisher | ||||
lastReviewDate | S | 0..1 | date | When the library was last reviewed | ||||
effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used | ||||
topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | ||||
author | S | 0..* | ContactDetail | Who authored the content | ||||
editor | S | 0..* | ContactDetail | Who edited the content | ||||
reviewer | S | 0..* | ContactDetail | Who reviewed the content | ||||
endorser | S | 0..* | ContactDetail | Who endorsed the content | ||||
relatedArtifact | S | 0..* | RelatedArtifact | Any referenced CQL libraries or additional documentation, citations, etc. | ||||
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 | |||||
cmi-publicationStatus | S | 0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | ||||
cmi-publicationDate | S | 0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/uv/cmi/StructureDefinition/cmi-publicationDate | ||||
type | Σ | 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. | ||||
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 | SΣ | 0..1 | url | Where the artifact can be accessed | ||||
document | Σ | 0..1 | Attachment | What document is being referenced | ||||
resource | SΣ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |||||
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Library.meta.security | extensible | All Security Labels |
Library.meta.tag | example | CommonTags |
Library.language | preferred | CommonLanguages Max Binding: AllLanguages |
Library.status | required | PublicationStatus |
Library.type | extensible | LibraryType |
Library.subject[x] | extensible | SubjectType |
Library.useContext:qualityProgram.code | extensible | Pattern: program |
Library.useContext:qualityProgram.value[x] | extensible | http://hl7.org/fhir/uv/cmi/ValueSet/quality-programs |
Library.jurisdiction | extensible | Jurisdiction ValueSet (missing link) |
Library.topic | example | DefinitionTopic (missing link) |
Library.relatedArtifact.type | required | RelatedArtifactType |
Id | Grade | Path | 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() | |
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}') | |
ele-1 | error | Library.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.extension:comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.extension:comment | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.subtitle | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.experimental | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.subject[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.publisher | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.useContext:qualityProgram | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.useContext:qualityProgram.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.useContext:qualityProgram.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.useContext:qualityProgram.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.useContext:qualityProgram.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.jurisdiction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.usage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.copyright | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.approvalDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.lastReviewDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.effectivePeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.editor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.reviewer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.endorser | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.relatedArtifact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.relatedArtifact.extension:publicationStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.relatedArtifact.extension:publicationStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.relatedArtifact.extension:publicationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Library.relatedArtifact.extension:publicationDate | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Library.relatedArtifact.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact.label | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact.citation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact.document | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.relatedArtifact.resource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.dataRequirement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Library.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |