HL7 Terminology
1.0.0 - Publication

This page is part of the HL7 Terminology (v1.0.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

HL7Realm

Summary

Defining URL:http://terminology.hl7.org/CodeSystem/v3-hl7Realm
Version:2.0.0
Name:Hl7Realm
Title:HL7Realm
Status:Active
Content:All the concepts defined by the code system are included in the code system resource
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.

Publisher:HL7
OID:2.16.840.1.113883.5.1124 (for OID based terminology systems)
Content Mode:Complete
Source Resource:XML / JSON / Turtle

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

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.

Properties

CodeURLDescriptionType
SpecializesThe child code is a more narrow version of the concept represented by the parent code. I.e. Every child concept is also a valid parent concept. Used to allow determination of subsumption. Must be transitive, irreflexive, antisymmetric.Coding
GeneralizesInverse of Specializes. Only included as a derived relationship.Coding
OwningAffiliatehttp://terminology.hl7.org/CodeSystem/utg-concept-properties#OwningAffiliateIdentifies 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;]Coding
internalIdhttp://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-idThe internal identifier for the concept in the HL7 Access database repository.code
statushttp://hl7.org/fhir/concept-properties#statusDesignation of a concept's state. Normally is not populated unless the state is retired..code
notSelectablehttp://hl7.org/fhir/concept-properties#notSelectableIndicates that the code is abstract - only intended to be used as a selector for other conceptsboolean
subsumedByhttp://hl7.org/fhir/concept-properties#parentThe concept code of a parent conceptcode

This code system http://terminology.hl7.org/CodeSystem/v3-hl7Realm defines the following codes:

LvlCodeDisplayDefinitionHL7 Affiliate OwnerinternalIdstatusNot SelectableParent
1BindingRealms 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.23214activetrue
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.22941activetrueBindingRealms
3    AR Argentina**Description:** Realm code for use of Argentina22942activeAffiliateRealms
3    AT Austria**Description:** Realm code for use of Austria22943activeAffiliateRealms
3    AU Australia**Description:** Realm code for use of Australia22944activeAffiliateRealms
3    BR Brazil**Description:** Realm code for use of Brazil22945activeAffiliateRealms
3    CA Canada**Description:** Realm code for use of Canada22946activeAffiliateRealms
3    CH Switzerland**Description:** Realm code for use of Switzerland22947activeAffiliateRealms
3    CL Chile**Description:** Realm code for use of Chile22948activeAffiliateRealms
3    CN China**Description:** Realm code for use of China22949activeAffiliateRealms
3    CO Columbia**Description:** Realm code for use of Localized Version22977activeAffiliateRealms
3    CZ Czech Republic**Description:** Realm code for use of Czech Republic22950activeAffiliateRealms
3    DE Germany**Description:** Realm code for use of Germany22951activeAffiliateRealms
3    DK Denmark**Description:** Realm code for use of Denmark22952activeAffiliateRealms
3    ES Spain**Description:** Realm code for use of Spain22953activeAffiliateRealms
3    FI Finland**Description:** Realm code for use of Finland22954activeAffiliateRealms
3    FR France**Description:** Realm code for use of France22955activeAffiliateRealms
3    GR Greece**Description:** Realm code for use of Greece22956activeAffiliateRealms
3    HR Croatia**Description:** Realm code for use of Croatia22957activeAffiliateRealms
3    IE Ireland**Description:** Realm code for use of Ireland22958activeAffiliateRealms
3    IN India**Description:** Realm code for use of India22959activeAffiliateRealms
3    IT Italy**Description:** Realm code for use of Italy22960activeAffiliateRealms
3    JP Japan**Description:** Realm code for use of Japan22961activeAffiliateRealms
3    KR Korea**Description:** Realm code for use of Korea22962activeAffiliateRealms
3    LT Lithuania**Description:** Realm code for use of Lithuania22963activeAffiliateRealms
3    MX Mexico**Description:** Realm code for use of Mexico22964activeAffiliateRealms
3    NL The Netherlands**Description:** Realm code for use of The Netherlands22965activeAffiliateRealms
3    NZ New Zealand**Description:** Realm code for use of New Zealand22966activeAffiliateRealms
3    RO Romania**Description:** Realm code for use of Romania22967activeAffiliateRealms
3    RU Russian Federation**Description:** Realm code for use of Russian Federation22968activeAffiliateRealms
3    SE Sweden**Description:** Realm code for use of Sweden22969activeAffiliateRealms
3    SG Singapore**Description:** Realm code for use of Localized Version22978activeAffiliateRealms
3    SOA Southern Africa**Description:** Realm code for use of Southern Africa22970activeAffiliateRealms
3    TR Turkey**Description:** Realm code for use of Turkey22971activeAffiliateRealms
3    TW Taiwan**Description:** Realm code for use of Taiwan22972activeAffiliateRealms
3    UK United Kingdom**Description:** Realm code for use of United Kingdom22973activeAffiliateRealms
3    US United States of America**Description:** Realm code for use of United States of America22975activeAffiliateRealms
3    UV Universal**Description:** Realm code for use of Universal realm or context, used in every instance22939activeAffiliateRealms
3    UY Uruguay**Description:** Realm code for use of Uruguay22976activeAffiliateRealms
2  C1 Unclassified Realm**Description:** Realm code for use of Unclassified RealmUV22937activeBindingRealms
2  GB Great Britain**Description:** Realm code for use of Great BritainUK22974activeBindingRealms
2  R1 Representative Realm**Description:** Realm code for use of Representative RealmUV22938activeBindingRealms
2  X1 Example Realm**Description:** Realm code for use of Example RealmUV22940activeBindingRealms
1NamespaceRealms namespace realms**Description:** Codes that can be used in the "realm" portion of HL7 v3 artifact identifiers.23215activetrue
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.22935activeNamespaceRealms
2  AffiliateRealmsAffiliate Realms
2  GBGreat Britain
1SpecialRealms Special Realms**Description:** Realm code for use of Special Realms22936retiredtrue

History

DateActionCustodianAuthorComment
2020-05-06reviseVocabulary WGTed KleinMigrated to the UTG maintenance environment and publishing tooling.