FHIR Tooling Extensions IG
0.6.0 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.6.0: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 0.7.0. For a full list of available versions, see the Directory of published versions

Extension: Additional Binding Extension

Official URL: http://hl7.org/fhir/tools/StructureDefinition/additional-binding Version: 0.6.0
Standards status: Informative Maturity Level: 4 Computable Name: AdditionalBinding
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.9

Extension definition for Additional Binding. Additional Bindings are in the R5 Element Definition; this extension is used in prior versions (instead of the R5 cross-version extension)

Context of Use

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

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 Additional Binding
Constraints: ext-ab-1
... Slices for extension Content/Rules for all slices
.... extension:key 0..1 Extension Unique identifier so additional bindings to be matched across profiles
..... extension 0..0
..... url 1..1 uri "key"
..... value[x] 1..1 id Value of extension
.... extension:purpose 1..1 Extension How the binding is used
..... extension 0..0
..... url 1..1 uri "purpose"
..... value[x] 1..1 code Value of extension
Binding: Additional Binding Purpose ValueSet (required)
.... extension:valueSet 1..1 Extension The valueSet for the binding
..... extension 0..0
..... url 1..1 uri "valueSet"
..... value[x] 1..1 canonical(ValueSet) Value of extension
.... extension:documentation 0..1 Extension Documentation for this binding
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
.... extension:shortDoco 0..1 Extension Short doco for this binding - used in dense table views
..... extension 0..0
..... url 1..1 uri "shortDoco"
..... value[x] 1..1 string Value of extension
.... extension:usage 0..* Extension Definition of a context in which this binding applies
..... extension 0..0
..... url 1..1 uri "usage"
..... value[x] 1..1 UsageContext Value of extension
.... extension:any 0..1 Extension Whether the binding applies to all repeats, or just to any one of the repeats
..... extension 0..0
..... url 1..1 uri "any"
..... value[x] 1..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Additional Binding
Constraints: ext-ab-1
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:key 0..1 Extension Unique identifier so additional bindings to be matched across profiles
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "key"
..... value[x] 1..1 id Value of extension
.... extension:purpose 1..1 Extension How the binding is used
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "purpose"
..... value[x] 1..1 code Value of extension
Binding: Additional Binding Purpose ValueSet (required)
.... extension:valueSet 1..1 Extension The valueSet for the binding
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "valueSet"
..... value[x] 1..1 canonical(ValueSet) Value of extension
.... extension:documentation 0..1 Extension Documentation for this binding
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
.... extension:shortDoco 0..1 Extension Short doco for this binding - used in dense table views
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "shortDoco"
..... value[x] 1..1 string Value of extension
.... extension:usage 0..* Extension Definition of a context in which this binding applies
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "usage"
..... value[x] 1..1 UsageContext Value of extension
.... extension:any 0..1 Extension Whether the binding applies to all repeats, or just to any one of the repeats
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "any"
..... value[x] 1..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Extension definition for Additional Binding. Additional Bindings are in the R5 Element Definition; this extension is used in prior versions (instead of the R5 cross-version extension)

  • key: id: An Extension
  • purpose: code: An Extension
  • valueSet: canonical: An Extension
  • documentation: markdown: An Extension
  • shortDoco: string: An Extension
  • usage: UsageContext: Definition of a context in which this binding applies. This SHOULD be present for purpose=conformance to limit the scope of the conformance claim.
  • any: boolean: An Extension

Maturity: 4

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Additional Binding
Constraints: ext-ab-1
... Slices for extension Content/Rules for all slices
.... extension:key 0..1 Extension Unique identifier so additional bindings to be matched across profiles
..... extension 0..0
..... url 1..1 uri "key"
..... value[x] 1..1 id Value of extension
.... extension:purpose 1..1 Extension How the binding is used
..... extension 0..0
..... url 1..1 uri "purpose"
..... value[x] 1..1 code Value of extension
Binding: Additional Binding Purpose ValueSet (required)
.... extension:valueSet 1..1 Extension The valueSet for the binding
..... extension 0..0
..... url 1..1 uri "valueSet"
..... value[x] 1..1 canonical(ValueSet) Value of extension
.... extension:documentation 0..1 Extension Documentation for this binding
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
.... extension:shortDoco 0..1 Extension Short doco for this binding - used in dense table views
..... extension 0..0
..... url 1..1 uri "shortDoco"
..... value[x] 1..1 string Value of extension
.... extension:usage 0..* Extension Definition of a context in which this binding applies
..... extension 0..0
..... url 1..1 uri "usage"
..... value[x] 1..1 UsageContext Value of extension
.... extension:any 0..1 Extension Whether the binding applies to all repeats, or just to any one of the repeats
..... extension 0..0
..... url 1..1 uri "any"
..... value[x] 1..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Additional Binding
Constraints: ext-ab-1
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:key 0..1 Extension Unique identifier so additional bindings to be matched across profiles
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "key"
..... value[x] 1..1 id Value of extension
.... extension:purpose 1..1 Extension How the binding is used
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "purpose"
..... value[x] 1..1 code Value of extension
Binding: Additional Binding Purpose ValueSet (required)
.... extension:valueSet 1..1 Extension The valueSet for the binding
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "valueSet"
..... value[x] 1..1 canonical(ValueSet) Value of extension
.... extension:documentation 0..1 Extension Documentation for this binding
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
.... extension:shortDoco 0..1 Extension Short doco for this binding - used in dense table views
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "shortDoco"
..... value[x] 1..1 string Value of extension
.... extension:usage 0..* Extension Definition of a context in which this binding applies
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "usage"
..... value[x] 1..1 UsageContext Value of extension
.... extension:any 0..1 Extension Whether the binding applies to all repeats, or just to any one of the repeats
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "any"
..... value[x] 1..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Extension definition for Additional Binding. Additional Bindings are in the R5 Element Definition; this extension is used in prior versions (instead of the R5 cross-version extension)

  • key: id: An Extension
  • purpose: code: An Extension
  • valueSet: canonical: An Extension
  • documentation: markdown: An Extension
  • shortDoco: string: An Extension
  • usage: UsageContext: Definition of a context in which this binding applies. This SHOULD be present for purpose=conformance to limit the scope of the conformance claim.
  • any: boolean: An Extension

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:purpose.value[x]requiredAdditionalBindingPurposeVS(a valid code from Additional Binding Purpose Codes)
http://hl7.org/fhir/tools/ValueSet/additional-binding-purpose
From this IG

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()
ext-ab-1warningExtensionAdditional Bindings SHOULD have a key to allow a binding to be constrained.
: extension.where(url='key').exists()