FHIR Tooling Extensions IG
1.2.0 - Release 1.2
FHIR Tooling Extensions IG
1.2.0 - Release 1.2
FHIR Tooling Extensions IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/fhir-tools-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 4 |
<CodeSystem xmlns="http://hl7.org/fhir">
<id value="additional-binding-purpose"/>
<language value="en"/>
<text>
<status value="generated"/>
<div xml:lang="en" lang="en"><hr/><p><b>English</b></p><hr/><p class="res-header-id"><b>Generated Narrative: CodeSystem additional-binding-purpose</b></p><a name="additional-binding-purpose"> </a><a name="hcadditional-binding-purpose"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class="grid"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>Not Selectable</td><td>abstract</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>boolean</td><td/></tr><tr><td>Status</td><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>code</td><td>A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/tools/CodeSystem/additional-binding-purpose</code> defines the following codes in a Is-A hierarchy:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>Not Selectable</b></td><td><b>Status</b></td></tr><tr style="background-color: #ffeeee"><td>1</td><td style="white-space:nowrap">maximum<a name="additional-binding-purpose-maximum"> </a></td><td>Maximum Binding</td><td>A required binding, for use when the binding strength is 'extensible' or 'preferred'. This is deprecated - it is equivalent to `required`</td><td/><td>deprecated</td></tr><tr><td>1</td><td style="white-space:nowrap">minimum<a name="additional-binding-purpose-minimum"> </a></td><td>Minimum Binding</td><td>The minimum allowable value set - any conformant system SHALL support all these codes</td><td/><td/></tr><tr><td>1</td><td style="white-space:nowrap">required<a name="additional-binding-purpose-required"> </a></td><td>Required Binding</td><td>This value set is used as a required binding (in addition to the base binding (not a replacement), usually in a particular usage context)</td><td/><td/></tr><tr><td>1</td><td style="white-space:nowrap">extensible<a name="additional-binding-purpose-extensible"> </a></td><td>Conformance Binding</td><td>This value set is used as an extensible binding (in addition to the base binding (not a replacement), usually in a particular usage context)</td><td/><td/></tr><tr><td>1</td><td style="white-space:nowrap">candidate<a name="additional-binding-purpose-candidate"> </a></td><td>Candidate Binding</td><td>This value set is a candidate to substitute for the overall conformance value set in some situations; usually these are defined in the documentation</td><td/><td/></tr><tr><td>1</td><td style="white-space:nowrap">current<a name="additional-binding-purpose-current"> </a></td><td>Current Binding (required)</td><td>New records are required to use this value set, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this</td><td/><td/></tr><tr><td>1</td><td style="white-space:nowrap">current-extensible<a name="additional-binding-purpose-current-extensible"> </a></td><td>Current Binding (extensible)</td><td>New records are required to use this value set if a concept applies, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this</td><td/><td/></tr><tr><td>1</td><td style="white-space:nowrap">best-practice<a name="additional-binding-purpose-best-practice"> </a></td><td>Best practice Binding</td><td>Instances are strongly encouraged to have a code from this value set and, if they enable 'best practice' validation mode, they will receive a 'best practice violation' message for data elements that do not include a code from this value set. This might be part of an overall best practice scoring profile, or advice on a more general profile.</td><td/><td/></tr><tr><td>1</td><td style="white-space:nowrap">open<a name="additional-binding-purpose-open"> </a></td><td>Open Binding</td><td>A Binding that doesn't make any restrictions on use, but is provided for other purposes</td><td>true</td><td/></tr><tr><td>2</td><td style="white-space:nowrap"> preferred<a name="additional-binding-purpose-preferred"> </a></td><td>Preferred Binding</td><td>This is the value set that is preferred in a given context (documentation should explain why)</td><td/><td/></tr><tr><td>2</td><td style="white-space:nowrap"> ui<a name="additional-binding-purpose-ui"> </a></td><td>UI Suggested Binding</td><td>This value set is provided for user look up in a given context. Typically, these valuesets only include a subset of codes relevant for input in a context</td><td/><td/></tr><tr><td>2</td><td style="white-space:nowrap"> starter<a name="additional-binding-purpose-starter"> </a></td><td>Starter Binding</td><td>This value set is a good set of codes to start with when designing your system</td><td/><td/></tr><tr><td>2</td><td style="white-space:nowrap"> component<a name="additional-binding-purpose-component"> </a></td><td>Component Binding</td><td>This value set is a component of the base value set. Usually this is called out so that documentation can be written about a portion of the value set</td><td/><td/></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="4"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="fhir"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="informative">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/tools/ImplementationGuide/hl7.fhir.uv.tools"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/tools/CodeSystem/additional-binding-purpose"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.40.1.16.5"/>
</identifier>
<version value="1.2.0"/>
<name value="AdditionalBindingPurposeCodes"/>
<title value="Additional Binding Purpose Codes"/>
<status value="active"/>
<experimental value="false"/>
<date value="2026-09-16T18:27:15+00:00"/>
<publisher value="HL7 International / FHIR Infrastructure"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/fiwg"/>
</telecom>
</contact>
<description value="Additional Binding Purpose"/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
</coding>
</jurisdiction>
<caseSensitive value="true"/>
<hierarchyMeaning value="is-a"/>
<content value="complete"/>
<property>
<code value="abstract"/>
<uri value="http://hl7.org/fhir/concept-properties#notSelectable"/>
<type value="boolean"/>
</property>
<property>
<code value="status"/>
<uri value="http://hl7.org/fhir/concept-properties#status"/>
<description
value="A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired"/>
<type value="code"/>
</property>
<concept>
<code value="maximum"/>
<display value="Maximum Binding"/>
<definition
value="A required binding, for use when the binding strength is 'extensible' or 'preferred'. This is deprecated - it is equivalent to `required`"/>
<property>
<code value="status"/>
<valueCode value="deprecated"/>
</property>
</concept>
<concept>
<code value="minimum"/>
<display value="Minimum Binding"/>
<definition
value="The minimum allowable value set - any conformant system SHALL support all these codes"/>
</concept>
<concept>
<code value="required"/>
<display value="Required Binding"/>
<definition
value="This value set is used as a required binding (in addition to the base binding (not a replacement), usually in a particular usage context)"/>
</concept>
<concept>
<code value="extensible"/>
<display value="Conformance Binding"/>
<definition
value="This value set is used as an extensible binding (in addition to the base binding (not a replacement), usually in a particular usage context)"/>
</concept>
<concept>
<code value="candidate"/>
<display value="Candidate Binding"/>
<definition
value="This value set is a candidate to substitute for the overall conformance value set in some situations; usually these are defined in the documentation"/>
</concept>
<concept>
<code value="current"/>
<display value="Current Binding (required)"/>
<definition
value="New records are required to use this value set, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this"/>
</concept>
<concept>
<code value="current-extensible"/>
<display value="Current Binding (extensible)"/>
<definition
value="New records are required to use this value set if a concept applies, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this"/>
</concept>
<concept>
<code value="best-practice"/>
<display value="Best practice Binding"/>
<definition
value="Instances are strongly encouraged to have a code from this value set and, if they enable 'best practice' validation mode, they will receive a 'best practice violation' message for data elements that do not include a code from this value set. This might be part of an overall best practice scoring profile, or advice on a more general profile."/>
</concept>
<concept>
<code value="open"/>
<display value="Open Binding"/>
<definition
value="A Binding that doesn't make any restrictions on use, but is provided for other purposes"/>
<property>
<code value="abstract"/>
<valueBoolean value="true"/>
</property>
<concept>
<code value="preferred"/>
<display value="Preferred Binding"/>
<definition
value="This is the value set that is preferred in a given context (documentation should explain why)"/>
</concept>
<concept>
<code value="ui"/>
<display value="UI Suggested Binding"/>
<definition
value="This value set is provided for user look up in a given context. Typically, these valuesets only include a subset of codes relevant for input in a context"/>
</concept>
<concept>
<code value="starter"/>
<display value="Starter Binding"/>
<definition
value="This value set is a good set of codes to start with when designing your system"/>
</concept>
<concept>
<code value="component"/>
<display value="Component Binding"/>
<definition
value="This value set is a component of the base value set. Usually this is called out so that documentation can be written about a portion of the value set"/>
</concept>
</concept>
</CodeSystem>
IG © 2022+ HL7 International / FHIR Infrastructure.
Package hl7.fhir.uv.tools#1.2.0 based on FHIR 5.0.0.
Generated
2026-09-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change