HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2 US

This page is part of the electronic Case Reporting (eCR) (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Supplemental Valueset Library

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-supplemental-valueset-library Version: 2.1.0
Active as of 2020-11-11 Computable Name: USPublicHealthSupplementalValuesetLibrary

Defines the library containing the US Public Health supplemental value sets.

Usage:

Formal Views of Profile Content

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

This structure is derived from USPublicHealthValueSetLibrary

Summary

Mandatory: 9 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Library.useContext is sliced based on the value of pattern:code
  • The element Library.relatedArtifact is sliced based on the value of value:type

This structure is derived from USPublicHealthValueSetLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1USPublicHealthValueSetLibraryUS Public Health Supplemental ValueSet Library
... Slices for useContext 2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:reportingContext 1..1UsageContextThe context that the content is intended to support
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] 1..1CodeableConceptLibrary useContext
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental
.... useContext:specificationTypeContext 1..1UsageContextThe context that the content is intended to support
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: specification-type
..... value[x] 1..1CodeableConceptLibrary useContext
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: value-set-library
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:sliceUSPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... type 1..1codecomposed-of
Required Pattern: composed-of
..... resource S1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1USPublicHealthValueSetLibraryUS Public Health Supplemental ValueSet Library
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... expansionParameters S0..1Reference(Parameters)Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-expansion-parameters-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version SΣ1..1stringValue Sets Definition Version
... name ΣI1..1stringName for this library (computer friendly)
... title SΣ1..1stringValue Sets Name
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownValue Sets Release Description
... Slices for useContext SΣ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:reportingContext SΣ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptLibrary 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
.... useContext:specificationTypeContext SΣ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: specification-type
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptLibrary 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: value-set-library
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownValue Sets Purpose
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod SΣ1..1PeriodWhen the library is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣI1..1dateTimeValue Sets Effective Start Date
.... end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:sliceUSPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: composed-of
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1USPublicHealthValueSetLibraryUS Public Health Supplemental ValueSet Library
... expansionParameters 0..1Reference(Parameters)Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-expansion-parameters-extension
... identifier Σ0..*IdentifierAdditional identifier for the library
.... system Σ1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value Σ1..1stringThe value that is unique
... version Σ1..1stringValue Sets Definition Version
... type Σ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
... date Σ0..1dateTimeDate last changed
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownValue Sets Release Description
... Slices for useContext Σ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:reportingContext Σ1..1UsageContextThe context that the content is intended to support
.... useContext:specificationTypeContext Σ1..1UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 1..1markdownValue Sets Purpose
... effectivePeriod Σ1..1PeriodWhen the library is expected to be used
.... start ΣI1..1dateTimeValue Sets Effective Start Date
... relatedArtifact:sliceUSPHValueSet 1..*RelatedArtifactUS Public Health Supplemental Value Set
.... resource Σ1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced

doco Documentation for this format

This structure is derived from USPublicHealthValueSetLibrary

Summary

Mandatory: 9 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Library.useContext is sliced based on the value of pattern:code
  • The element Library.relatedArtifact is sliced based on the value of value:type

Differential View

This structure is derived from USPublicHealthValueSetLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1USPublicHealthValueSetLibraryUS Public Health Supplemental ValueSet Library
... Slices for useContext 2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:reportingContext 1..1UsageContextThe context that the content is intended to support
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] 1..1CodeableConceptLibrary useContext
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental
.... useContext:specificationTypeContext 1..1UsageContextThe context that the content is intended to support
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: specification-type
..... value[x] 1..1CodeableConceptLibrary useContext
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: value-set-library
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:sliceUSPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... type 1..1codecomposed-of
Required Pattern: composed-of
..... resource S1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1USPublicHealthValueSetLibraryUS Public Health Supplemental ValueSet Library
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... expansionParameters S0..1Reference(Parameters)Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-expansion-parameters-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version SΣ1..1stringValue Sets Definition Version
... name ΣI1..1stringName for this library (computer friendly)
... title SΣ1..1stringValue Sets Name
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownValue Sets Release Description
... Slices for useContext SΣ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:reportingContext SΣ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptLibrary 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
.... useContext:specificationTypeContext SΣ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: specification-type
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptLibrary 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: value-set-library
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownValue Sets Purpose
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod SΣ1..1PeriodWhen the library is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣI1..1dateTimeValue Sets Effective Start Date
.... end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:sliceUSPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: composed-of
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Library.languagepreferredCommonLanguages
Max Binding: AllLanguages
Library.identifier.userequiredIdentifierUse
Library.identifier.typeextensibleIdentifier Type Codes
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.subject[x]extensibleSubjectType
Library.useContext:reportingContext.codeextensiblePattern: reporting
Library.useContext:reportingContext.value[x]examplePattern: supplemental
Library.useContext:specificationTypeContext.codeextensiblePattern: specification-type
Library.useContext:specificationTypeContext.value[x]examplePattern: value-set-library
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact:sliceUSPHValueSet.typerequiredPattern: composed-of

Constraints

IdGradePathDetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLibraryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeLibraryA resource should have narrative for robust management
: text.`div`.exists()
lib-0warningLibraryName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1errorLibrary.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:expansionParametersAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.extension:expansionParametersMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContext:reportingContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContext:reportingContext.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.useContext:reportingContext.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.useContext:reportingContext.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContext:reportingContext.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContext:specificationTypeContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContext:specificationTypeContext.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.useContext:specificationTypeContext.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.useContext:specificationTypeContext.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContext:specificationTypeContext.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.effectivePeriod.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.effectivePeriod.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.effectivePeriod.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.effectivePeriod.endAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.relatedArtifact:sliceUSPHValueSet.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.labelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.citationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.documentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifact:sliceUSPHValueSet.resourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())