HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2 US

This page is part of the electronic Case Reporting (eCR) (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Supplemental Value Set

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-supplemental-valueset Version: 2.1.0
Active as of 2022-08-31 Computable Name: USPublicHealthSupplementalValueSet

This profile describes the US Public Health Supplemental value set.

Usage:

Formal Views of Profile Content

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

This structure is derived from USPublicHealthValueSet

Summary

Mandatory: 3 elements
Must-Support: 1 element

Slices

This structure defines the following Slices:

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

This structure is derived from USPublicHealthValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1USPublicHealthValueSetUS Public Health Supplemental ValueSet
... Slices for useContext 2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:reportingContext 1..1UsageContextThe context that the content is intended to support
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] S1..1CodeableConceptvalue set useContext
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I1..1USPublicHealthValueSetUS Public Health Supplemental ValueSet
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extensionValueSetSteward S1..1ContactDetailValue set steward
URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
... extensionValueSetAuthor S1..1ContactDetailValue set author
URL: http://hl7.org/fhir/StructureDefinition/valueset-author
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierValue set identifier used by public health (e.g. RCTC OID)
... version Σ1..1stringBusiness version of the value set
... name SΣI1..1stringValue set name
... title SΣ1..1stringValue set title
... status ?!SΣ1..1codeValue set definition version
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher SΣ1..1stringThe entity that is responsible for the content of the Value Set Definition
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownValue set description
... Slices for useContext Σ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:priorityContext Σ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptRelease priority of the ValueSet
Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.

.... useContext:focusConditionContext SΣ0..*UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptClinical condition that is the focus of the codes in this value set
Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.

.... useContext:reportingContext Σ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptvalue set useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


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

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

....... value 1..1stringThe text value for this designation
..... filter ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property Σ1..1codeA property/filter defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude I0..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1uriIdentifies the value set expansion (business identifier)
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... contains I0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation 0..*See designation (ValueSet)Additional representations for this item
..... contains 0..*See contains (ValueSet)Codes contained under this entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I1..1USPublicHealthValueSetUS Public Health Supplemental ValueSet
... extensionValueSetSteward 1..1ContactDetailValue set steward
URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
... extensionValueSetAuthor 1..1ContactDetailValue set author
URL: http://hl7.org/fhir/StructureDefinition/valueset-author
... identifier Σ0..*IdentifierValue set identifier used by public health (e.g. RCTC OID)
... title Σ1..1stringValue set title
... status ?!Σ1..1codeValue set definition version
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... publisher Σ1..1stringThe entity that is responsible for the content of the Value Set Definition
... description 1..1markdownValue set description
... useContext:focusConditionContext Σ0..*UsageContextThe context that the content is intended to support
... useContext:reportingContext Σ1..1UsageContextThe context that the content is intended to support
.... value[x] Σ1..1CodeableConceptvalue set useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.


Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental

doco Documentation for this format

This structure is derived from USPublicHealthValueSet

Summary

Mandatory: 3 elements
Must-Support: 1 element

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from USPublicHealthValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1USPublicHealthValueSetUS Public Health Supplemental ValueSet
... Slices for useContext 2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:reportingContext 1..1UsageContextThe context that the content is intended to support
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
..... value[x] S1..1CodeableConceptvalue set useContext
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I1..1USPublicHealthValueSetUS Public Health Supplemental ValueSet
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extensionValueSetSteward S1..1ContactDetailValue set steward
URL: http://hl7.org/fhir/StructureDefinition/valueset-steward
... extensionValueSetAuthor S1..1ContactDetailValue set author
URL: http://hl7.org/fhir/StructureDefinition/valueset-author
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierValue set identifier used by public health (e.g. RCTC OID)
... version Σ1..1stringBusiness version of the value set
... name SΣI1..1stringValue set name
... title SΣ1..1stringValue set title
... status ?!SΣ1..1codeValue set definition version
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher SΣ1..1stringThe entity that is responsible for the content of the Value Set Definition
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownValue set description
... Slices for useContext Σ2..*UsageContextThe context that the content is intended to support
Slice: Unordered, Closed by pattern:code
.... useContext:priorityContext Σ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptRelease priority of the ValueSet
Binding: US Public Health ValueSet Priority (required): US PH ValueSet Release Priority Codes.

.... useContext:focusConditionContext SΣ0..*UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptClinical condition that is the focus of the codes in this value set
Binding: Condition/Problem/DiagnosisCodes (example): Condition/Problem/Diagnosis Codes.

.... useContext:reportingContext Σ1..1UsageContextThe context that the content is intended to support
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: reporting
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] SΣ1..1CodeableConceptvalue set useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: supplemental
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


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

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

....... value 1..1stringThe text value for this designation
..... filter ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property Σ1..1codeA property/filter defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude I0..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1uriIdentifies the value set expansion (business identifier)
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... contains I0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation 0..*See designation (ValueSet)Additional representations for this item
..... contains 0..*See contains (ValueSet)Codes contained under this entry

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ValueSet.languagepreferredCommonLanguages
Max Binding: AllLanguages
ValueSet.statusrequiredPublicationStatus
ValueSet.useContext:priorityContext.codeextensiblePattern: priority
ValueSet.useContext:priorityContext.value[x]requiredUSPublicHealthValueSetPriority
ValueSet.useContext:focusConditionContext.codeextensiblePattern: focus
ValueSet.useContext:focusConditionContext.value[x]exampleCondition/Problem/DiagnosisCodes
ValueSet.useContext:reportingContext.codeextensiblePattern: reporting
ValueSet.useContext:reportingContext.value[x]examplePattern: supplemental
ValueSet.jurisdictionextensibleJurisdiction ValueSet
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
ValueSet.compose.include.filter.oprequiredFilterOperator

Constraints

IdGradePathDetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeValueSetA resource should have narrative for robust management
: text.`div`.exists()
vsd-0warningValueSetName 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}')
ele-1errorValueSet.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.extension:extensionValueSetStewardAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.extension:extensionValueSetStewardMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.extension:extensionValueSetAuthorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.extension:extensionValueSetAuthorMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:priorityContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:priorityContext.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.useContext:priorityContext.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.useContext:priorityContext.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:priorityContext.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:focusConditionContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:focusConditionContext.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.useContext:focusConditionContext.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.useContext:focusConditionContext.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:focusConditionContext.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:reportingContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:reportingContext.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.useContext:reportingContext.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.useContext:reportingContext.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.useContext:reportingContext.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.immutableAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.composeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.lockedDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.inactiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.includeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
ele-1errorValueSet.compose.include.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.conceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.concept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.concept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.concept.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.concept.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.concept.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.concept.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.concept.designationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.concept.designation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.concept.designation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.concept.designation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.concept.designation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.concept.designation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.concept.designation.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.concept.designation.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.filterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.filter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.filter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.filter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.compose.include.filter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.include.filter.propertyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.filter.opAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.filter.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.include.valueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.compose.excludeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.expansion.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.expansion.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.expansion.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.expansion.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.timestampAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.totalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.offsetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.expansion.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.expansion.parameter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.expansion.parameter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.expansion.parameter.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.parameter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.containsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()
ele-1errorValueSet.expansion.contains.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.expansion.contains.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.expansion.contains.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorValueSet.expansion.contains.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.expansion.contains.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.contains.abstractAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.contains.inactiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.contains.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.contains.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.contains.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.contains.designationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorValueSet.expansion.contains.containsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())