Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 - Ballot United States of America flag

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: eRSD Supplemental Library

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-supplemental-library Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: ERSDSupplementalLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.13

Defines the asset-collection library containing the eRSD supplemental assets.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 1..1 USPublicHealthSupplementalLibrary(2.0.0) eRSD Supplemental Library
Constraints: lib-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 SΣ 1..1 CodeableConcept asset-collection
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
... 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
... Slices for useContext SΣ 2..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:reportingContext SΣ 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: reporting
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: supplemental
....... 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
.... useContext:specificationTypeContext SΣ 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: specification-type
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... 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
...... text 0..1 string Plain text representation of the concept
... 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 3..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:computableLibrary S 1..1 RelatedArtifact US Public Health Computable Library
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... resource SΣ 1..1 canonical(CQL Library(2.0.0)) What resource is being referenced
.... relatedArtifact:supplementalValueSetLibrary S 1..* RelatedArtifact US Public Health Triggering ValueSet Library
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... resource SΣ 1..1 canonical(US Public Health Supplemental ValueSet Library(2.0.0)) What resource is being referenced
.... relatedArtifact:sliceJurisdictionsCodeSystem S 1..1 RelatedArtifact Jurisdiction CodeSystem
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... resource SΣ 1..1 canonical(US Public Health CodeSystem(2.0.0)) What resource is being referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.relatedArtifact:computableLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:supplementalValueSetLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:sliceJurisdictionsCodeSystem.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.implicitRules, Library.modifierExtension, Library.url, Library.identifier, Library.version, Library.name, Library.title, Library.status, Library.experimental, Library.type, Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.useContext:reportingContext, Library.useContext:reportingContext.code, Library.useContext:reportingContext.value[x], Library.useContext:specificationTypeContext, Library.useContext:specificationTypeContext.code, Library.useContext:specificationTypeContext.value[x], Library.jurisdiction, Library.relatedArtifact, Library.relatedArtifact:computableLibrary, Library.relatedArtifact:computableLibrary.type, Library.relatedArtifact:computableLibrary.resource, Library.relatedArtifact:supplementalValueSetLibrary, Library.relatedArtifact:supplementalValueSetLibrary.type, Library.relatedArtifact:supplementalValueSetLibrary.resource, Library.relatedArtifact:sliceJurisdictionsCodeSystem, Library.relatedArtifact:sliceJurisdictionsCodeSystem.type, Library.relatedArtifact:sliceJurisdictionsCodeSystem.resource 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()
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 USPublicHealthSupplementalLibrary

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 1..1 USPublicHealthSupplementalLibrary(2.0.0) eRSD Supplemental Library
... relatedArtifact 3..* RelatedArtifact Additional documentation, citations, etc.
... Slices for relatedArtifact Content/Rules for all slices
.... relatedArtifact:sliceJurisdictionsCodeSystem S 1..1 RelatedArtifact Jurisdiction CodeSystem
..... type 1..1 code composed-of
Required Pattern: composed-of
..... resource S 1..1 canonical(US Public Health CodeSystem(2.0.0)) What resource is being referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 1..1 USPublicHealthSupplementalLibrary(2.0.0) eRSD Supplemental Library
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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 SΣ 1..1 CodeableConcept asset-collection
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 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
... Slices for useContext SΣ 2..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:reportingContext 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
Constraints: ext-1
..... 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: reporting
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: supplemental
....... 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
.... useContext:specificationTypeContext 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
Constraints: ext-1
..... 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: specification-type
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... 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
...... text 0..1 string Plain text representation of the concept
... 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 3..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:computableLibrary S 1..1 RelatedArtifact US Public Health Computable Library
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... label Σ 0..1 string Short label
..... display Σ 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(CQL Library(2.0.0)) What resource is being referenced
.... relatedArtifact:supplementalValueSetLibrary S 1..* RelatedArtifact US Public Health Triggering ValueSet Library
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... label Σ 0..1 string Short label
..... display Σ 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(US Public Health Supplemental ValueSet Library(2.0.0)) What resource is being referenced
.... relatedArtifact:sliceJurisdictionsCodeSystem S 1..1 RelatedArtifact Jurisdiction CodeSystem
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... label Σ 0..1 string Short label
..... display Σ 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(US Public Health CodeSystem(2.0.0)) 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact:computableLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:supplementalValueSetLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:sliceJurisdictionsCodeSystem.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.meta, Library.implicitRules, Library.language, Library.text, Library.extension, Library.modifierExtension, Library.url, Library.identifier, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.useContext:reportingContext, Library.useContext:reportingContext.extension, Library.useContext:reportingContext.code, Library.useContext:reportingContext.value[x], Library.useContext:specificationTypeContext, Library.useContext:specificationTypeContext.extension, Library.useContext:specificationTypeContext.code, Library.useContext:specificationTypeContext.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact:computableLibrary, Library.relatedArtifact:computableLibrary.extension, Library.relatedArtifact:computableLibrary.type, Library.relatedArtifact:computableLibrary.label, Library.relatedArtifact:computableLibrary.display, Library.relatedArtifact:computableLibrary.citation, Library.relatedArtifact:computableLibrary.url, Library.relatedArtifact:computableLibrary.document, Library.relatedArtifact:computableLibrary.resource, Library.relatedArtifact:supplementalValueSetLibrary, Library.relatedArtifact:supplementalValueSetLibrary.extension, Library.relatedArtifact:supplementalValueSetLibrary.type, Library.relatedArtifact:supplementalValueSetLibrary.label, Library.relatedArtifact:supplementalValueSetLibrary.display, Library.relatedArtifact:supplementalValueSetLibrary.citation, Library.relatedArtifact:supplementalValueSetLibrary.url, Library.relatedArtifact:supplementalValueSetLibrary.document, Library.relatedArtifact:supplementalValueSetLibrary.resource, Library.relatedArtifact:sliceJurisdictionsCodeSystem, Library.relatedArtifact:sliceJurisdictionsCodeSystem.extension, Library.relatedArtifact:sliceJurisdictionsCodeSystem.type, Library.relatedArtifact:sliceJurisdictionsCodeSystem.label, Library.relatedArtifact:sliceJurisdictionsCodeSystem.display, Library.relatedArtifact:sliceJurisdictionsCodeSystem.citation, Library.relatedArtifact:sliceJurisdictionsCodeSystem.url, Library.relatedArtifact:sliceJurisdictionsCodeSystem.document, Library.relatedArtifact:sliceJurisdictionsCodeSystem.resource, Library.parameter, Library.dataRequirement, Library.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.extension, Library.modifierExtension, Library.useContext:reportingContext.extension, Library.useContext:specificationTypeContext.extension, Library.relatedArtifact:computableLibrary.extension, Library.relatedArtifact:supplementalValueSetLibrary.extension, Library.relatedArtifact:sliceJurisdictionsCodeSystem.extension 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 USPublicHealthSupplementalLibrary

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 1..1 USPublicHealthSupplementalLibrary(2.0.0) eRSD Supplemental Library
Constraints: lib-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 SΣ 1..1 CodeableConcept asset-collection
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
... 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
... Slices for useContext SΣ 2..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:reportingContext SΣ 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: reporting
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: supplemental
....... 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
.... useContext:specificationTypeContext SΣ 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: specification-type
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... 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
...... text 0..1 string Plain text representation of the concept
... 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 3..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:computableLibrary S 1..1 RelatedArtifact US Public Health Computable Library
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... resource SΣ 1..1 canonical(CQL Library(2.0.0)) What resource is being referenced
.... relatedArtifact:supplementalValueSetLibrary S 1..* RelatedArtifact US Public Health Triggering ValueSet Library
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... resource SΣ 1..1 canonical(US Public Health Supplemental ValueSet Library(2.0.0)) What resource is being referenced
.... relatedArtifact:sliceJurisdictionsCodeSystem S 1..1 RelatedArtifact Jurisdiction CodeSystem
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... resource SΣ 1..1 canonical(US Public Health CodeSystem(2.0.0)) What resource is being referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.relatedArtifact:computableLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:supplementalValueSetLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:sliceJurisdictionsCodeSystem.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.implicitRules, Library.modifierExtension, Library.url, Library.identifier, Library.version, Library.name, Library.title, Library.status, Library.experimental, Library.type, Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.useContext:reportingContext, Library.useContext:reportingContext.code, Library.useContext:reportingContext.value[x], Library.useContext:specificationTypeContext, Library.useContext:specificationTypeContext.code, Library.useContext:specificationTypeContext.value[x], Library.jurisdiction, Library.relatedArtifact, Library.relatedArtifact:computableLibrary, Library.relatedArtifact:computableLibrary.type, Library.relatedArtifact:computableLibrary.resource, Library.relatedArtifact:supplementalValueSetLibrary, Library.relatedArtifact:supplementalValueSetLibrary.type, Library.relatedArtifact:supplementalValueSetLibrary.resource, Library.relatedArtifact:sliceJurisdictionsCodeSystem, Library.relatedArtifact:sliceJurisdictionsCodeSystem.type, Library.relatedArtifact:sliceJurisdictionsCodeSystem.resource 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()
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 USPublicHealthSupplementalLibrary

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 1..1 USPublicHealthSupplementalLibrary(2.0.0) eRSD Supplemental Library
... relatedArtifact 3..* RelatedArtifact Additional documentation, citations, etc.
... Slices for relatedArtifact Content/Rules for all slices
.... relatedArtifact:sliceJurisdictionsCodeSystem S 1..1 RelatedArtifact Jurisdiction CodeSystem
..... type 1..1 code composed-of
Required Pattern: composed-of
..... resource S 1..1 canonical(US Public Health CodeSystem(2.0.0)) What resource is being referenced

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 1..1 USPublicHealthSupplementalLibrary(2.0.0) eRSD Supplemental Library
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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 SΣ 1..1 CodeableConcept asset-collection
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 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
... Slices for useContext SΣ 2..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:reportingContext 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
Constraints: ext-1
..... 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: reporting
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: supplemental
....... 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
.... useContext:specificationTypeContext 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
Constraints: ext-1
..... 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
...... 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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-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: specification-type
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
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://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... 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
...... text 0..1 string Plain text representation of the concept
... 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 3..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:computableLibrary S 1..1 RelatedArtifact US Public Health Computable Library
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... label Σ 0..1 string Short label
..... display Σ 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(CQL Library(2.0.0)) What resource is being referenced
.... relatedArtifact:supplementalValueSetLibrary S 1..* RelatedArtifact US Public Health Triggering ValueSet Library
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... label Σ 0..1 string Short label
..... display Σ 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(US Public Health Supplemental ValueSet Library(2.0.0)) What resource is being referenced
.... relatedArtifact:sliceJurisdictionsCodeSystem S 1..1 RelatedArtifact Jurisdiction CodeSystem
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... type Σ 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of
..... label Σ 0..1 string Short label
..... display Σ 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(US Public Health CodeSystem(2.0.0)) 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:reportingContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:specificationTypeContext.​value[x] Base example ConformanceUseContext 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact:computableLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:supplementalValueSetLibrary.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Library.relatedArtifact:sliceJurisdictionsCodeSystem.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.meta, Library.implicitRules, Library.language, Library.text, Library.extension, Library.modifierExtension, Library.url, Library.identifier, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.useContext:reportingContext, Library.useContext:reportingContext.extension, Library.useContext:reportingContext.code, Library.useContext:reportingContext.value[x], Library.useContext:specificationTypeContext, Library.useContext:specificationTypeContext.extension, Library.useContext:specificationTypeContext.code, Library.useContext:specificationTypeContext.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact:computableLibrary, Library.relatedArtifact:computableLibrary.extension, Library.relatedArtifact:computableLibrary.type, Library.relatedArtifact:computableLibrary.label, Library.relatedArtifact:computableLibrary.display, Library.relatedArtifact:computableLibrary.citation, Library.relatedArtifact:computableLibrary.url, Library.relatedArtifact:computableLibrary.document, Library.relatedArtifact:computableLibrary.resource, Library.relatedArtifact:supplementalValueSetLibrary, Library.relatedArtifact:supplementalValueSetLibrary.extension, Library.relatedArtifact:supplementalValueSetLibrary.type, Library.relatedArtifact:supplementalValueSetLibrary.label, Library.relatedArtifact:supplementalValueSetLibrary.display, Library.relatedArtifact:supplementalValueSetLibrary.citation, Library.relatedArtifact:supplementalValueSetLibrary.url, Library.relatedArtifact:supplementalValueSetLibrary.document, Library.relatedArtifact:supplementalValueSetLibrary.resource, Library.relatedArtifact:sliceJurisdictionsCodeSystem, Library.relatedArtifact:sliceJurisdictionsCodeSystem.extension, Library.relatedArtifact:sliceJurisdictionsCodeSystem.type, Library.relatedArtifact:sliceJurisdictionsCodeSystem.label, Library.relatedArtifact:sliceJurisdictionsCodeSystem.display, Library.relatedArtifact:sliceJurisdictionsCodeSystem.citation, Library.relatedArtifact:sliceJurisdictionsCodeSystem.url, Library.relatedArtifact:sliceJurisdictionsCodeSystem.document, Library.relatedArtifact:sliceJurisdictionsCodeSystem.resource, Library.parameter, Library.dataRequirement, Library.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.extension, Library.modifierExtension, Library.useContext:reportingContext.extension, Library.useContext:specificationTypeContext.extension, Library.relatedArtifact:computableLibrary.extension, Library.relatedArtifact:supplementalValueSetLibrary.extension, Library.relatedArtifact:sliceJurisdictionsCodeSystem.extension 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 USPublicHealthSupplementalLibrary

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron