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

This page is part of the US Public Health Profiles Library (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Supplemental ValueSet

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-supplemental-valueset Version: 1.0.0
Active as of 2023-08-17 Computable Name: USPublicHealthSupplementalValueSet

This ValueSet profile describes the requirements for a value set used when determining whether an event is suspected to be reportable.

It is based on the US Public Health ValueSet and SHALL have a useContext type of supplemental.

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
... Slices for useContext 2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:reportingContext S1..1UsageContextThe context that the content is intended to support
..... code S1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] S1..1CodeableConceptvalue set 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/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C1..1USPublicHealthValueSetA set of codes drawn from one or more code systems
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extensionValueSetSteward S1..1ContactDetailValue set steward
URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierValue set identifier used by public health
... version Σ1..1stringBusiness version of the value set
... name ΣC1..1stringName for this value set (computer friendly)
... title SΣ1..1stringValue set title
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... publisher Σ1..1stringName of the publisher (organization or individual)
... description 1..1markdownNatural language description of the value set
... Slices for useContext SΣ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:priorityContext SΣ0..*UsageContextThe context that the content is intended to support
..... code SΣ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
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
..... value[x] SΣ1..1CodeableConceptRelease priority of the ValueSet
Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.

.... useContext:focusConditionContext SΣ0..*UsageContextThe context that the content is intended to support
..... code SΣ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
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... value[x] SΣ1..1CodeableConceptClinical condition that is the focus of the codes in this value set
Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.

.... useContext:reportingContext SΣ1..1UsageContextThe context that the content is intended to support
..... code SΣ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
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] SΣ1..1CodeableConceptvalue set 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ValueSet.statusrequiredPublicationStatus
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
ValueSet.useContext:reportingContext.codeextensiblePattern: reporting
ValueSet.useContext:reportingContext.value[x]examplePattern: supplemental
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C1..1USPublicHealthValueSetA set of codes drawn from one or more code systems
... id Σ0..1idLogical 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 S2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extensionValueSetSteward S1..1ContactDetailValue set steward
URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
... extensionValueSetAuthor S1..1ContactDetailValue set author
URL: http://hl7.org/fhir/StructureDefinition/valueset-author
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierValue set identifier used by public health
... version Σ1..1stringBusiness version of the value set
... name ΣC1..1stringName for this value set (computer friendly)
... title SΣ1..1stringValue set title
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the value set
... Slices for useContext SΣ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:priorityContext SΣ0..*UsageContextThe 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 SΣ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/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptRelease priority of the ValueSet
Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.

.... useContext:focusConditionContext SΣ0..*UsageContextThe 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 SΣ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://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptClinical condition that is the focus of the codes in this value set
Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.

.... 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 SΣ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/ph-library/CodeSystem/us-ph-codesystem-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] SΣ1..1CodeableConceptvalue set 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/ph-library/CodeSystem/us-ph-codesystem-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
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... compose 0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lockedDate Σ0..1dateFixed date for references with no specified version (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣC1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system ΣC0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept C0..*BackboneElementA concept defined in the system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation 0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
....... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... value 1..1stringThe text value for this designation
..... filter ΣC0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property Σ1..1codeA property/filter defined by the code system
...... op Σ1..1code= | 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..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC0..*canonical(ValueSet)Select the contents included in this value set
.... exclude C0..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1uriIdentifies the value set expansion (business identifier)
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... contains C0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code C0..1codeCode - if blank, this is not a selectable code
..... display C0..1stringUser 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 / Code
ValueSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.statusrequiredPublicationStatus
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
ValueSet.useContext:reportingContext.codeextensiblePattern: reporting
ValueSet.useContext:reportingContext.value[x]examplePattern: supplemental
ValueSet.jurisdictionextensibleJurisdiction ValueSet
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
ValueSet.compose.include.filter.oprequiredFilterOperator

This structure is derived from USPublicHealthValueSet

Summary

Mandatory: 1 element
Must-Support: 3 elements

Slices

This structure defines the following Slices:

  • The element ValueSet.useContext is sliced based on the value of pattern:code (Closed)

Differential View

This structure is derived from USPublicHealthValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1USPublicHealthValueSetA set of codes drawn from one or more code systems
... Slices for useContext 2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:reportingContext S1..1UsageContextThe context that the content is intended to support
..... code S1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] S1..1CodeableConceptvalue set 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/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C1..1USPublicHealthValueSetA set of codes drawn from one or more code systems
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extensionValueSetSteward S1..1ContactDetailValue set steward
URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierValue set identifier used by public health
... version Σ1..1stringBusiness version of the value set
... name ΣC1..1stringName for this value set (computer friendly)
... title SΣ1..1stringValue set title
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... publisher Σ1..1stringName of the publisher (organization or individual)
... description 1..1markdownNatural language description of the value set
... Slices for useContext SΣ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:priorityContext SΣ0..*UsageContextThe context that the content is intended to support
..... code SΣ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
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
..... value[x] SΣ1..1CodeableConceptRelease priority of the ValueSet
Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.

.... useContext:focusConditionContext SΣ0..*UsageContextThe context that the content is intended to support
..... code SΣ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
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... value[x] SΣ1..1CodeableConceptClinical condition that is the focus of the codes in this value set
Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.

.... useContext:reportingContext SΣ1..1UsageContextThe context that the content is intended to support
..... code SΣ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
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] SΣ1..1CodeableConceptvalue set 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ValueSet.statusrequiredPublicationStatus
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
ValueSet.useContext:reportingContext.codeextensiblePattern: reporting
ValueSet.useContext:reportingContext.value[x]examplePattern: supplemental

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C1..1USPublicHealthValueSetA set of codes drawn from one or more code systems
... id Σ0..1idLogical 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 S2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extensionValueSetSteward S1..1ContactDetailValue set steward
URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
... extensionValueSetAuthor S1..1ContactDetailValue set author
URL: http://hl7.org/fhir/StructureDefinition/valueset-author
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierValue set identifier used by public health
... version Σ1..1stringBusiness version of the value set
... name ΣC1..1stringName for this value set (computer friendly)
... title SΣ1..1stringValue set title
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the value set
... Slices for useContext SΣ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:priorityContext SΣ0..*UsageContextThe 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 SΣ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/ph-library/CodeSystem/us-ph-codesystem-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptRelease priority of the ValueSet
Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.

.... useContext:focusConditionContext SΣ0..*UsageContextThe 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 SΣ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://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptClinical condition that is the focus of the codes in this value set
Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.

.... 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 SΣ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/ph-library/CodeSystem/us-ph-codesystem-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] SΣ1..1CodeableConceptvalue set 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/ph-library/CodeSystem/us-ph-codesystem-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
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... compose 0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lockedDate Σ0..1dateFixed date for references with no specified version (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣC1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system ΣC0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept C0..*BackboneElementA concept defined in the system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation 0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
....... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... value 1..1stringThe text value for this designation
..... filter ΣC0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property Σ1..1codeA property/filter defined by the code system
...... op Σ1..1code= | 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..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC0..*canonical(ValueSet)Select the contents included in this value set
.... exclude C0..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1uriIdentifies the value set expansion (business identifier)
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... contains C0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code C0..1codeCode - if blank, this is not a selectable code
..... display C0..1stringUser 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 / Code
ValueSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.statusrequiredPublicationStatus
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
ValueSet.useContext:reportingContext.codeextensiblePattern: reporting
ValueSet.useContext:reportingContext.value[x]examplePattern: supplemental
ValueSet.jurisdictionextensibleJurisdiction ValueSet
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
ValueSet.compose.include.filter.oprequiredFilterOperator

This structure is derived from USPublicHealthValueSet

Summary

Mandatory: 1 element
Must-Support: 3 elements

Slices

This structure defines the following Slices:

  • The element ValueSet.useContext is sliced based on the value of pattern:code (Closed)

 

Other representations of profile: CSV, Excel, Schematron