org.hl7.fhir.r4.model.codesystems.IdentifierUse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.hl7.fhir.r4 Show documentation
The newest version!
package org.hl7.fhir.r4.model.codesystems;

/*
  Copyright (c) 2011+, HL7, Inc.
  All rights reserved.
  
  Redistribution and use in source and binary forms, with or without modification, 
  are permitted provided that the following conditions are met:
  
   * Redistributions of source code must retain the above copyright notice, this 
     list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice, 
     this list of conditions and the following disclaimer in the documentation 
     and/or other materials provided with the distribution.
   * Neither the name of HL7 nor the names of its contributors may be used to 
     endorse or promote products derived from this software without specific 
     prior written permission.
  
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
  POSSIBILITY OF SUCH DAMAGE.
  
*/

// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0

import org.hl7.fhir.exceptions.FHIRException;

public enum IdentifierUse {

  /**
   * The identifier recommended for display and use in real-world interactions.
   */
  USUAL,
  /**
   * The identifier considered to be most trusted for the identification of this
   * item. Sometimes also known as "primary" and "main". The determination of
   * "official" is subjective and implementation guides often provide additional
   * guidelines for use.
   */
  OFFICIAL,
  /**
   * A temporary identifier.
   */
  TEMP,
  /**
   * An identifier that was assigned in secondary use - it serves to identify the
   * object in a relative context, but cannot be consistently assigned to the same
   * object again in a different context.
   */
  SECONDARY,
  /**
   * The identifier id no longer considered valid, but may be relevant for search
   * purposes. E.g. Changes to identifier schemes, account merges, etc.
   */
  OLD,
  /**
   * added to help the parsers
   */
  NULL;

  public static IdentifierUse fromCode(String codeString) throws FHIRException {
    if (codeString == null || "".equals(codeString))
      return null;
    if ("usual".equals(codeString))
      return USUAL;
    if ("official".equals(codeString))
      return OFFICIAL;
    if ("temp".equals(codeString))
      return TEMP;
    if ("secondary".equals(codeString))
      return SECONDARY;
    if ("old".equals(codeString))
      return OLD;
    throw new FHIRException("Unknown IdentifierUse code '" + codeString + "'");
  }

  public String toCode() {
    switch (this) {
    case USUAL:
      return "usual";
    case OFFICIAL:
      return "official";
    case TEMP:
      return "temp";
    case SECONDARY:
      return "secondary";
    case OLD:
      return "old";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

  public String getSystem() {
    return "http://hl7.org/fhir/identifier-use";
  }

  public String getDefinition() {
    switch (this) {
    case USUAL:
      return "The identifier recommended for display and use in real-world interactions.";
    case OFFICIAL:
      return "The identifier considered to be most trusted for the identification of this item. Sometimes also known as \"primary\" and \"main\". The determination of \"official\" is subjective and implementation guides often provide additional guidelines for use.";
    case TEMP:
      return "A temporary identifier.";
    case SECONDARY:
      return "An identifier that was assigned in secondary use - it serves to identify the object in a relative context, but cannot be consistently assigned to the same object again in a different context.";
    case OLD:
      return "The identifier id no longer considered valid, but may be relevant for search purposes.  E.g. Changes to identifier schemes, account merges, etc.";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

  public String getDisplay() {
    switch (this) {
    case USUAL:
      return "Usual";
    case OFFICIAL:
      return "Official";
    case TEMP:
      return "Temp";
    case SECONDARY:
      return "Secondary";
    case OLD:
      return "Old";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

}