HL7 Terminology (THO)
7.1.0 - Continuous Process Integration (ci build) International flag

HL7 Terminology (THO), published by HL7 International - Vocabulary Work Group. This guide is not an authorized publication; it is the continuous build for version 7.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/UTG/ and changes regularly. See the Directory of published versions

CodeSystem: HL7Realm

Official URL: http://terminology.hl7.org/CodeSystem/v3-hl7Realm Version: 4.0.0
Responsible: Health Level Seven International Computable Name: Hl7Realm
Other Identifiers: OID:2.16.840.1.113883.5.1124

Copyright/Legal: This material derives from the HL7 Terminology THO. THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html

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.

This Code system is referenced in the definition of the following value sets:

Language: en

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
HL7 Affiliate Owner OwningAffiliate http://terminology.hl7.org/CodeSystem/utg-concept-properties#OwningAffiliate Coding Identifies the affiliate responsible for a binding realm or namespace realm code. Must be specified for all codes that are not specializations of AffiliateRealms. ConceptRelationshipProperties: [relationshipKind: other; isNavigable: false; functionalism: functional; reflexivity: irreflexive; symmetry: antisymetric; connected: false; transitivity: antitransitive; allowedForTargets: all codes from the hl7PublishingSection code system; requiredForSources: all codes which are not equal to ZZ and are not specializations of the abstract code AffiliateRealms; allowedForTargets: all codes which are specializations of the abstract code AffiliateRealms;]
Status status http://hl7.org/fhir/concept-properties#status code Designation of a concept's state. Normally is not populated unless the state is retired..
Not Selectable notSelectable http://hl7.org/fhir/concept-properties#notSelectable boolean Indicates that the code is abstract - only intended to be used as a selector for other concepts
Parent subsumedBy http://hl7.org/fhir/concept-properties#parent code The concept code of a parent concept

Concepts

This case-sensitive code system http://terminology.hl7.org/CodeSystem/v3-hl7Realm defines the following codes in a Is-A hierarchy:

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

Description of the above table(s).

History

DateActionAuthorCustodianComment
2023-11-14reviseMarc DuteauTSMGAdd standard copyright and contact to internal content; up-476
2022-10-18reviseMarc DuteauTSMGFixing missing metadata; up-349
2022-02-17 00:00:32+1100reviseGrahame GrieveVocabulary WGPopulate Missing caseSensitive property; UP-286
2020-05-06reviseTed KleinVocabulary WGMigrated to the UTG maintenance environment and publishing tooling.