This page is part of the FHIR Specification (v3.0.2: STU 3). 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/A

External

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 Resource

XML / JSON

This value set is used in the following places:

This value set is the designated 'entire code system' value set for v3 Code System hl7Realm

4.3.2.1124.1 Content Logical Definition

This value set includes codes from the following code systems:

Include all codes defined in http://hl7.org/fhir/v3/hl7Realm

4.3.2.1124.2 Expansion

This expansion generated 19 Apr 2017

This value set contains 42 concepts

Expansion based on http://hl7.org/fhir/v3/hl7Realm version 2016-11-11

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

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