This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset | Version: 2.1.2 | |||
Active as of 2024-10-30 | Computable Name: USPublicHealthValueSet | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.81 |
This profile describes US Public Health value sets.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 1..1 | Shareable ValueSet | US Public Health ValueSet | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
identifier | S | 0..* | Identifier | Value set identifier used by public health (e.g. RCTC OID) |
name | S | 1..1 | string | Value set name |
title | S | 1..1 | string | Value set title |
status | S | 1..1 | code | Value set definition version |
publisher | S | 1..1 | string | The entity that is responsible for the content of the Value Set Definition |
description | S | 1..1 | markdown | Value set description |
Slices for useContext | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | |
useContext:priorityContext | 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/ecr/CodeSystem/us-ph-usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
value[x] | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes. | |
useContext:focusConditionContext | S | 0..* | UsageContext | The context that the content is intended to support |
code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
value[x] | 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. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriorityhttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-valueset-priority from this IG | |
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | C | 1..1 | Shareable ValueSet | US Public Health ValueSet vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Value set identifier used by public health (e.g. RCTC OID) |
version | Σ | 1..1 | string | Business version of the value set |
name | SΣC | 1..1 | string | Value set name |
title | SΣ | 1..1 | string | Value set title |
status | ?!SΣ | 1..1 | code | Value set definition version Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
publisher | SΣ | 1..1 | string | The entity that is responsible for the content of the Value Set Definition |
description | S | 1..1 | markdown | Value set description |
Slices for useContext | Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code |
useContext:priorityContext | Σ | 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 |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
value[x] | Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes. |
useContext:focusConditionContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
value[x] | Σ | 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. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
ValueSet.useContext:priorityContext.code | extensible | Pattern: priorityhttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | |
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriorityhttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-valueset-priority from this IG | |
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | |
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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 | ||||
---|---|---|---|---|---|---|---|---|
ValueSet | C | 1..1 | Shareable ValueSet | US Public Health ValueSet vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward | ||||
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
identifier | SΣ | 0..* | Identifier | Value set identifier used by public health (e.g. RCTC OID) | ||||
version | Σ | 1..1 | string | Business version of the value set | ||||
name | SΣC | 1..1 | string | Value set name | ||||
title | SΣ | 1..1 | string | Value set title | ||||
status | ?!SΣ | 1..1 | code | Value set definition version Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | SΣ | 1..1 | string | The entity that is responsible for the content of the Value Set Definition | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | S | 1..1 | markdown | Value set description | ||||
Slices for useContext | Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | ||||
useContext:priorityContext | Σ | 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 | |||||
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/ecr/CodeSystem/us-ph-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] | Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes. | ||||
useContext:focusConditionContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
code | Σ | 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] | Σ | 1..1 | CodeableConcept | Clinical condition that is the focus of the codes in this value set Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
purpose | 0..1 | markdown | Why this value set is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
compose | 0..1 | BackboneElement | Content logical definition of the value set (CLD) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
include | ΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
system | ΣC | 0..1 | uri | The system the codes come from | ||||
version | Σ | 0..1 | string | Specific version of the code system referred to | ||||
concept | C | 0..* | BackboneElement | A concept defined in the system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Code or expression from system | |||||
display | 0..1 | string | Text to display for this code for this value set in this valueset | |||||
designation | 0..* | BackboneElement | Additional representations for this concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
use | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
value | 1..1 | string | The text value for this designation | |||||
filter | ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
property | Σ | 1..1 | code | A property/filter defined by the code system | ||||
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
valueSet | ΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |||||
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |||||
total | 0..1 | integer | Total number of codes in the expansion | |||||
offset | 0..1 | integer | Offset at which this resource starts | |||||
parameter | 0..* | BackboneElement | Parameter that controlled the expansion process | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | 1..1 | string | Name as assigned by the client or server | |||||
value[x] | 0..1 | Value of the named parameter | ||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueDecimal | decimal | |||||||
valueUri | uri | |||||||
valueCode | code | |||||||
valueDateTime | dateTime | |||||||
contains | C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
system | 0..1 | uri | System value for the code | |||||
abstract | 0..1 | boolean | If user cannot select this entry | |||||
inactive | 0..1 | boolean | If concept is inactive in the code system | |||||
version | 0..1 | string | Version in which this code/display is defined | |||||
code | C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
display | C | 0..1 | string | User display for the concept | ||||
designation | 0..* | See designation (ValueSet) | Additional representations for this item | |||||
contains | 0..* | See contains (ValueSet) | Codes contained under this entry | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ValueSet.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
ValueSet.useContext:priorityContext.code | extensible | Pattern: priorityhttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | ||||
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriorityhttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-valueset-priority from this IG | ||||
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | ||||
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
ValueSet.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | ||||
ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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() |
This structure is derived from Shareable ValueSet
Summary
Mandatory: 10 elements
Must-Support: 9 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Shareable ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 1..1 | Shareable ValueSet | US Public Health ValueSet | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
identifier | S | 0..* | Identifier | Value set identifier used by public health (e.g. RCTC OID) |
name | S | 1..1 | string | Value set name |
title | S | 1..1 | string | Value set title |
status | S | 1..1 | code | Value set definition version |
publisher | S | 1..1 | string | The entity that is responsible for the content of the Value Set Definition |
description | S | 1..1 | markdown | Value set description |
Slices for useContext | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | |
useContext:priorityContext | 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/ecr/CodeSystem/us-ph-usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
value[x] | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes. | |
useContext:focusConditionContext | S | 0..* | UsageContext | The context that the content is intended to support |
code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
value[x] | 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. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriorityhttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-valueset-priority from this IG | |
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | C | 1..1 | Shareable ValueSet | US Public Health ValueSet vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Value set identifier used by public health (e.g. RCTC OID) |
version | Σ | 1..1 | string | Business version of the value set |
name | SΣC | 1..1 | string | Value set name |
title | SΣ | 1..1 | string | Value set title |
status | ?!SΣ | 1..1 | code | Value set definition version Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
publisher | SΣ | 1..1 | string | The entity that is responsible for the content of the Value Set Definition |
description | S | 1..1 | markdown | Value set description |
Slices for useContext | Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code |
useContext:priorityContext | Σ | 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 |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
value[x] | Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes. |
useContext:focusConditionContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
value[x] | Σ | 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. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
ValueSet.useContext:priorityContext.code | extensible | Pattern: priorityhttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | |
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriorityhttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-valueset-priority from this IG | |
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | |
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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}') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ValueSet | C | 1..1 | Shareable ValueSet | US Public Health ValueSet vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extensionValueSetSteward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward | ||||
extensionValueSetAuthor | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
identifier | SΣ | 0..* | Identifier | Value set identifier used by public health (e.g. RCTC OID) | ||||
version | Σ | 1..1 | string | Business version of the value set | ||||
name | SΣC | 1..1 | string | Value set name | ||||
title | SΣ | 1..1 | string | Value set title | ||||
status | ?!SΣ | 1..1 | code | Value set definition version Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | SΣ | 1..1 | string | The entity that is responsible for the content of the Value Set Definition | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | S | 1..1 | markdown | Value set description | ||||
Slices for useContext | Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | ||||
useContext:priorityContext | Σ | 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 | |||||
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/ecr/CodeSystem/us-ph-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] | Σ | 1..1 | CodeableConcept | Release priority of the ValueSet Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes. | ||||
useContext:focusConditionContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
code | Σ | 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] | Σ | 1..1 | CodeableConcept | Clinical condition that is the focus of the codes in this value set Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
purpose | 0..1 | markdown | Why this value set is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
compose | 0..1 | BackboneElement | Content logical definition of the value set (CLD) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
include | ΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
system | ΣC | 0..1 | uri | The system the codes come from | ||||
version | Σ | 0..1 | string | Specific version of the code system referred to | ||||
concept | C | 0..* | BackboneElement | A concept defined in the system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Code or expression from system | |||||
display | 0..1 | string | Text to display for this code for this value set in this valueset | |||||
designation | 0..* | BackboneElement | Additional representations for this concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
use | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
value | 1..1 | string | The text value for this designation | |||||
filter | ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
property | Σ | 1..1 | code | A property/filter defined by the code system | ||||
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
valueSet | ΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |||||
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |||||
total | 0..1 | integer | Total number of codes in the expansion | |||||
offset | 0..1 | integer | Offset at which this resource starts | |||||
parameter | 0..* | BackboneElement | Parameter that controlled the expansion process | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | 1..1 | string | Name as assigned by the client or server | |||||
value[x] | 0..1 | Value of the named parameter | ||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueDecimal | decimal | |||||||
valueUri | uri | |||||||
valueCode | code | |||||||
valueDateTime | dateTime | |||||||
contains | C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
system | 0..1 | uri | System value for the code | |||||
abstract | 0..1 | boolean | If user cannot select this entry | |||||
inactive | 0..1 | boolean | If concept is inactive in the code system | |||||
version | 0..1 | string | Version in which this code/display is defined | |||||
code | C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
display | C | 0..1 | string | User display for the concept | ||||
designation | 0..* | See designation (ValueSet) | Additional representations for this item | |||||
contains | 0..* | See contains (ValueSet) | Codes contained under this entry | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ValueSet.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
ValueSet.useContext:priorityContext.code | extensible | Pattern: priorityhttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | ||||
ValueSet.useContext:priorityContext.value[x] | required | USPublicHealthValueSetPriorityhttp://hl7.org/fhir/us/ecr/ValueSet/us-ph-valueset-priority from this IG | ||||
ValueSet.useContext:focusConditionContext.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-type from the FHIR Standard | ||||
ValueSet.useContext:focusConditionContext.value[x] | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
ValueSet.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | ||||
ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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() |
This structure is derived from Shareable ValueSet
Summary
Mandatory: 10 elements
Must-Support: 9 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron