R4 Draft for Comment

This 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

4.3.2.1124 HL7 v3 Value Set hl7Realm

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

This value set (http://hl7.org/fhir/ValueSet/v3-hl7Realm) is defined as part of HL7 v3.

Summary

Defining URL:http://hl7.org/fhir/ValueSet/v3-hl7Realm
Name: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.1.11.20355 (for OID based terminology systems)
Source ResourceXML / JSON

This value set is used in the following places:


This value set includes codes from the following code systems:

 

This expansion generated 20 Dec 2017


This value set contains 45 concepts

All codes from system http://hl7.org/fhir/v3/hl7Realm

CodeDisplayDefinition
BindingRealmsbinding realmsDescription: Concepts that can be used as Binding Realms when creating Binding Statements. These codes are permitted to appear in the InfrastructureRoot.realmCode attribute.
AffiliateRealmsAffiliate RealmsDescription: 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.
ARArgentinaDescription: Realm code for use of Argentina
ATAustriaDescription: Realm code for use of Austria
AUAustraliaDescription: Realm code for use of Australia
BRBrazilDescription: Realm code for use of Brazil
CACanadaDescription: Realm code for use of Canada
CHSwitzerlandDescription: Realm code for use of Switzerland
CLChileDescription: Realm code for use of Chile
CNChinaDescription: Realm code for use of China
COColumbiaDescription: Realm code for use of Localized Version
CZCzech RepublicDescription: Realm code for use of Czech Republic
DEGermanyDescription: Realm code for use of Germany
DKDenmarkDescription: Realm code for use of Denmark
ESSpainDescription: Realm code for use of Spain
FIFinlandDescription: Realm code for use of Finland
FRFranceDescription: Realm code for use of France
GRGreeceDescription: Realm code for use of Greece
HRCroatiaDescription: Realm code for use of Croatia
IEIrelandDescription: Realm code for use of Ireland
INIndiaDescription: Realm code for use of India
ITItalyDescription: Realm code for use of Italy
JPJapanDescription: Realm code for use of Japan
KRKoreaDescription: Realm code for use of Korea
LTLithuaniaDescription: Realm code for use of Lithuania
MXMexicoDescription: Realm code for use of Mexico
NLThe NetherlandsDescription: Realm code for use of The Netherlands
NZNew ZealandDescription: Realm code for use of New Zealand
RORomaniaDescription: Realm code for use of Romania
RURussian FederationDescription: Realm code for use of Russian Federation
SESwedenDescription: Realm code for use of Sweden
SGSingaporeDescription: Realm code for use of Localized Version
SOASouthern AfricaDescription: Realm code for use of Southern Africa
TRTurkeyDescription: Realm code for use of Turkey
TWTaiwanDescription: Realm code for use of Taiwan
UKUnited KingdomDescription: Realm code for use of United Kingdom
USUnited States of AmericaDescription: Realm code for use of United States of America
UVUniversalDescription: Realm code for use of Universal realm or context, used in every instance
UYUruguayDescription: Realm code for use of Uruguay
C1Unclassified RealmDescription: Realm code for use of Unclassified Realm
GBGreat BritainDescription: Realm code for use of Great Britain
R1Representative RealmDescription: Realm code for use of Representative Realm
X1Example RealmDescription: Realm code for use of Example Realm
NamespaceRealmsnamespace realmsDescription: Codes that can be used in the "realm" portion of HL7 v3 artifact identifiers.
ZZLocalized VersionDescription: 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.