001package org.hl7.fhir.r4.model.codesystems;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009  
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030*/
031
032// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0
033
034import org.hl7.fhir.exceptions.FHIRException;
035
036public enum IdentifierUse {
037
038  /**
039   * The identifier recommended for display and use in real-world interactions.
040   */
041  USUAL,
042  /**
043   * The identifier considered to be most trusted for the identification of this
044   * item. Sometimes also known as "primary" and "main". The determination of
045   * "official" is subjective and implementation guides often provide additional
046   * guidelines for use.
047   */
048  OFFICIAL,
049  /**
050   * A temporary identifier.
051   */
052  TEMP,
053  /**
054   * An identifier that was assigned in secondary use - it serves to identify the
055   * object in a relative context, but cannot be consistently assigned to the same
056   * object again in a different context.
057   */
058  SECONDARY,
059  /**
060   * The identifier id no longer considered valid, but may be relevant for search
061   * purposes. E.g. Changes to identifier schemes, account merges, etc.
062   */
063  OLD,
064  /**
065   * added to help the parsers
066   */
067  NULL;
068
069  public static IdentifierUse fromCode(String codeString) throws FHIRException {
070    if (codeString == null || "".equals(codeString))
071      return null;
072    if ("usual".equals(codeString))
073      return USUAL;
074    if ("official".equals(codeString))
075      return OFFICIAL;
076    if ("temp".equals(codeString))
077      return TEMP;
078    if ("secondary".equals(codeString))
079      return SECONDARY;
080    if ("old".equals(codeString))
081      return OLD;
082    throw new FHIRException("Unknown IdentifierUse code '" + codeString + "'");
083  }
084
085  public String toCode() {
086    switch (this) {
087    case USUAL:
088      return "usual";
089    case OFFICIAL:
090      return "official";
091    case TEMP:
092      return "temp";
093    case SECONDARY:
094      return "secondary";
095    case OLD:
096      return "old";
097    case NULL:
098      return null;
099    default:
100      return "?";
101    }
102  }
103
104  public String getSystem() {
105    return "http://hl7.org/fhir/identifier-use";
106  }
107
108  public String getDefinition() {
109    switch (this) {
110    case USUAL:
111      return "The identifier recommended for display and use in real-world interactions.";
112    case OFFICIAL:
113      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.";
114    case TEMP:
115      return "A temporary identifier.";
116    case SECONDARY:
117      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.";
118    case OLD:
119      return "The identifier id no longer considered valid, but may be relevant for search purposes.  E.g. Changes to identifier schemes, account merges, etc.";
120    case NULL:
121      return null;
122    default:
123      return "?";
124    }
125  }
126
127  public String getDisplay() {
128    switch (this) {
129    case USUAL:
130      return "Usual";
131    case OFFICIAL:
132      return "Official";
133    case TEMP:
134      return "Temp";
135    case SECONDARY:
136      return "Secondary";
137    case OLD:
138      return "Old";
139    case NULL:
140      return null;
141    default:
142      return "?";
143    }
144  }
145
146}