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-valueset-library | Version: 1.0.0 | |||
Active as of 2023-10-04 | Computable Name: USPublicHealthValueSetLibrary |
This Library profile defines the library containing US Public Health value sets.
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 | Shareable Library | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expansionParameters | S | 0..1 | Reference(Parameters) | Expansion Parameters for the ValueSet. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension |
identifier | ||||
system | S | 1..1 | uri | The namespace for Object Identifiers Required Pattern: urn:ietf:rfc:3986 |
value | S | 1..1 | string | The value that is unique |
version | S | 1..1 | string | Value Sets Definition Version |
title | 1..1 | string | Value Sets Name | |
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 | |
description | S | 1..1 | markdown | The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection). |
purpose | S | 1..1 | markdown | Value Sets Purpose |
effectivePeriod | S | 1..1 | Period | When the library is expected to be used |
start | S | 1..1 | dateTime | Value Sets Effective Start Date |
Slices for relatedArtifact | 1..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | |
relatedArtifact:USPHValueSet | S | 1..* | RelatedArtifact | US Public Health Value Set |
type | 1..1 | code | composed-of Required Pattern: composed-of | |
resource | S | 1..1 | canonical(US Public Health ValueSet) | 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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expansionParameters | S | 0..1 | Reference(Parameters) | Expansion Parameters for the ValueSet. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension |
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 |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for Object Identifiers Required Pattern: urn:ietf:rfc:3986 |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
version | SΣ | 1..1 | string | Value Sets Definition Version |
name | ΣC | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..1 | string | Value Sets Name |
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 | SΣ | 1..1 | markdown | The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection). |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | S | 1..1 | markdown | Value Sets Purpose |
effectivePeriod | SΣ | 1..1 | Period | When the library is expected to be used |
start | SΣC | 1..1 | dateTime | Value Sets Effective Start Date |
Slices for relatedArtifact | 1..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | |
relatedArtifact:USPHValueSet | S | 1..* | RelatedArtifact | US Public Health Value Set |
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 ValueSet) | What resource is being referenced |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Library.identifier.use | required | IdentifierUse |
Library.status | required | PublicationStatus |
Library.type | extensible | Pattern: asset-collection |
Library.jurisdiction | extensible | Jurisdiction ValueSet |
Library.relatedArtifact:USPHValueSet.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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
expansionParameters | S | 0..1 | Reference(Parameters) | Expansion Parameters for the ValueSet. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension | ||||
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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for Object Identifiers Required Pattern: urn:ietf:rfc:3986 | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
version | SΣ | 1..1 | string | Value Sets Definition Version | ||||
name | ΣC | 1..1 | string | Name for this library (computer friendly) | ||||
title | SΣ | 1..1 | string | Value Sets Name | ||||
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 | SΣ | 1..1 | markdown | The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection). | ||||
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | S | 1..1 | markdown | Value Sets Purpose | ||||
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 | SΣ | 1..1 | Period | When the library is expected to be used | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Value Sets Effective Start Date | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
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 | 1..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | |||||
relatedArtifact:USPHValueSet | S | 1..* | RelatedArtifact | US Public Health Value Set | ||||
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 ValueSet) | 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.identifier.use | required | IdentifierUse | ||||
Library.identifier.type | extensible | Identifier Type Codes | ||||
Library.status | required | PublicationStatus | ||||
Library.type | extensible | Pattern: asset-collection | ||||
Library.subject[x] | extensible | SubjectType | ||||
Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
Library.topic | example | DefinitionTopic | ||||
Library.relatedArtifact:USPHValueSet.type | required | Pattern: composed-of |
This structure is derived from Shareable Library
Summary
Mandatory: 7 elements (2 nested mandatory elements)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Shareable Library
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | Shareable Library | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expansionParameters | S | 0..1 | Reference(Parameters) | Expansion Parameters for the ValueSet. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension |
identifier | ||||
system | S | 1..1 | uri | The namespace for Object Identifiers Required Pattern: urn:ietf:rfc:3986 |
value | S | 1..1 | string | The value that is unique |
version | S | 1..1 | string | Value Sets Definition Version |
title | 1..1 | string | Value Sets Name | |
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 | |
description | S | 1..1 | markdown | The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection). |
purpose | S | 1..1 | markdown | Value Sets Purpose |
effectivePeriod | S | 1..1 | Period | When the library is expected to be used |
start | S | 1..1 | dateTime | Value Sets Effective Start Date |
Slices for relatedArtifact | 1..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | |
relatedArtifact:USPHValueSet | S | 1..* | RelatedArtifact | US Public Health Value Set |
type | 1..1 | code | composed-of Required Pattern: composed-of | |
resource | S | 1..1 | canonical(US Public Health ValueSet) | 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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expansionParameters | S | 0..1 | Reference(Parameters) | Expansion Parameters for the ValueSet. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension |
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 |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for Object Identifiers Required Pattern: urn:ietf:rfc:3986 |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
version | SΣ | 1..1 | string | Value Sets Definition Version |
name | ΣC | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..1 | string | Value Sets Name |
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 | SΣ | 1..1 | markdown | The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection). |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | S | 1..1 | markdown | Value Sets Purpose |
effectivePeriod | SΣ | 1..1 | Period | When the library is expected to be used |
start | SΣC | 1..1 | dateTime | Value Sets Effective Start Date |
Slices for relatedArtifact | 1..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | |
relatedArtifact:USPHValueSet | S | 1..* | RelatedArtifact | US Public Health Value Set |
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 ValueSet) | What resource is being referenced |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Library.identifier.use | required | IdentifierUse |
Library.status | required | PublicationStatus |
Library.type | extensible | Pattern: asset-collection |
Library.jurisdiction | extensible | Jurisdiction ValueSet |
Library.relatedArtifact:USPHValueSet.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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
expansionParameters | S | 0..1 | Reference(Parameters) | Expansion Parameters for the ValueSet. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension | ||||
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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for Object Identifiers Required Pattern: urn:ietf:rfc:3986 | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
version | SΣ | 1..1 | string | Value Sets Definition Version | ||||
name | ΣC | 1..1 | string | Name for this library (computer friendly) | ||||
title | SΣ | 1..1 | string | Value Sets Name | ||||
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 | SΣ | 1..1 | markdown | The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection). | ||||
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | S | 1..1 | markdown | Value Sets Purpose | ||||
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 | SΣ | 1..1 | Period | When the library is expected to be used | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Value Sets Effective Start Date | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
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 | 1..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() | |||||
relatedArtifact:USPHValueSet | S | 1..* | RelatedArtifact | US Public Health Value Set | ||||
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 ValueSet) | 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.identifier.use | required | IdentifierUse | ||||
Library.identifier.type | extensible | Identifier Type Codes | ||||
Library.status | required | PublicationStatus | ||||
Library.type | extensible | Pattern: asset-collection | ||||
Library.subject[x] | extensible | SubjectType | ||||
Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
Library.topic | example | DefinitionTopic | ||||
Library.relatedArtifact:USPHValueSet.type | required | Pattern: composed-of |
This structure is derived from Shareable Library
Summary
Mandatory: 7 elements (2 nested mandatory elements)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron