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

US Public Health Profiles Library, published by HL7 Public Health Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health ValueSet

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-valueset Version: 1.0.0
Active as of 2024-08-13 Computable Name: USPublicHealthValueSet

This ValueSet profile describes the minimum requirements for US public health value sets.

It is based on the FHIR ShareableValueSet profile and futher constrains it as follows:

  • adds the base FHIR extension for the ValueSet steward
  • adds the base FHIR extension for for the ValueSet author
  • adds must support identifier
  • adds required title
  • adds slices for useContext
    • required slice for priority (emergent, routine)
    • optional slice for the clinical condition that is the focus of the codes in the value set

Usage:

Formal Views of Profile Content

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

This structure is derived from Shareable ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1 Shareable ValueSet A set of codes drawn from one or more code systems
... Slices for extension S 2..* 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
... identifier S 0..* Identifier Value set identifier used by public health
... title S 1..1 string Value set title
.... useContext:priorityContext S 0..* UsageContext The context that the content is intended to support
..... code S 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 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
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.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-priority
from this IG
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 1..1 Shareable ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 2..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-priority
from this IG
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 1..1 Shareable ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 2..* 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
... 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)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... 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 BindingsPurpose
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 0..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 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 C 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-priority
from this IG
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

This structure is derived from Shareable ValueSet

Summary

Mandatory: 4 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ValueSet.useContext

Differential View

This structure is derived from Shareable ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1 Shareable ValueSet A set of codes drawn from one or more code systems
... Slices for extension S 2..* 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
... identifier S 0..* Identifier Value set identifier used by public health
... title S 1..1 string Value set title
.... useContext:priorityContext S 0..* UsageContext The context that the content is intended to support
..... code S 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 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
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.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-priority
from this IG
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 1..1 Shareable ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 2..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-priority
from this IG
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 1..1 Shareable ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 2..* 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
... 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)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... 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 BindingsPurpose
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 0..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 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 C 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-priority
from this IG
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

This structure is derived from Shareable ValueSet

Summary

Mandatory: 4 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ValueSet.useContext

 

Other representations of profile: CSV, Excel, Schematron