Package org.hl7.fhir.r4.model.codesystems

Enum Class V3Hl7Realm

java.lang.Object
java.lang.Enum<V3Hl7Realm>
org.hl7.fhir.r4.model.codesystems.V3Hl7Realm
All Implemented Interfaces:
Serializable, Comparable<V3Hl7Realm>, Constable
public enum V3Hl7Realm extends Enum<V3Hl7Realm>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AFFILIATEREALMS
    Description: Realm codes for official HL7 organizational bodies.
    AR
    Description: Realm code for use of Argentina
    AT
    Description: Realm code for use of Austria
    AU
    Description: Realm code for use of Australia
    BINDINGREALMS
    Description: Concepts that can be used as Binding Realms when creating Binding Statements.
    BR
    Description: Realm code for use of Brazil
    C1
    Description: Realm code for use of Unclassified Realm
    CA
    Description: Realm code for use of Canada
    CH
    Description: Realm code for use of Switzerland
    CL
    Description: Realm code for use of Chile
    CN
    Description: Realm code for use of China
    CO
    Description: Realm code for use of Localized Version
    CZ
    Description: Realm code for use of Czech Republic
    DE
    Description: Realm code for use of Germany
    DK
    Description: Realm code for use of Denmark
    ES
    Description: Realm code for use of Spain
    FI
    Description: Realm code for use of Finland
    FR
    Description: Realm code for use of France
    GB
    Description: Realm code for use of Great Britain
    GR
    Description: Realm code for use of Greece
    HR
    Description: Realm code for use of Croatia
    IE
    Description: Realm code for use of Ireland
    IN
    Description: Realm code for use of India
    IT
    Description: Realm code for use of Italy
    JP
    Description: Realm code for use of Japan
    KR
    Description: Realm code for use of Korea
    LT
    Description: Realm code for use of Lithuania
    MX
    Description: Realm code for use of Mexico
    NAMESPACEREALMS
    Description: Codes that can be used in the "realm" portion of HL7 v3 artifact identifiers.
    NL
    Description: Realm code for use of The Netherlands
    NULL
    added to help the parsers
    NZ
    Description: Realm code for use of New Zealand
    R1
    Description: Realm code for use of Representative Realm
    RO
    Description: Realm code for use of Romania
    RU
    Description: Realm code for use of Russian Federation
    SE
    Description: Realm code for use of Sweden
    SG
    Description: Realm code for use of Localized Version
    SOA
    Description: Realm code for use of Southern Africa
    TR
    Description: Realm code for use of Turkey
    TW
    Description: Realm code for use of Taiwan
    UK
    Description: Realm code for use of United Kingdom
    US
    Description: Realm code for use of United States of America
    UV
    Description: Realm code for use of Universal realm or context, used in every instance
    UY
    Description: Realm code for use of Uruguay
    X1
    Description: Realm code for use of Example Realm
    ZZ
    Description: An artifact created for local use only.

  • Method Summary

    Modifier and Type
    Method
    Description
    static V3Hl7Realm
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static V3Hl7Realm
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static V3Hl7Realm[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BINDINGREALMS

      public static final V3Hl7Realm BINDINGREALMS
      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

      public static final V3Hl7Realm AFFILIATEREALMS
      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

      public static final V3Hl7Realm AR
      Description: Realm code for use of Argentina

    • AT

      public static final V3Hl7Realm AT
      Description: Realm code for use of Austria

    • AU

      public static final V3Hl7Realm AU
      Description: Realm code for use of Australia

    • BR

      public static final V3Hl7Realm BR
      Description: Realm code for use of Brazil

    • CA

      public static final V3Hl7Realm CA
      Description: Realm code for use of Canada

    • CH

      public static final V3Hl7Realm CH
      Description: Realm code for use of Switzerland

    • CL

      public static final V3Hl7Realm CL
      Description: Realm code for use of Chile

    • CN

      public static final V3Hl7Realm CN
      Description: Realm code for use of China

    • CO

      public static final V3Hl7Realm CO
      Description: Realm code for use of Localized Version

    • CZ

      public static final V3Hl7Realm CZ
      Description: Realm code for use of Czech Republic

    • DE

      public static final V3Hl7Realm DE
      Description: Realm code for use of Germany

    • DK

      public static final V3Hl7Realm DK
      Description: Realm code for use of Denmark

    • ES

      public static final V3Hl7Realm ES
      Description: Realm code for use of Spain

    • FI

      public static final V3Hl7Realm FI
      Description: Realm code for use of Finland

    • FR

      public static final V3Hl7Realm FR
      Description: Realm code for use of France

    • GR

      public static final V3Hl7Realm GR
      Description: Realm code for use of Greece

    • HR

      public static final V3Hl7Realm HR
      Description: Realm code for use of Croatia

    • IE

      public static final V3Hl7Realm IE
      Description: Realm code for use of Ireland

    • IN

      public static final V3Hl7Realm IN
      Description: Realm code for use of India

    • IT

      public static final V3Hl7Realm IT
      Description: Realm code for use of Italy

    • JP

      public static final V3Hl7Realm JP
      Description: Realm code for use of Japan

    • KR

      public static final V3Hl7Realm KR
      Description: Realm code for use of Korea

    • LT

      public static final V3Hl7Realm LT
      Description: Realm code for use of Lithuania

    • MX

      public static final V3Hl7Realm MX
      Description: Realm code for use of Mexico

    • NL

      public static final V3Hl7Realm NL
      Description: Realm code for use of The Netherlands

    • NZ

      public static final V3Hl7Realm NZ
      Description: Realm code for use of New Zealand

    • RO

      public static final V3Hl7Realm RO
      Description: Realm code for use of Romania

    • RU

      public static final V3Hl7Realm RU
      Description: Realm code for use of Russian Federation

    • SE

      public static final V3Hl7Realm SE
      Description: Realm code for use of Sweden

    • SG

      public static final V3Hl7Realm SG
      Description: Realm code for use of Localized Version

    • SOA

      public static final V3Hl7Realm SOA
      Description: Realm code for use of Southern Africa

    • TR

      public static final V3Hl7Realm TR
      Description: Realm code for use of Turkey

    • TW

      public static final V3Hl7Realm TW
      Description: Realm code for use of Taiwan

    • UK

      public static final V3Hl7Realm UK
      Description: Realm code for use of United Kingdom

    • US

      public static final V3Hl7Realm US
      Description: Realm code for use of United States of America

    • UV

      public static final V3Hl7Realm UV
      Description: Realm code for use of Universal realm or context, used in every instance

    • UY

      public static final V3Hl7Realm UY
      Description: Realm code for use of Uruguay

    • C1

      public static final V3Hl7Realm C1
      Description: Realm code for use of Unclassified Realm

    • GB

      public static final V3Hl7Realm GB
      Description: Realm code for use of Great Britain

    • R1

      public static final V3Hl7Realm R1
      Description: Realm code for use of Representative Realm

    • X1

      public static final V3Hl7Realm X1
      Description: Realm code for use of Example Realm

    • NAMESPACEREALMS

      public static final V3Hl7Realm NAMESPACEREALMS
      Description: Codes that can be used in the "realm" portion of HL7 v3 artifact identifiers.

    • ZZ

      public static final V3Hl7Realm ZZ
      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.

    • NULL

      public static final V3Hl7Realm NULL
      added to help the parsers

  • Method Details

    • values

      public static V3Hl7Realm[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static V3Hl7Realm valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromCode

      public static V3Hl7Realm fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • toCode

      public String toCode()

    • getSystem

      public String getSystem()

    • getDefinition

      public String getDefinition()

    • getDisplay

      public String getDisplay()