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

## 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:

- Examples for this Resource Profile: USPublicHealthValueSetExecutableChlamydiaExample

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from USPublicHealthValueSet

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet |  | 1..1 | USPublicHealthValueSet | A set of codes drawn from one or more code systems
extension |  | 3..* | Extension | Extension
usageWarning | S | 1..1 | string | US Public Health Usage Warning Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension
value[x] | S | 1..1 | string | Value 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 | S | 1..1 | BackboneElement | Used when the value set is "expanded"
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
contains | S | 0..* | BackboneElement | Codes in the value set
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | USPublicHealthValueSet | A set of codes drawn from one or more code systems
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension | S | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author
usageWarning | S | 1..1 | string | US Public Health Usage Warning Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension"
value[x] | S | 1..1 | string | Value 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.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Value set identifier used by public health
version | Σ | 1..1 | string | Business version of the value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | S Σ | 1..1 | string | Value set title
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
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
description |  | 1..1 | markdown | Natural language description of the value set
Slices for useContext | S Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code
useContext:priorityContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
code | S Σ | 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: priority
value[x] | S Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.
useContext:focusConditionContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
code | S Σ | 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://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus
value[x] | S Σ | 1..1 | CodeableConcept | Clinical condition that is the focus of the codes in this value set Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.
expansion | S | 1..1 | BackboneElement | Used when the value set is "expanded"
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
timestamp |  | 1..1 | dateTime | Time ValueSet expansion happened
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
contains | S C | 0..* | BackboneElement | Codes in the value set
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ValueSet.status | required | PublicationStatus
ValueSet.useContext:priorityContext.code | extensible | Pattern: priority
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focus
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodes

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | USPublicHealthValueSet | A set of codes drawn from one or more code systems
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension | S | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author
usageWarning | S | 1..1 | string | US Public Health Usage Warning Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension"
value[x] | S | 1..1 | string | Value 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.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Value set identifier used by public health
version | Σ | 1..1 | string | Business version of the value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | S Σ | 1..1 | string | Value set title
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
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description |  | 1..1 | markdown | Natural language description of the value set
Slices for useContext | S Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code
useContext:priorityContext | S Σ | 0..* | 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 | S Σ | 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: priority
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | S Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.
useContext:focusConditionContext | S Σ | 0..* | 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 | S Σ | 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://terminology.hl7.org/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: focus
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | S Σ | 1..1 | CodeableConcept | Clinical condition that is the focus of the codes in this value set Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur
purpose |  | 0..1 | markdown | Why this value set is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
compose |  | 0..1 | BackboneElement | Content logical definition of the value set (CLD)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive)
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | Σ C | 0..1 | uri | The system the codes come from
version | Σ | 0..1 | string | Specific version of the code system referred to
concept | C | 0..* | BackboneElement | A concept defined in the system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Code or expression from system
display |  | 0..1 | string | Text to display for this code for this value set in this valueset
designation |  | 0..* | BackboneElement | Additional representations for this concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
use |  | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
filter | Σ C | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
property | Σ | 1..1 | code | A property/filter defined by the code system
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists
valueSet | Σ C | 0..* | canonical(ValueSet) | Select the contents included in this value set
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets
expansion | S | 1..1 | BackboneElement | Used when the value set is "expanded"
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier |  | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp |  | 1..1 | dateTime | Time ValueSet expansion happened
total |  | 0..1 | integer | Total number of codes in the expansion
offset |  | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
value[x] |  | 0..1 |  | Value of the named parameter
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueDecimal |  |  | decimal |
valueUri |  |  | uri |
valueCode |  |  | code |
valueDateTime |  |  | dateTime |
contains | S C | 0..* | BackboneElement | Codes in the value set
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system |  | 0..1 | uri | System value for the code
abstract |  | 0..1 | boolean | If user cannot select this entry
inactive |  | 0..1 | boolean | If concept is inactive in the code system
version |  | 0..1 | string | Version in which this code/display is defined
code | C | 0..1 | code | Code - if blank, this is not a selectable code
display | C | 0..1 | string | User display for the concept
designation |  | 0..* | See designation (ValueSet) | Additional representations for this item
contains |  | 0..* | See contains (ValueSet) | Codes contained under this entry
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ValueSet.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
ValueSet.status | required | PublicationStatus
ValueSet.useContext:priorityContext.code | extensible | Pattern: priority
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focus
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodes
ValueSet.jurisdiction | extensible | Jurisdiction ValueSet
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
ValueSet.compose.include.concept.designation.use | extensible | DesignationUse
ValueSet.compose.include.filter.op | required | FilterOperator

This structure is derived from USPublicHealthValueSet

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension

Differential View

This structure is derived from USPublicHealthValueSet

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet |  | 1..1 | USPublicHealthValueSet | A set of codes drawn from one or more code systems
extension |  | 3..* | Extension | Extension
usageWarning | S | 1..1 | string | US Public Health Usage Warning Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension
value[x] | S | 1..1 | string | Value 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 | S | 1..1 | BackboneElement | Used when the value set is "expanded"
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
contains | S | 0..* | BackboneElement | Codes in the value set
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | USPublicHealthValueSet | A set of codes drawn from one or more code systems
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension | S | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author
usageWarning | S | 1..1 | string | US Public Health Usage Warning Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension"
value[x] | S | 1..1 | string | Value 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.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Value set identifier used by public health
version | Σ | 1..1 | string | Business version of the value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | S Σ | 1..1 | string | Value set title
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
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
description |  | 1..1 | markdown | Natural language description of the value set
Slices for useContext | S Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code
useContext:priorityContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
code | S Σ | 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: priority
value[x] | S Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.
useContext:focusConditionContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
code | S Σ | 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://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus
value[x] | S Σ | 1..1 | CodeableConcept | Clinical condition that is the focus of the codes in this value set Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.
expansion | S | 1..1 | BackboneElement | Used when the value set is "expanded"
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
timestamp |  | 1..1 | dateTime | Time ValueSet expansion happened
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
contains | S C | 0..* | BackboneElement | Codes in the value set
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ValueSet.status | required | PublicationStatus
ValueSet.useContext:priorityContext.code | extensible | Pattern: priority
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focus
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodes

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | USPublicHealthValueSet | A set of codes drawn from one or more code systems
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension | S | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author
usageWarning | S | 1..1 | string | US Public Health Usage Warning Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension"
value[x] | S | 1..1 | string | Value 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.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Value set identifier used by public health
version | Σ | 1..1 | string | Business version of the value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | S Σ | 1..1 | string | Value set title
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
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description |  | 1..1 | markdown | Natural language description of the value set
Slices for useContext | S Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code
useContext:priorityContext | S Σ | 0..* | 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 | S Σ | 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: priority
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | S Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.
useContext:focusConditionContext | S Σ | 0..* | 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 | S Σ | 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://terminology.hl7.org/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: focus
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | S Σ | 1..1 | CodeableConcept | Clinical condition that is the focus of the codes in this value set Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur
purpose |  | 0..1 | markdown | Why this value set is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
compose |  | 0..1 | BackboneElement | Content logical definition of the value set (CLD)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive)
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | Σ C | 0..1 | uri | The system the codes come from
version | Σ | 0..1 | string | Specific version of the code system referred to
concept | C | 0..* | BackboneElement | A concept defined in the system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Code or expression from system
display |  | 0..1 | string | Text to display for this code for this value set in this valueset
designation |  | 0..* | BackboneElement | Additional representations for this concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
use |  | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
filter | Σ C | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
property | Σ | 1..1 | code | A property/filter defined by the code system
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists
valueSet | Σ C | 0..* | canonical(ValueSet) | Select the contents included in this value set
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets
expansion | S | 1..1 | BackboneElement | Used when the value set is "expanded"
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier |  | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp |  | 1..1 | dateTime | Time ValueSet expansion happened
total |  | 0..1 | integer | Total number of codes in the expansion
offset |  | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
value[x] |  | 0..1 |  | Value of the named parameter
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueDecimal |  |  | decimal |
valueUri |  |  | uri |
valueCode |  |  | code |
valueDateTime |  |  | dateTime |
contains | S C | 0..* | BackboneElement | Codes in the value set
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system |  | 0..1 | uri | System value for the code
abstract |  | 0..1 | boolean | If user cannot select this entry
inactive |  | 0..1 | boolean | If concept is inactive in the code system
version |  | 0..1 | string | Version in which this code/display is defined
code | C | 0..1 | code | Code - if blank, this is not a selectable code
display | C | 0..1 | string | User display for the concept
designation |  | 0..* | See designation (ValueSet) | Additional representations for this item
contains |  | 0..* | See contains (ValueSet) | Codes contained under this entry
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ValueSet.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
ValueSet.status | required | PublicationStatus
ValueSet.useContext:priorityContext.code | extensible | Pattern: priority
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focus
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodes
ValueSet.jurisdiction | extensible | Jurisdiction ValueSet
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
ValueSet.compose.include.concept.designation.use | extensible | DesignationUse
ValueSet.compose.include.filter.op | required | FilterOperator

This structure is derived from USPublicHealthValueSet

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-usagewarning-extension

Other representations of profile: CSV, Excel, Schematron