R4 Draft for Comment
TerminologyThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R4 R3
| Vocabulary Work Group | Maturity Level: N/A | Ballot Status: Informative |
Description: Coded concepts representing Binding Realms (used for Context Binding of terminology in HL7 models) and/or Namespace Realms (used to help ensure unique identification of HL7 artifacts). This code system is partitioned into three sections: Affiliate realms, Binding realms and Namespace realms. All affiliate realm codes may automatically be used as both binding realms and namespace realms. Furthermore, affiliate realms are the only realms that have authority over the creation of binding realms. (Note that 'affiliate' includes the idea of both international affiliates and the HL7 International organization.) All other codes must be associated with an owning affiliate realm and must appear as a specialization of _BindingRealm or _NamespaceRealm. For affiliates whose concepts align with nations, the country codes from ISO 3166-1 2-character alpha are used for the code when possible so these codes should not be used for other realm types. It is recommended that binding realm and namespace codes submitted by affiliates use the realm code as a prefix to avoid possible collisions with ISO codes. However, tooling does not currently support namepace realm codes greater than 2 characters. Open Issue: The name of the concept property "owningAffiliate" should be changed to better reflect that the property value is the human readable name of the organizational entity that manages the Realm identified by the Realm Code. Open Issue: In spite of the inability of tooling to process codes longer than 2 characters, there is at least one realm codes ('SOA') that was added that is 3 characters in length.
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="v3-hl7Realm"/> <meta> <lastUpdated value="2017-07-31T00:00:00.000+10:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p> Release Date: 2017-07-31</p> <table class="grid"> <tr> <td> <b> Level</b> </td> <td> <b> Code</b> </td> <td> <b> Display</b> </td> <td> <b> Definition</b> </td> </tr> <tr> <td> 1</td> <td> <span style="color: grey"> <i> (BindingRealms)</i> </span> <b> <i> Abstract</i> </b> </td> <td> <a name="v3-hl7Realm-BindingRealms"> </a> </td> <td> Description: Concepts that can be used as Binding Realms when creating Binding Statements. These codes are permitted to appear in the InfrastructureRoot.realmCod e attribute. <br/> </td> </tr> <tr> <td> 2</td> <td> <span style="color: grey"> <i> (AffiliateRealms)</i> </span> <b> <i> Abstract</i> </b> </td> <td> <a name="v3-hl7Realm-AffiliateRealms"> </a> </td> <td> Description: Realm codes for official HL7 organizational bodies. This includes both the HL7 International organization as well as all recognized international affiliates (past and present). These groups have the ability to bind vocabulary and develop artifacts. As well, they have the ability to have "ownership" over other binding realms and namespace realms via the owningAffiliate property of those other realm codes. <br/> </td> </tr> <tr> <td> 3</td> <td> AR <a name="v3-hl7Realm-AR"> </a> </td> <td> Argentina</td> <td> Description: Realm code for use of Argentina <br/> </td> </tr> <tr> <td> 3</td> <td> AT <a name="v3-hl7Realm-AT"> </a> </td> <td> Austria</td> <td> Description: Realm code for use of Austria <br/> </td> </tr> <tr> <td> 3</td> <td> AU <a name="v3-hl7Realm-AU"> </a> </td> <td> Australia</td> <td> Description: Realm code for use of Australia <br/> </td> </tr> <tr> <td> 3</td> <td> BR <a name="v3-hl7Realm-BR"> </a> </td> <td> Brazil</td> <td> Description: Realm code for use of Brazil <br/> </td> </tr> <tr> <td> 3</td> <td> CA <a name="v3-hl7Realm-CA"> </a> </td> <td> Canada</td> <td> Description: Realm code for use of Canada <br/> </td> </tr> <tr> <td> 3</td> <td> CH <a name="v3-hl7Realm-CH"> </a> </td> <td> Switzerland</td> <td> Description: Realm code for use of Switzerland <br/> </td> </tr> <tr> <td> 3</td> <td> CL <a name="v3-hl7Realm-CL"> </a> </td> <td> Chile</td> <td> Description: Realm code for use of Chile <br/> </td> </tr> <tr> <td> 3</td> <td> CN <a name="v3-hl7Realm-CN"> </a> </td> <td> China</td> <td> Description: Realm code for use of China <br/> </td> </tr> <tr> <td> 3</td> <td> CO <a name="v3-hl7Realm-CO"> </a> </td> <td> Columbia</td> <td> Description: Realm code for use of Localized Version <br/> </td> </tr> <tr> <td> 3</td> <td> CZ <a name="v3-hl7Realm-CZ"> </a> </td> <td> Czech Republic</td> <td> Description: Realm code for use of Czech Republic <br/> </td> </tr> <tr> <td> 3</td> <td> DE <a name="v3-hl7Realm-DE"> </a> </td> <td> Germany</td> <td> Description: Realm code for use of Germany <br/> </td> </tr> <tr> <td> 3</td> <td> DK <a name="v3-hl7Realm-DK"> </a> </td> <td> Denmark</td> <td> Description: Realm code for use of Denmark <br/> </td> </tr> <tr> <td> 3</td> <td> ES <a name="v3-hl7Realm-ES"> </a> </td> <td> Spain</td> <td> Description: Realm code for use of Spain <br/> </td> </tr> <tr> <td> 3</td> <td> FI <a name="v3-hl7Realm-FI"> </a> </td> <td> Finland</td> <td> Description: Realm code for use of Finland <br/> </td> </tr> <tr> <td> 3</td> <td> FR <a name="v3-hl7Realm-FR"> </a> </td> <td> France</td> <td> Description: Realm code for use of France <br/> </td> </tr> <tr> <td> 3</td> <td> GR <a name="v3-hl7Realm-GR"> </a> </td> <td> Greece</td> <td> Description: Realm code for use of Greece <br/> </td> </tr> <tr> <td> 3</td> <td> HR <a name="v3-hl7Realm-HR"> </a> </td> <td> Croatia</td> <td> Description: Realm code for use of Croatia <br/> </td> </tr> <tr> <td> 3</td> <td> IE <a name="v3-hl7Realm-IE"> </a> </td> <td> Ireland</td> <td> Description: Realm code for use of Ireland <br/> </td> </tr> <tr> <td> 3</td> <td> IN <a name="v3-hl7Realm-IN"> </a> </td> <td> India</td> <td> Description: Realm code for use of India <br/> </td> </tr> <tr> <td> 3</td> <td> IT <a name="v3-hl7Realm-IT"> </a> </td> <td> Italy</td> <td> Description: Realm code for use of Italy <br/> </td> </tr> <tr> <td> 3</td> <td> JP <a name="v3-hl7Realm-JP"> </a> </td> <td> Japan</td> <td> Description: Realm code for use of Japan <br/> </td> </tr> <tr> <td> 3</td> <td> KR <a name="v3-hl7Realm-KR"> </a> </td> <td> Korea</td> <td> Description: Realm code for use of Korea <br/> </td> </tr> <tr> <td> 3</td> <td> LT <a name="v3-hl7Realm-LT"> </a> </td> <td> Lithuania</td> <td> Description: Realm code for use of Lithuania <br/> </td> </tr> <tr> <td> 3</td> <td> MX <a name="v3-hl7Realm-MX"> </a> </td> <td> Mexico</td> <td> Description: Realm code for use of Mexico <br/> </td> </tr> <tr> <td> 3</td> <td> NL <a name="v3-hl7Realm-NL"> </a> </td> <td> The Netherlands</td> <td> Description: Realm code for use of The Netherlands <br/> </td> </tr> <tr> <td> 3</td> <td> NZ <a name="v3-hl7Realm-NZ"> </a> </td> <td> New Zealand</td> <td> Description: Realm code for use of New Zealand <br/> </td> </tr> <tr> <td> 3</td> <td> RO <a name="v3-hl7Realm-RO"> </a> </td> <td> Romania</td> <td> Description: Realm code for use of Romania <br/> </td> </tr> <tr> <td> 3</td> <td> RU <a name="v3-hl7Realm-RU"> </a> </td> <td> Russian Federation</td> <td> Description: Realm code for use of Russian Federation <br/> </td> </tr> <tr> <td> 3</td> <td> SE <a name="v3-hl7Realm-SE"> </a> </td> <td> Sweden</td> <td> Description: Realm code for use of Sweden <br/> </td> </tr> <tr> <td> 3</td> <td> SG <a name="v3-hl7Realm-SG"> </a> </td> <td> Singapore</td> <td> Description: Realm code for use of Localized Version <br/> </td> </tr> <tr> <td> 3</td> <td> SOA <a name="v3-hl7Realm-SOA"> </a> </td> <td> Southern Africa</td> <td> Description: Realm code for use of Southern Africa <br/> </td> </tr> <tr> <td> 3</td> <td> TR <a name="v3-hl7Realm-TR"> </a> </td> <td> Turkey</td> <td> Description: Realm code for use of Turkey <br/> </td> </tr> <tr> <td> 3</td> <td> TW <a name="v3-hl7Realm-TW"> </a> </td> <td> Taiwan</td> <td> Description: Realm code for use of Taiwan <br/> </td> </tr> <tr> <td> 3</td> <td> UK <a name="v3-hl7Realm-UK"> </a> </td> <td> United Kingdom</td> <td> Description: Realm code for use of United Kingdom <br/> </td> </tr> <tr> <td> 3</td> <td> US <a name="v3-hl7Realm-US"> </a> </td> <td> United States of America</td> <td> Description: Realm code for use of United States of America <br/> </td> </tr> <tr> <td> 3</td> <td> UV <a name="v3-hl7Realm-UV"> </a> </td> <td> Universal</td> <td> Description: Realm code for use of Universal realm or context, used in every instance <br/> </td> </tr> <tr> <td> 3</td> <td> UY <a name="v3-hl7Realm-UY"> </a> </td> <td> Uruguay</td> <td> Description: Realm code for use of Uruguay <br/> </td> </tr> <tr> <td> 2</td> <td> C1 <a name="v3-hl7Realm-C1"> </a> </td> <td> Unclassified Realm</td> <td> Description: Realm code for use of Unclassified Realm <br/> </td> </tr> <tr> <td> 2</td> <td> GB <a name="v3-hl7Realm-GB"> </a> </td> <td> Great Britain</td> <td> Description: Realm code for use of Great Britain <br/> </td> </tr> <tr> <td> 2</td> <td> R1 <a name="v3-hl7Realm-R1"> </a> </td> <td> Representative Realm</td> <td> Description: Realm code for use of Representative Realm <br/> </td> </tr> <tr> <td> 2</td> <td> X1 <a name="v3-hl7Realm-X1"> </a> </td> <td> Example Realm</td> <td> Description: Realm code for use of Example Realm <br/> </td> </tr> <tr> <td> 1</td> <td> <span style="color: grey"> <i> (NamespaceRealms)</i> </span> <b> <i> Abstract</i> </b> </td> <td> <a name="v3-hl7Realm-NamespaceRealms"> </a> </td> <td> Description: Codes that can be used in the "realm" portion of HL7 v3 artifact identifiers. <br/> </td> </tr> <tr> <td> 2</td> <td> <a href="#AffiliateRealms">AffiliateRealms</a> </td> <td/> <td/> </tr> <tr> <td> 2</td> <td> <a href="#GB">GB</a> </td> <td/> <td/> </tr> <tr> <td> 2</td> <td> ZZ <a name="v3-hl7Realm-ZZ"> </a> </td> <td> Localized Version</td> <td> Description: An artifact created for local use only. This realm namespace has no owning affiliate. Its use is uncontrolled, i.e. anyone can create artifacts using this realm namespace. Because of this, there is a significant likelihood of artifact identifier collisions. Implementers are encouraged to register their artifacts under an affiliate owned and controlled namespace to avoid such collision problems where possible. <br/> </td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status"> <valueString value="External"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="0"/> </extension> <url value="http://hl7.org/fhir/v3/hl7Realm"/> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:2.16.840.1.113883.5.1124"/> </identifier> <version value="2017-07-31"/> <name value="v3 Code System hl7Realm"/> <status value="active"/> <experimental value="false"/> <date value="2017-07-31T00:00:00+10:00"/> <publisher value="HL7, Inc"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org"/> </telecom> </contact> <description value=" Description: Coded concepts representing Binding Realms (used for Context Binding of terminology in HL7 models) and/or Namespace Realms (used to help ensure unique identification of HL7 artifacts). This code system is partitioned into three sections: Affiliate realms, Binding realms and Namespace realms. All affiliate realm codes may automatically be used as both binding realms and namespace realms. Furthermore, affiliate realms are the only realms that have authority over the creation of binding realms. (Note that 'affiliate' includes the idea of both international affiliates and the HL7 International organization.) All other codes must be associated with an owning affiliate realm and must appear as a specialization of _BindingRealm or _NamespaceRealm. For affiliates whose concepts align with nations, the country codes from ISO 3166-1 2-character alpha are used for the code when possible so these codes should not be used for other realm types. It is recommended that binding realm and namespace codes submitted by affiliates use the realm code as a prefix to avoid possible collisions with ISO codes. However, tooling does not currently support namepace realm codes greater than 2 characters. Open Issue: The name of the concept property "owningAffiliate" should be changed to better reflect that the property value is the human readable name of the organizational entity that manages the Realm identified by the Realm Code. Open Issue: In spite of the inability of tooling to process codes longer than 2 characters, there is at least one realm codes ('SOA') that was added that is 3 characters in length."/> <caseSensitive value="true"/> <valueSet value="http://hl7.org/fhir/ValueSet/v3-hl7Realm"/> <hierarchyMeaning value="is-a"/> <content value="complete"/> <property> <code value="notSelectable"/> <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/> <description value="Indicates that the code is abstract - only intended to be used as a selector for other concepts"/> <type value="boolean"/> </property> <concept> <code value="BindingRealms"/> <display value="binding realms"/> <definition value="Description: Concepts that can be used as Binding Realms when creating Binding Statements. These codes are permitted to appear in the InfrastructureRoot.realmCode attribute."/> <property> <code value="notSelectable"/> <valueBoolean value="true"/> </property> <concept> <code value="AffiliateRealms"/> <display value="Affiliate Realms"/> <definition value="Description: Realm codes for official HL7 organizational bodies. This includes both the HL7 International organization as well as all recognized international affiliates (past and present). These groups have the ability to bind vocabulary and develop artifacts. As well, they have the ability to have "ownership" over other binding realms and namespace realms via the owningAffiliate property of those other realm codes."/> <property> <code value="notSelectable"/> <valueBoolean value="true"/> </property> <concept> <code value="AR"/> <display value="Argentina"/> <definition value="Description: Realm code for use of Argentina"/> </concept> <concept> <code value="AT"/> <display value="Austria"/> <definition value="Description: Realm code for use of Austria"/> </concept> <concept> <code value="AU"/> <display value="Australia"/> <definition value="Description: Realm code for use of Australia"/> </concept> <concept> <code value="BR"/> <display value="Brazil"/> <definition value="Description: Realm code for use of Brazil"/> </concept> <concept> <code value="CA"/> <display value="Canada"/> <definition value="Description: Realm code for use of Canada"/> </concept> <concept> <code value="CH"/> <display value="Switzerland"/> <definition value="Description: Realm code for use of Switzerland"/> </concept> <concept> <code value="CL"/> <display value="Chile"/> <definition value="Description: Realm code for use of Chile"/> </concept> <concept> <code value="CN"/> <display value="China"/> <definition value="Description: Realm code for use of China"/> </concept> <concept> <code value="CO"/> <display value="Columbia"/> <definition value="Description: Realm code for use of Localized Version"/> </concept> <concept> <code value="CZ"/> <display value="Czech Republic"/> <definition value="Description: Realm code for use of Czech Republic"/> </concept> <concept> <code value="DE"/> <display value="Germany"/> <definition value="Description: Realm code for use of Germany"/> </concept> <concept> <code value="DK"/> <display value="Denmark"/> <definition value="Description: Realm code for use of Denmark"/> </concept> <concept> <code value="ES"/> <display value="Spain"/> <definition value="Description: Realm code for use of Spain"/> </concept> <concept> <code value="FI"/> <display value="Finland"/> <definition value="Description: Realm code for use of Finland"/> </concept> <concept> <code value="FR"/> <display value="France"/> <definition value="Description: Realm code for use of France"/> </concept> <concept> <code value="GR"/> <display value="Greece"/> <definition value="Description: Realm code for use of Greece"/> </concept> <concept> <code value="HR"/> <display value="Croatia"/> <definition value="Description: Realm code for use of Croatia"/> </concept> <concept> <code value="IE"/> <display value="Ireland"/> <definition value="Description: Realm code for use of Ireland"/> </concept> <concept> <code value="IN"/> <display value="India"/> <definition value="Description: Realm code for use of India"/> </concept> <concept> <code value="IT"/> <display value="Italy"/> <definition value="Description: Realm code for use of Italy"/> </concept> <concept> <code value="JP"/> <display value="Japan"/> <definition value="Description: Realm code for use of Japan"/> </concept> <concept> <code value="KR"/> <display value="Korea"/> <definition value="Description: Realm code for use of Korea"/> </concept> <concept> <code value="LT"/> <display value="Lithuania"/> <definition value="Description: Realm code for use of Lithuania"/> </concept> <concept> <code value="MX"/> <display value="Mexico"/> <definition value="Description: Realm code for use of Mexico"/> </concept> <concept> <code value="NL"/> <display value="The Netherlands"/> <definition value="Description: Realm code for use of The Netherlands"/> </concept> <concept> <code value="NZ"/> <display value="New Zealand"/> <definition value="Description: Realm code for use of New Zealand"/> </concept> <concept> <code value="RO"/> <display value="Romania"/> <definition value="Description: Realm code for use of Romania"/> </concept> <concept> <code value="RU"/> <display value="Russian Federation"/> <definition value="Description: Realm code for use of Russian Federation"/> </concept> <concept> <code value="SE"/> <display value="Sweden"/> <definition value="Description: Realm code for use of Sweden"/> </concept> <concept> <code value="SG"/> <display value="Singapore"/> <definition value="Description: Realm code for use of Localized Version"/> </concept> <concept> <code value="SOA"/> <display value="Southern Africa"/> <definition value="Description: Realm code for use of Southern Africa"/> </concept> <concept> <code value="TR"/> <display value="Turkey"/> <definition value="Description: Realm code for use of Turkey"/> </concept> <concept> <code value="TW"/> <display value="Taiwan"/> <definition value="Description: Realm code for use of Taiwan"/> </concept> <concept> <code value="UK"/> <display value="United Kingdom"/> <definition value="Description: Realm code for use of United Kingdom"/> </concept> <concept> <code value="US"/> <display value="United States of America"/> <definition value="Description: Realm code for use of United States of America"/> </concept> <concept> <code value="UV"/> <display value="Universal"/> <definition value="Description: Realm code for use of Universal realm or context, used in every instance"/> </concept> <concept> <code value="UY"/> <display value="Uruguay"/> <definition value="Description: Realm code for use of Uruguay"/> </concept> </concept> <concept> <code value="C1"/> <display value="Unclassified Realm"/> <definition value="Description: Realm code for use of Unclassified Realm"/> </concept> <concept> <code value="GB"/> <display value="Great Britain"/> <definition value="Description: Realm code for use of Great Britain"/> </concept> <concept> <code value="R1"/> <display value="Representative Realm"/> <definition value="Description: Realm code for use of Representative Realm"/> </concept> <concept> <code value="X1"/> <display value="Example Realm"/> <definition value="Description: Realm code for use of Example Realm"/> </concept> </concept> <concept> <modifierExtension url="http://hl7.org/fhir/StructureDefinition/codesystem-subsumes"> <valueCode value="AffiliateRealms"/> </modifierExtension> <modifierExtension url="http://hl7.org/fhir/StructureDefinition/codesystem-subsumes"> <valueCode value="GB"/> </modifierExtension> <code value="NamespaceRealms"/> <display value="namespace realms"/> <definition value="Description: Codes that can be used in the "realm" portion of HL7 v3 artifact identifiers."/> <property> <code value="notSelectable"/> <valueBoolean value="true"/> </property> <concept> <code value="ZZ"/> <display value="Localized Version"/> <definition value="Description: An artifact created for local use only. This realm namespace has no owning affiliate. Its use is uncontrolled, i.e. anyone can create artifacts using this realm namespace. Because of this, there is a significant likelihood of artifact identifier collisions. Implementers are encouraged to register their artifacts under an affiliate owned and controlled namespace to avoid such collision problems where possible."/> </concept> </concept> </CodeSystem>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:59+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change