Current Build

4.4.2.1124 HL7 v3 Code System hl7Realm

Vocabulary Work Group Maturity Level: N/AExternal Use Context: Any

This code system (http://terminology.hl7.org/CodeSystem/v3-hl7Realm) is defined as part of HL7 v3.

Summary

Defining URL:http://terminology.hl7.org/CodeSystem/v3-hl7Realm
Version:2019-07-31
Name:v3.hl7Realm
Title:v3 Code System hl7Realm
Definition:

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.

OID:2.16.840.1.113883.5.1124 (for OID based terminology systems)
Source ResourceXML / JSON

This Code system is used in the following value sets:

  • ValueSet: v3 Code System hl7Realm ( 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.)

Release Date: 2019-07-31

LevelCodeDisplayDefinition
1(BindingRealms) Abstract  Description: Concepts that can be used as Binding Realms when creating Binding Statements. These codes are permitted to appear in the InfrastructureRoot.realmCode attribute.
2  (AffiliateRealms) Abstract  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.
3    AR Argentina Description: Realm code for use of Argentina
3    AT Austria Description: Realm code for use of Austria
3    AU Australia Description: Realm code for use of Australia
3    BR Brazil Description: Realm code for use of Brazil
3    CA Canada Description: Realm code for use of Canada
3    CH Switzerland Description: Realm code for use of Switzerland
3    CL Chile Description: Realm code for use of Chile
3    CN China Description: Realm code for use of China
3    CO Columbia Description: Realm code for use of Localized Version
3    CZ Czech Republic Description: Realm code for use of Czech Republic
3    DE Germany Description: Realm code for use of Germany
3    DK Denmark Description: Realm code for use of Denmark
3    ES Spain Description: Realm code for use of Spain
3    FI Finland Description: Realm code for use of Finland
3    FR France Description: Realm code for use of France
3    GR Greece Description: Realm code for use of Greece
3    HR Croatia Description: Realm code for use of Croatia
3    IE Ireland Description: Realm code for use of Ireland
3    IN India Description: Realm code for use of India
3    IT Italy Description: Realm code for use of Italy
3    JP Japan Description: Realm code for use of Japan
3    KR Korea Description: Realm code for use of Korea
3    LT Lithuania Description: Realm code for use of Lithuania
3    MX Mexico Description: Realm code for use of Mexico
3    NL The Netherlands Description: Realm code for use of The Netherlands
3    NZ New Zealand Description: Realm code for use of New Zealand
3    RO Romania Description: Realm code for use of Romania
3    RU Russian Federation Description: Realm code for use of Russian Federation
3    SE Sweden Description: Realm code for use of Sweden
3    SG Singapore Description: Realm code for use of Localized Version
3    SOA Southern Africa Description: Realm code for use of Southern Africa
3    TR Turkey Description: Realm code for use of Turkey
3    TW Taiwan Description: Realm code for use of Taiwan
3    UK United Kingdom Description: Realm code for use of United Kingdom
3    US United States of America Description: Realm code for use of United States of America
3    UV Universal Description: Realm code for use of Universal realm or context, used in every instance
3    UY Uruguay Description: Realm code for use of Uruguay
2  C1 Unclassified Realm Description: Realm code for use of Unclassified Realm
2  GB Great Britain Description: Realm code for use of Great Britain
2  R1 Representative Realm Description: Realm code for use of Representative Realm
2  X1 Example Realm Description: Realm code for use of Example Realm
1(NamespaceRealms) Abstract  Description: Codes that can be used in the "realm" portion of HL7 v3 artifact identifiers.
2  AffiliateRealms
2  GB
2  ZZ Localized Version 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.