US Public Health Profiles Library
1.0.0 - STU1
US Public Health Profiles Library
1.0.0 - STU1
US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-specification-library | Version: 1.0.0 | |||
| Active as of 2023-10-04 | Computable Name: USPublicHealthSpecificationLibrary | |||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | 1..1 | Shareable Library | Represents a library of quality improvement components | |
  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 pattern: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) | 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) | What resource is being referenced |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement components |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| 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) |
| 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 |
| 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 | |
| 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 pattern: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 |
| 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 Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. 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 | 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 |
| 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 Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. 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 | |
| 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 | 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) | 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) | What resource is being referenced |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Library.status | required | PublicationStatus |
| Library.type | extensible | Pattern: asset-collection |
| Library.useContext:reportingContext.code | extensible | Pattern: reporting |
| Library.useContext:reportingContext.value[x] | example | Pattern: triggering |
| Library.useContext:specificationTypeContext.code | extensible | Pattern: specification-type |
| Library.useContext:specificationTypeContext.value[x] | example | Pattern: program |
| Library.jurisdiction | extensible | Jurisdiction ValueSet |
| Library.relatedArtifact:planDefinition.type | required | Pattern: composed-of |
| Library.relatedArtifact:triggeringValueSetLibrary.type | required | Pattern: composed-of |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement components | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier | SΣ | 0..* | Identifier | Additional identifier for the library | ||||
| version | Σ | 1..1 | string | Business version of the library | ||||
| name | ΣC | 1..1 | string | Name for this library (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this library (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the library | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
| type | 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 pattern: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 | |||||
| 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 | SΣ | 1..1 | UsageContext | The context that the content is intended to support | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 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 | 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 | |||||
| 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) | 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 | |||||
| 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) | 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 | Conformance | ValueSet / Code | ||||
| Library.language | preferred | CommonLanguages
| ||||
| Library.status | required | PublicationStatus | ||||
| Library.type | extensible | Pattern: asset-collection | ||||
| Library.subject[x] | extensible | SubjectType | ||||
| Library.useContext:reportingContext.code | extensible | Pattern: reporting | ||||
| Library.useContext:reportingContext.value[x] | example | Pattern: triggering | ||||
| Library.useContext:specificationTypeContext.code | extensible | Pattern: specification-type | ||||
| Library.useContext:specificationTypeContext.value[x] | example | Pattern: program | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Library.topic | example | DefinitionTopic | ||||
| Library.relatedArtifact:planDefinition.type | required | Pattern: composed-of | ||||
| Library.relatedArtifact:triggeringValueSetLibrary.type | required | Pattern: composed-of |
This structure is derived from Shareable Library
Summary
Mandatory: 6 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Shareable Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | 1..1 | Shareable Library | Represents a library of quality improvement components | |
| 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 pattern: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) | 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) | What resource is being referenced |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement components |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
| 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) |
| 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 |
| 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 | |
| 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 pattern: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 |
| 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 Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. 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 | 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 |
| 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 Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. 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 | |
| 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 | 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) | 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) | What resource is being referenced |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Library.status | required | PublicationStatus |
| Library.type | extensible | Pattern: asset-collection |
| Library.useContext:reportingContext.code | extensible | Pattern: reporting |
| Library.useContext:reportingContext.value[x] | example | Pattern: triggering |
| Library.useContext:specificationTypeContext.code | extensible | Pattern: specification-type |
| Library.useContext:specificationTypeContext.value[x] | example | Pattern: program |
| Library.jurisdiction | extensible | Jurisdiction ValueSet |
| Library.relatedArtifact:planDefinition.type | required | Pattern: composed-of |
| Library.relatedArtifact:triggeringValueSetLibrary.type | required | Pattern: composed-of |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 1..1 | Shareable Library | Represents a library of quality improvement components | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
| identifier | SΣ | 0..* | Identifier | Additional identifier for the library | ||||
| version | Σ | 1..1 | string | Business version of the library | ||||
| name | ΣC | 1..1 | string | Name for this library (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this library (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the library | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
| type | 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 pattern: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 | |||||
| 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 | SΣ | 1..1 | UsageContext | The context that the content is intended to support | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 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 | 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 | |||||
| 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) | 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 | |||||
| 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) | 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 | Conformance | ValueSet / Code | ||||
| Library.language | preferred | CommonLanguages
| ||||
| Library.status | required | PublicationStatus | ||||
| Library.type | extensible | Pattern: asset-collection | ||||
| Library.subject[x] | extensible | SubjectType | ||||
| Library.useContext:reportingContext.code | extensible | Pattern: reporting | ||||
| Library.useContext:reportingContext.value[x] | example | Pattern: triggering | ||||
| Library.useContext:specificationTypeContext.code | extensible | Pattern: specification-type | ||||
| Library.useContext:specificationTypeContext.value[x] | example | Pattern: program | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Library.topic | example | DefinitionTopic | ||||
| Library.relatedArtifact:planDefinition.type | required | Pattern: composed-of | ||||
| Library.relatedArtifact:triggeringValueSetLibrary.type | required | Pattern: composed-of |
This structure is derived from Shareable Library
Summary
Mandatory: 6 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 Public Health Working Group. Package hl7.fhir.us.ph-library#1.0.0 based on FHIR 4.0.1. Generated 2023-10-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change