US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.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
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-triggering-valueset | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthTriggeringValueSet | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.63 | ||||
This ValueSet profile describes the requirements for a value set that is part of determination of a potentially reportable event (i.e. a "triggering" event).
It is based on the US Public Health ValueSet and SHALL have a useContext type of triggering.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ValueSet |
C | 1..1 | USPublicHealthValueSet(2.0.0) | US Public Health Triggering ValueSet Constraints: vsd-0 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
   extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 |
| extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 |
| extension:authoritativeSource |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource Constraints: ext-1 |
 extension:extensionValueSetAuthor |
S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/artifact-author Constraints: ext-1 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
SΣ | 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 |
SΣ | 1..1 | string | Business version of the value set |
| name |
SΣC | 0..1 | string | Name for this value set (computer friendly) |
| title |
SΣ | 1..1 | string | Name for this value set (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the value set |
  Slices for useContext |
SΣ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value: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 |
 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: USPublicHealthValueSetPriority (2.0.0) (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 |
| 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. |
 useContext:reportingContext |
SΣ | 1..1 | UsageContext | The context that the content is intended to support |
| code |
Σ | 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: reporting | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 value[x] |
Σ | 1..1 | CodeableConcept | value 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 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.value[x] | Base | required | US Public Health ValueSet Priority | 📍2.0.0 | This IG |
| ValueSet.useContext:focusConditionContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:focusConditionContext.value[x] | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ValueSet | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ValueSet.implicitRules, ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension, ValueSet.url, ValueSet.identifier, ValueSet.version, ValueSet.name, ValueSet.title, ValueSet.status, ValueSet.experimental, ValueSet.publisher, ValueSet.description, ValueSet.useContext, ValueSet.useContext:priorityContext, ValueSet.useContext:priorityContext.code, ValueSet.useContext:priorityContext.value[x], ValueSet.useContext:focusConditionContext, ValueSet.useContext:focusConditionContext.code, ValueSet.useContext:focusConditionContext.value[x], ValueSet.useContext:reportingContext, ValueSet.useContext:reportingContext.code, ValueSet.useContext:reportingContext.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| vsd-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ValueSet |
1..1 | USPublicHealthValueSet(2.0.0) | US Public Health Triggering ValueSet | |
 useContext |
2..* | UsageContext | The context that the content is intended to support | |
| Slices for useContext |
Content/Rules for all slices | |||
| useContext:reportingContext |
1..1 | UsageContext | The context that the content is intended to support | |
| code |
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: reporting | |
| value[x] |
1..1 | CodeableConcept | value set useContext Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet |
C | 1..1 | USPublicHealthValueSet(2.0.0) | US Public Health Triggering ValueSet Constraints: vsd-0 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 | ||||
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | ||||
| extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 | ||||
| extension:authoritativeSource |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource Constraints: ext-1 | ||||
| extension:extensionValueSetAuthor |
S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/artifact-author Constraints: ext-1 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
SΣ | 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 |
SΣ | 1..1 | string | Business version of the value set | ||||
| name |
SΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this value set (human friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 1..1 | markdown | Natural language description of the value set | ||||
| Slices for useContext |
SΣ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value: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 Constraints: ext-1 | |||||
| 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: USPublicHealthValueSetPriority (2.0.0) (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 Constraints: ext-1 | |||||
| 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. | ||||
| useContext:reportingContext |
SΣ | 1..1 | 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 Constraints: ext-1 | |||||
| code |
Σ | 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: reporting | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] |
Σ | 1..1 | CodeableConcept | value 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| 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 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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) Constraints: vsd-1, vsd-2, vsd-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: vsd-6, vsd-9, vsd-10 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ValueSet.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.value[x] | Base | required | US Public Health ValueSet Priority | 📍2.0.0 | This IG |
| ValueSet.useContext:focusConditionContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:focusConditionContext.value[x] | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ValueSet.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ValueSet.compose.include.concept.designation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ValueSet.compose.include.concept.designation.use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std. |
| ValueSet.compose.include.filter.op | Base | required | FilterOperator | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ValueSet | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ValueSet.meta, ValueSet.implicitRules, ValueSet.language, ValueSet.text, ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension, ValueSet.url, ValueSet.identifier, ValueSet.version, ValueSet.name, ValueSet.title, ValueSet.status, ValueSet.experimental, ValueSet.date, ValueSet.publisher, ValueSet.contact, ValueSet.description, ValueSet.useContext, ValueSet.useContext:priorityContext, ValueSet.useContext:priorityContext.extension, ValueSet.useContext:priorityContext.code, ValueSet.useContext:priorityContext.value[x], ValueSet.useContext:focusConditionContext, ValueSet.useContext:focusConditionContext.extension, ValueSet.useContext:focusConditionContext.code, ValueSet.useContext:focusConditionContext.value[x], ValueSet.useContext:reportingContext, ValueSet.useContext:reportingContext.extension, ValueSet.useContext:reportingContext.code, ValueSet.useContext:reportingContext.value[x], ValueSet.jurisdiction, ValueSet.immutable, ValueSet.purpose, ValueSet.copyright, ValueSet.compose, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.lockedDate, ValueSet.compose.inactive, ValueSet.compose.include, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.system, ValueSet.compose.include.version, ValueSet.compose.include.concept, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.code, ValueSet.compose.include.concept.display, ValueSet.compose.include.concept.designation, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.concept.designation.language, ValueSet.compose.include.concept.designation.use, ValueSet.compose.include.concept.designation.value, ValueSet.compose.include.filter, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.compose.include.filter.property, ValueSet.compose.include.filter.op, ValueSet.compose.include.filter.value, ValueSet.compose.include.valueSet, ValueSet.compose.exclude, ValueSet.expansion, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.identifier, ValueSet.expansion.timestamp, ValueSet.expansion.total, ValueSet.expansion.offset, ValueSet.expansion.parameter, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.parameter.name, ValueSet.expansion.parameter.value[x], ValueSet.expansion.contains, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension, ValueSet.expansion.contains.system, ValueSet.expansion.contains.abstract, ValueSet.expansion.contains.inactive, ValueSet.expansion.contains.version, ValueSet.expansion.contains.code, ValueSet.expansion.contains.display, ValueSet.expansion.contains.designation, ValueSet.expansion.contains.contains | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension, ValueSet.useContext:priorityContext.extension, ValueSet.useContext:focusConditionContext.extension, ValueSet.useContext:reportingContext.extension, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| vsd-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system |
valueSet.exists() or system.exists()
|
| vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system |
(concept.exists() or filter.exists()) implies system.exists()
|
| vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter |
concept.empty() or filter.empty()
|
| vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display |
code.exists() or display.exists()
|
| vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract |
code.exists() or abstract = true
|
| vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present |
code.empty() or system.exists()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ValueSet |
C | 1..1 | USPublicHealthValueSet(2.0.0) | US Public Health Triggering ValueSet Constraints: vsd-0 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 |
| extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 |
| extension:authoritativeSource |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource Constraints: ext-1 |
| extension:extensionValueSetAuthor |
S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/artifact-author Constraints: ext-1 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
SΣ | 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 |
SΣ | 1..1 | string | Business version of the value set |
| name |
SΣC | 0..1 | string | Name for this value set (computer friendly) |
| title |
SΣ | 1..1 | string | Name for this value set (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the value set |
| Slices for useContext |
SΣ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value: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 |
| 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: USPublicHealthValueSetPriority (2.0.0) (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 |
| 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. |
| useContext:reportingContext |
SΣ | 1..1 | UsageContext | The context that the content is intended to support |
| code |
Σ | 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: reporting | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| value[x] |
Σ | 1..1 | CodeableConcept | value 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 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.value[x] | Base | required | US Public Health ValueSet Priority | 📍2.0.0 | This IG |
| ValueSet.useContext:focusConditionContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:focusConditionContext.value[x] | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ValueSet | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ValueSet.implicitRules, ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension, ValueSet.url, ValueSet.identifier, ValueSet.version, ValueSet.name, ValueSet.title, ValueSet.status, ValueSet.experimental, ValueSet.publisher, ValueSet.description, ValueSet.useContext, ValueSet.useContext:priorityContext, ValueSet.useContext:priorityContext.code, ValueSet.useContext:priorityContext.value[x], ValueSet.useContext:focusConditionContext, ValueSet.useContext:focusConditionContext.code, ValueSet.useContext:focusConditionContext.value[x], ValueSet.useContext:reportingContext, ValueSet.useContext:reportingContext.code, ValueSet.useContext:reportingContext.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| vsd-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ValueSet |
1..1 | USPublicHealthValueSet(2.0.0) | US Public Health Triggering ValueSet | |
| useContext |
2..* | UsageContext | The context that the content is intended to support | |
| Slices for useContext |
Content/Rules for all slices | |||
| useContext:reportingContext |
1..1 | UsageContext | The context that the content is intended to support | |
| code |
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: reporting | |
| value[x] |
1..1 | CodeableConcept | value set useContext Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet |
C | 1..1 | USPublicHealthValueSet(2.0.0) | US Public Health Triggering ValueSet Constraints: vsd-0 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 | ||||
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | ||||
| extension:versionPolicy |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 | ||||
| extension:authoritativeSource |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource Constraints: ext-1 | ||||
| extension:extensionValueSetAuthor |
S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/artifact-author Constraints: ext-1 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
SΣ | 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 |
SΣ | 1..1 | string | Business version of the value set | ||||
| name |
SΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this value set (human friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 1..1 | markdown | Natural language description of the value set | ||||
| Slices for useContext |
SΣ | 2..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value: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 Constraints: ext-1 | |||||
| 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: USPublicHealthValueSetPriority (2.0.0) (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 Constraints: ext-1 | |||||
| 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. | ||||
| useContext:reportingContext |
SΣ | 1..1 | 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 Constraints: ext-1 | |||||
| code |
Σ | 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: reporting | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] |
Σ | 1..1 | CodeableConcept | value 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| 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 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: triggering | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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) Constraints: vsd-1, vsd-2, vsd-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: vsd-6, vsd-9, vsd-10 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ValueSet.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:priorityContext.value[x] | Base | required | US Public Health ValueSet Priority | 📍2.0.0 | This IG |
| ValueSet.useContext:focusConditionContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:focusConditionContext.value[x] | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.code | Base | extensible | UsageContextType | 📍4.0.1 | FHIR Std. |
| ValueSet.useContext:reportingContext.value[x] | Base | example | ConformanceUseContext | 📍4.0.1 | FHIR Std. |
| ValueSet.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ValueSet.compose.include.concept.designation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ValueSet.compose.include.concept.designation.use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std. |
| ValueSet.compose.include.filter.op | Base | required | FilterOperator | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ValueSet | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ValueSet.meta, ValueSet.implicitRules, ValueSet.language, ValueSet.text, ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension, ValueSet.url, ValueSet.identifier, ValueSet.version, ValueSet.name, ValueSet.title, ValueSet.status, ValueSet.experimental, ValueSet.date, ValueSet.publisher, ValueSet.contact, ValueSet.description, ValueSet.useContext, ValueSet.useContext:priorityContext, ValueSet.useContext:priorityContext.extension, ValueSet.useContext:priorityContext.code, ValueSet.useContext:priorityContext.value[x], ValueSet.useContext:focusConditionContext, ValueSet.useContext:focusConditionContext.extension, ValueSet.useContext:focusConditionContext.code, ValueSet.useContext:focusConditionContext.value[x], ValueSet.useContext:reportingContext, ValueSet.useContext:reportingContext.extension, ValueSet.useContext:reportingContext.code, ValueSet.useContext:reportingContext.value[x], ValueSet.jurisdiction, ValueSet.immutable, ValueSet.purpose, ValueSet.copyright, ValueSet.compose, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.lockedDate, ValueSet.compose.inactive, ValueSet.compose.include, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.system, ValueSet.compose.include.version, ValueSet.compose.include.concept, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.code, ValueSet.compose.include.concept.display, ValueSet.compose.include.concept.designation, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.concept.designation.language, ValueSet.compose.include.concept.designation.use, ValueSet.compose.include.concept.designation.value, ValueSet.compose.include.filter, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.compose.include.filter.property, ValueSet.compose.include.filter.op, ValueSet.compose.include.filter.value, ValueSet.compose.include.valueSet, ValueSet.compose.exclude, ValueSet.expansion, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.identifier, ValueSet.expansion.timestamp, ValueSet.expansion.total, ValueSet.expansion.offset, ValueSet.expansion.parameter, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.parameter.name, ValueSet.expansion.parameter.value[x], ValueSet.expansion.contains, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension, ValueSet.expansion.contains.system, ValueSet.expansion.contains.abstract, ValueSet.expansion.contains.inactive, ValueSet.expansion.contains.version, ValueSet.expansion.contains.code, ValueSet.expansion.contains.display, ValueSet.expansion.contains.designation, ValueSet.expansion.contains.contains | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.extension, ValueSet.extension:knowledgeCapability, ValueSet.extension:versionAlgorithm, ValueSet.extension:versionPolicy, ValueSet.extension:authoritativeSource, ValueSet.extension:extensionValueSetAuthor, ValueSet.modifierExtension, ValueSet.useContext:priorityContext.extension, ValueSet.useContext:focusConditionContext.extension, ValueSet.useContext:reportingContext.extension, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| vsd-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system |
valueSet.exists() or system.exists()
|
| vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system |
(concept.exists() or filter.exists()) implies system.exists()
|
| vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter |
concept.empty() or filter.empty()
|
| vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display |
code.exists() or display.exists()
|
| vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract |
code.exists() or abstract = true
|
| vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present |
code.empty() or system.exists()
|
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ph-library#2.0.0 based on FHIR 4.0.1.
Generated 2025-10-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
