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 Sun, May 6, 2018 17:51-0400 for FHIR v3.4.0
033
034
035import org.hl7.fhir.exceptions.FHIRException;
036
037public enum NameUse {
038
039        /**
040         * Known as/conventional/the one you normally use
041         */
042        USUAL, 
043        /**
044         * The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
045         */
046        OFFICIAL, 
047        /**
048         * A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.
049         */
050        TEMP, 
051        /**
052         * A name that is used to address the person in an informal manner, but is not part of their formal or usual name
053         */
054        NICKNAME, 
055        /**
056         * Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)
057         */
058        ANONYMOUS, 
059        /**
060         * This name is no longer in use (or was never correct, but retained for records)
061         */
062        OLD, 
063        /**
064         * A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name
065         */
066        MAIDEN, 
067        /**
068         * added to help the parsers
069         */
070        NULL;
071        public static NameUse fromCode(String codeString) throws FHIRException {
072            if (codeString == null || "".equals(codeString))
073                return null;
074        if ("usual".equals(codeString))
075          return USUAL;
076        if ("official".equals(codeString))
077          return OFFICIAL;
078        if ("temp".equals(codeString))
079          return TEMP;
080        if ("nickname".equals(codeString))
081          return NICKNAME;
082        if ("anonymous".equals(codeString))
083          return ANONYMOUS;
084        if ("old".equals(codeString))
085          return OLD;
086        if ("maiden".equals(codeString))
087          return MAIDEN;
088        throw new FHIRException("Unknown NameUse code '"+codeString+"'");
089        }
090        public String toCode() {
091          switch (this) {
092            case USUAL: return "usual";
093            case OFFICIAL: return "official";
094            case TEMP: return "temp";
095            case NICKNAME: return "nickname";
096            case ANONYMOUS: return "anonymous";
097            case OLD: return "old";
098            case MAIDEN: return "maiden";
099            default: return "?";
100          }
101        }
102        public String getSystem() {
103          return "http://hl7.org/fhir/name-use";
104        }
105        public String getDefinition() {
106          switch (this) {
107            case USUAL: return "Known as/conventional/the one you normally use";
108            case OFFICIAL: return "The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called \"legal name\".";
109            case TEMP: return "A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.";
110            case NICKNAME: return "A name that is used to address the person in an informal manner, but is not part of their formal or usual name";
111            case ANONYMOUS: return "Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)";
112            case OLD: return "This name is no longer in use (or was never correct, but retained for records)";
113            case MAIDEN: return "A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name";
114            default: return "?";
115          }
116        }
117        public String getDisplay() {
118          switch (this) {
119            case USUAL: return "Usual";
120            case OFFICIAL: return "Official";
121            case TEMP: return "Temp";
122            case NICKNAME: return "Nickname";
123            case ANONYMOUS: return "Anonymous";
124            case OLD: return "Old";
125            case MAIDEN: return "Name changed for Marriage";
126            default: return "?";
127          }
128    }
129
130
131}
132