US Public Health Profiles Library
2.0.0-ballot - STU 2 - Ballot United States of America flag

This page is part of the US Public Health Profiles Library (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

Extension: US Public Health CodeSystem Property Required Binding Extension

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USPublicHealthCodeSystemPropertyRequiredBindingExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.5

This Extension profile represents a reference to a ValueSet that establishes a required binding to the allowable values for a code system property.

Context of Use

When a CodeSystem in FHIR defines properties that can be associated with codes in the code system, this extension can be used to establish a required binding to a ValueSet to specify the allowable values for the property. For example, a CodeSystem that defined a "us-state" property could use this binding to specify that the allowable values for that property are limited to the set of valid postal codes for US states.

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension US Public Health CodeSystem Property Binding Extension
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension"
... value[x] 1..1 canonical() Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension US Public Health CodeSystem Property Binding Extension
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type canonical: This Extension profile represents a reference to a ValueSet that establishes a required binding to the allowable values for a code system property.

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension US Public Health CodeSystem Property Binding Extension
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension"
... value[x] 1..1 canonical() Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension US Public Health CodeSystem Property Binding Extension
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type canonical: This Extension profile represents a reference to a ValueSet that establishes a required binding to the allowable values for a code system property.

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()