HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Executable Library

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-executable-library Version: 2.1.2
Active as of 2021-10-23 Computable Name: USPublicHealthExecutableLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.51

This profile sets the minimum expectations for an executable CQL library. Specifically, the profile requires that the library contain one of ELM XML or JSON content, the compiled representation of the CQL logic.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Shareable Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1 Shareable Library US Public Health Executable Library
... Slices for relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency 0..* RelatedArtifact Additional documentation, citations, etc.
..... type S 1..1 code Required dependency
Fixed Value: depends-on
..... display S 0..1 string Brief description of the related artifact
..... resource S 1..1 canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet) What resource is being referenced
... parameter S 0..* ParameterDefinition Parameters defined by the library
... dataRequirement S 0..* DataRequirement What data is referenced by this library
.... content:elmXmlContent 0..* Attachment ELM XML Content
..... contentType S 0..1 code Mime type of the content, with charset etc.
Fixed Value: application/elm+xml
..... data 1..1 base64Binary Data inline, base64ed
.... content:elmJsonContent 0..* Attachment ELM JSON Content
..... contentType S 0..1 code Mime type of the content, with charset etc.
Fixed Value: application/elm+json
..... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 1..1 Shareable Library US Public Health Executable Library
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... version Σ 1..1 string Business version of the library
... name ΣC 1..1 string Name for this library (computer friendly)
... title SΣ 0..1 string Name for this library (human friendly)
... 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 Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... date SΣ 0..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
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... 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.


... Slices for relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency 0..* RelatedArtifact Additional documentation, citations, etc.
..... type SΣ 1..1 code Required dependency
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(Shareable CodeSystem | Shareable Library | Shareable ValueSet) What resource is being referenced
... parameter S 0..* ParameterDefinition Parameters defined by the library
... dataRequirement S 0..* DataRequirement What data is referenced by this library
... Slices for content SΣ 0..* Attachment Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:elmXmlContent Σ 0..* Attachment ELM XML Content
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+xml
..... data 1..1 base64Binary Data inline, base64ed
.... content:elmJsonContent Σ 0..* Attachment ELM JSON Content
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+json
..... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard
Library.content:elmXmlContent.contentTyperequiredFixed Value: application/elm+xml
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Library.content:elmJsonContent.contentTyperequiredFixed Value: application/elm+json
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 1..1 Shareable Library US Public Health Executable Library
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 ΣC 1..1 string Name for this library (computer friendly)
... title SΣ 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 Σ 1..1 boolean For testing purposes, not real usage
... type Σ 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Σ 0..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
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... 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 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:dependency 0..* RelatedArtifact Additional documentation, citations, etc.
..... 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 Required dependency
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(Shareable CodeSystem | Shareable Library | Shareable ValueSet) What resource is being referenced
... parameter S 0..* ParameterDefinition Parameters defined by the library
... dataRequirement S 0..* DataRequirement What data is referenced by this library
... Slices for content SΣ 0..* Attachment Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:elmXmlContent Σ 0..* Attachment ELM XML Content
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+xml
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 1..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... content:elmJsonContent Σ 0..* Attachment ELM JSON Content
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+json
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 1..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard
Library.content:elmXmlContent.contentTyperequiredFixed Value: application/elm+xml
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Library.content:elmXmlContent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.content:elmJsonContent.contentTyperequiredFixed Value: application/elm+json
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Library.content:elmJsonContent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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 Shareable Library

Summary

Mandatory: 0 element(4 nested mandatory elements)
Must-Support: 9 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Library.relatedArtifact
  • The element 1 is sliced based on the value of Library.content

Differential View

This structure is derived from Shareable Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1 Shareable Library US Public Health Executable Library
... Slices for relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency 0..* RelatedArtifact Additional documentation, citations, etc.
..... type S 1..1 code Required dependency
Fixed Value: depends-on
..... display S 0..1 string Brief description of the related artifact
..... resource S 1..1 canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet) What resource is being referenced
... parameter S 0..* ParameterDefinition Parameters defined by the library
... dataRequirement S 0..* DataRequirement What data is referenced by this library
.... content:elmXmlContent 0..* Attachment ELM XML Content
..... contentType S 0..1 code Mime type of the content, with charset etc.
Fixed Value: application/elm+xml
..... data 1..1 base64Binary Data inline, base64ed
.... content:elmJsonContent 0..* Attachment ELM JSON Content
..... contentType S 0..1 code Mime type of the content, with charset etc.
Fixed Value: application/elm+json
..... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 1..1 Shareable Library US Public Health Executable Library
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... version Σ 1..1 string Business version of the library
... name ΣC 1..1 string Name for this library (computer friendly)
... title SΣ 0..1 string Name for this library (human friendly)
... 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 Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... date SΣ 0..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
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... 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.


... Slices for relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency 0..* RelatedArtifact Additional documentation, citations, etc.
..... type SΣ 1..1 code Required dependency
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(Shareable CodeSystem | Shareable Library | Shareable ValueSet) What resource is being referenced
... parameter S 0..* ParameterDefinition Parameters defined by the library
... dataRequirement S 0..* DataRequirement What data is referenced by this library
... Slices for content SΣ 0..* Attachment Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:elmXmlContent Σ 0..* Attachment ELM XML Content
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+xml
..... data 1..1 base64Binary Data inline, base64ed
.... content:elmJsonContent Σ 0..* Attachment ELM JSON Content
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+json
..... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard
Library.content:elmXmlContent.contentTyperequiredFixed Value: application/elm+xml
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Library.content:elmJsonContent.contentTyperequiredFixed Value: application/elm+json
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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}')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 1..1 Shareable Library US Public Health Executable Library
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 ΣC 1..1 string Name for this library (computer friendly)
... title SΣ 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 Σ 1..1 boolean For testing purposes, not real usage
... type Σ 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Σ 0..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
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... 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 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:dependency 0..* RelatedArtifact Additional documentation, citations, etc.
..... 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 Required dependency
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(Shareable CodeSystem | Shareable Library | Shareable ValueSet) What resource is being referenced
... parameter S 0..* ParameterDefinition Parameters defined by the library
... dataRequirement S 0..* DataRequirement What data is referenced by this library
... Slices for content SΣ 0..* Attachment Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:elmXmlContent Σ 0..* Attachment ELM XML Content
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+xml
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 1..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... content:elmJsonContent Σ 0..* Attachment ELM JSON Content
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/elm+json
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 1..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard
Library.content:elmXmlContent.contentTyperequiredFixed Value: application/elm+xml
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Library.content:elmXmlContent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.content:elmJsonContent.contentTyperequiredFixed Value: application/elm+json
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Library.content:elmJsonContent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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 Shareable Library

Summary

Mandatory: 0 element(4 nested mandatory elements)
Must-Support: 9 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Library.relatedArtifact
  • The element 1 is sliced based on the value of Library.content

 

Other representations of profile: CSV, Excel, Schematron