US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

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

Resource Profile: US Public Health Executable ValueSet

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-executable-valueset Version: 1.0.0
Active as of 2023-10-04 Computable Name: USPublicHealthExecutableValueSet

This ValueSet profile describes the requirements for a value set containing a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. The complete expansion of the ValueSet is included, but not necessarily the computable definition. An executable value set is intended for use in environments that are not expected to have access to a terminology server capable of expanding the value set, so the expansion is communicated as part of the ValueSet.

It is based on the US Public Health ValueSet and describes an executable value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage.

Usage:

Formal Views of Profile Content

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

This structure is derived from USPublicHealthValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1USPublicHealthValueSetA set of codes drawn from one or more code systems
... extension 3..*ExtensionExtension
... usageWarning S1..1stringUS Public Health Usage Warning Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension
.... value[x] S1..1stringValue of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an executable value set, a distributable definition of the value set must be obtained to compute the updated expansion.
... expansion S1..1BackboneElementUsed when the value set is "expanded"
.... parameter S0..*BackboneElementParameter that controlled the expansion process
.... contains S0..*BackboneElementCodes in the value set

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron