US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-specification-library | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthSpecificationLibrary | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.54 | ||||
This Library profile defines the asset-collection library for a public health reporting program specification, typically consisting of a ValueSet library and other supporting specifications such as PlanDefinitions.
It is based on the CRIM Shareable Library profile and futher constrains it as follows:
Published libraries should conform to the CRMI Publishable Library profile.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Library |
C | 1..1 | CRMIShareableLibrary(1.0.0) | US Public Health Specification Library Constraints: lib-0 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 |
| extension:artifactComment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 |
 extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| version |
SΣ | 1..1 | string | Business version of the library |
| name |
SΣC | 0..1 | string | Name for this library (computer friendly) |
| title |
SΣ | 1..1 | string | Name for this library (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 0..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 | |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
SΣ | 1..1 | markdown | Natural language description of the library |
| Slices for useContext |
Σ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
 useContext:reportingContext |
Σ | 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: triggering | |
| 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 |
Σ | 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 | |
 Slices for relatedArtifact |
S | 2..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() |
| relatedArtifact:planDefinition |
S | 1..1 | RelatedArtifact | US Public Health PlanDefinition |
 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 PlanDefinition(2.0.0)) | What resource is being referenced |
| relatedArtifact:triggeringValueSetLibrary |
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 Triggering ValueSet Library(2.0.0)) | What resource is being referenced |
| Documentation for this format | ||||
| 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.relatedArtifact:planDefinition.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Library.relatedArtifact:triggeringValueSetLibrary.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| 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.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, Library.modifierExtension, Library.url, Library.version, Library.name, Library.title, Library.status, Library.experimental, Library.type, Library.publisher, 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.relatedArtifact, Library.relatedArtifact:planDefinition, Library.relatedArtifact:planDefinition.type, Library.relatedArtifact:planDefinition.resource, Library.relatedArtifact:triggeringValueSetLibrary, Library.relatedArtifact:triggeringValueSetLibrary.type, Library.relatedArtifact:triggeringValueSetLibrary.resource | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Library.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, 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}')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
1..1 | CRMIShareableLibrary(1.0.0) | US Public Health Specification Library | |
 type |
S | 1..1 | CodeableConcept | asset-collection Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| Slices for useContext |
2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | |
| useContext:reportingContext |
1..1 | UsageContext | The context that the content is intended to support | |
| code |
1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: reporting | |
| value[x] |
1..1 | CodeableConcept | Library useContext Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |
| useContext:specificationTypeContext |
1..1 | UsageContext | The context that the content is intended to support | |
| code |
1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: specification-type | |
| value[x] |
1..1 | CodeableConcept | Library useContext Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
| Slices for relatedArtifact |
S | 2..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() |
| relatedArtifact:planDefinition |
S | 1..1 | RelatedArtifact | US Public Health PlanDefinition |
| type |
1..1 | code | composed-of Required Pattern: composed-of | |
| resource |
S | 1..1 | canonical(US Public Health PlanDefinition(2.0.0)) | What resource is being referenced |
| relatedArtifact:triggeringValueSetLibrary |
S | 1..* | RelatedArtifact | US Public Health Triggering ValueSet Library |
| type |
1..1 | code | composed-of Required Pattern: composed-of | |
| resource |
S | 1..1 | canonical(US Public Health Triggering ValueSet Library(2.0.0)) | What resource is being referenced |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Library |
C | 1..1 | CRMIShareableLibrary(1.0.0) | US Public Health Specification 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 | ||||
| extension:artifactComment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 | ||||
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | ||||
| extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
SΣ | 1..1 | string | Business version of the library | ||||
| name |
SΣC | 0..1 | string | Name for this library (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this library (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the library | |||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 0..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 |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
SΣ | 1..1 | markdown | Natural language description of the library | ||||
| Slices for useContext |
Σ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
| useContext:reportingContext |
Σ | 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: triggering | |||||
| 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 |
Σ | 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 |
Σ | 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 | 2..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | ||||
| relatedArtifact:planDefinition |
S | 1..1 | RelatedArtifact | US Public Health PlanDefinition | ||||
| 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 PlanDefinition(2.0.0)) | What resource is being referenced | ||||
| relatedArtifact:triggeringValueSetLibrary |
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 Triggering ValueSet Library(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 | ||||
| Documentation for this format | ||||||||
| 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:planDefinition.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Library.relatedArtifact:triggeringValueSetLibrary.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| 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.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, 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:planDefinition, Library.relatedArtifact:planDefinition.extension, Library.relatedArtifact:planDefinition.type, Library.relatedArtifact:planDefinition.label, Library.relatedArtifact:planDefinition.display, Library.relatedArtifact:planDefinition.citation, Library.relatedArtifact:planDefinition.url, Library.relatedArtifact:planDefinition.document, Library.relatedArtifact:planDefinition.resource, Library.relatedArtifact:triggeringValueSetLibrary, Library.relatedArtifact:triggeringValueSetLibrary.extension, Library.relatedArtifact:triggeringValueSetLibrary.type, Library.relatedArtifact:triggeringValueSetLibrary.label, Library.relatedArtifact:triggeringValueSetLibrary.display, Library.relatedArtifact:triggeringValueSetLibrary.citation, Library.relatedArtifact:triggeringValueSetLibrary.url, Library.relatedArtifact:triggeringValueSetLibrary.document, Library.relatedArtifact:triggeringValueSetLibrary.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.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, Library.modifierExtension, Library.useContext:reportingContext.extension, Library.useContext:specificationTypeContext.extension, Library.relatedArtifact:planDefinition.extension, Library.relatedArtifact:triggeringValueSetLibrary.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}')
|
Summary
Mandatory: 6 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
C | 1..1 | CRMIShareableLibrary(1.0.0) | US Public Health Specification Library Constraints: lib-0 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 |
| extension:artifactComment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 |
| extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| version |
SΣ | 1..1 | string | Business version of the library |
| name |
SΣC | 0..1 | string | Name for this library (computer friendly) |
| title |
SΣ | 1..1 | string | Name for this library (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 0..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 | |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
SΣ | 1..1 | markdown | Natural language description of the library |
| Slices for useContext |
Σ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code |
| useContext:reportingContext |
Σ | 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: triggering | |
| 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 |
Σ | 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 | |
| Slices for relatedArtifact |
S | 2..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() |
| relatedArtifact:planDefinition |
S | 1..1 | RelatedArtifact | US Public Health PlanDefinition |
| 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 PlanDefinition(2.0.0)) | What resource is being referenced |
| relatedArtifact:triggeringValueSetLibrary |
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 Triggering ValueSet Library(2.0.0)) | What resource is being referenced |
| Documentation for this format | ||||
| 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.relatedArtifact:planDefinition.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Library.relatedArtifact:triggeringValueSetLibrary.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| 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.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, Library.modifierExtension, Library.url, Library.version, Library.name, Library.title, Library.status, Library.experimental, Library.type, Library.publisher, 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.relatedArtifact, Library.relatedArtifact:planDefinition, Library.relatedArtifact:planDefinition.type, Library.relatedArtifact:planDefinition.resource, Library.relatedArtifact:triggeringValueSetLibrary, Library.relatedArtifact:triggeringValueSetLibrary.type, Library.relatedArtifact:triggeringValueSetLibrary.resource | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Library.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Library |
1..1 | CRMIShareableLibrary(1.0.0) | US Public Health Specification Library | |
| type |
S | 1..1 | CodeableConcept | asset-collection Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
| Slices for useContext |
2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | |
| useContext:reportingContext |
1..1 | UsageContext | The context that the content is intended to support | |
| code |
1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: reporting | |
| value[x] |
1..1 | CodeableConcept | Library useContext Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |
| useContext:specificationTypeContext |
1..1 | UsageContext | The context that the content is intended to support | |
| code |
1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: specification-type | |
| value[x] |
1..1 | CodeableConcept | Library useContext Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
| Slices for relatedArtifact |
S | 2..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() |
| relatedArtifact:planDefinition |
S | 1..1 | RelatedArtifact | US Public Health PlanDefinition |
| type |
1..1 | code | composed-of Required Pattern: composed-of | |
| resource |
S | 1..1 | canonical(US Public Health PlanDefinition(2.0.0)) | What resource is being referenced |
| relatedArtifact:triggeringValueSetLibrary |
S | 1..* | RelatedArtifact | US Public Health Triggering ValueSet Library |
| type |
1..1 | code | composed-of Required Pattern: composed-of | |
| resource |
S | 1..1 | canonical(US Public Health Triggering ValueSet Library(2.0.0)) | What resource is being referenced |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Library |
C | 1..1 | CRMIShareableLibrary(1.0.0) | US Public Health Specification 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 | ||||
| extension:artifactComment |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 | ||||
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | ||||
| extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
SΣ | 1..1 | string | Business version of the library | ||||
| name |
SΣC | 0..1 | string | Name for this library (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this library (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the library | |||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 0..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 |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
SΣ | 1..1 | markdown | Natural language description of the library | ||||
| Slices for useContext |
Σ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code | ||||
| useContext:reportingContext |
Σ | 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: triggering | |||||
| 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 |
Σ | 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 |
Σ | 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 | 2..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | ||||
| relatedArtifact:planDefinition |
S | 1..1 | RelatedArtifact | US Public Health PlanDefinition | ||||
| 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 PlanDefinition(2.0.0)) | What resource is being referenced | ||||
| relatedArtifact:triggeringValueSetLibrary |
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 Triggering ValueSet Library(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 | ||||
| Documentation for this format | ||||||||
| 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:planDefinition.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Library.relatedArtifact:triggeringValueSetLibrary.type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| 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.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, 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:planDefinition, Library.relatedArtifact:planDefinition.extension, Library.relatedArtifact:planDefinition.type, Library.relatedArtifact:planDefinition.label, Library.relatedArtifact:planDefinition.display, Library.relatedArtifact:planDefinition.citation, Library.relatedArtifact:planDefinition.url, Library.relatedArtifact:planDefinition.document, Library.relatedArtifact:planDefinition.resource, Library.relatedArtifact:triggeringValueSetLibrary, Library.relatedArtifact:triggeringValueSetLibrary.extension, Library.relatedArtifact:triggeringValueSetLibrary.type, Library.relatedArtifact:triggeringValueSetLibrary.label, Library.relatedArtifact:triggeringValueSetLibrary.display, Library.relatedArtifact:triggeringValueSetLibrary.citation, Library.relatedArtifact:triggeringValueSetLibrary.url, Library.relatedArtifact:triggeringValueSetLibrary.document, Library.relatedArtifact:triggeringValueSetLibrary.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.extension:knowledgeCapability, Library.extension:artifactComment, Library.extension:versionAlgorithm, Library.extension:versionPolicy, Library.modifierExtension, Library.useContext:reportingContext.extension, Library.useContext:specificationTypeContext.extension, Library.relatedArtifact:planDefinition.extension, Library.relatedArtifact:triggeringValueSetLibrary.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}')
|
Summary
Mandatory: 6 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ph-library#2.0.0 based on FHIR 4.0.1.
Generated 2025-10-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
