001package org.hl7.fhir.r4.model.codesystems;
002
003/*-
004 * #%L
005 * org.hl7.fhir.r4
006 * %%
007 * Copyright (C) 2014 - 2019 Health Level 7
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023
024/*
025  Copyright (c) 2011+, HL7, Inc.
026  All rights reserved.
027  
028  Redistribution and use in source and binary forms, with or without modification, 
029  are permitted provided that the following conditions are met:
030  
031   * Redistributions of source code must retain the above copyright notice, this 
032     list of conditions and the following disclaimer.
033   * Redistributions in binary form must reproduce the above copyright notice, 
034     this list of conditions and the following disclaimer in the documentation 
035     and/or other materials provided with the distribution.
036   * Neither the name of HL7 nor the names of its contributors may be used to 
037     endorse or promote products derived from this software without specific 
038     prior written permission.
039  
040  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
041  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
042  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
043  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
044  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
045  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
046  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
047  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
048  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
049  POSSIBILITY OF SUCH DAMAGE.
050  
051*/
052
053// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0
054
055
056import org.hl7.fhir.exceptions.FHIRException;
057
058public enum NameUse {
059
060        /**
061         * Known as/conventional/the one you normally use.
062         */
063        USUAL, 
064        /**
065         * The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
066         */
067        OFFICIAL, 
068        /**
069         * 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.
070         */
071        TEMP, 
072        /**
073         * A name that is used to address the person in an informal manner, but is not part of their formal or usual name.
074         */
075        NICKNAME, 
076        /**
077         * Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
078         */
079        ANONYMOUS, 
080        /**
081         * This name is no longer in use (or was never correct, but retained for records).
082         */
083        OLD, 
084        /**
085         * 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.
086         */
087        MAIDEN, 
088        /**
089         * added to help the parsers
090         */
091        NULL;
092        public static NameUse fromCode(String codeString) throws FHIRException {
093            if (codeString == null || "".equals(codeString))
094                return null;
095        if ("usual".equals(codeString))
096          return USUAL;
097        if ("official".equals(codeString))
098          return OFFICIAL;
099        if ("temp".equals(codeString))
100          return TEMP;
101        if ("nickname".equals(codeString))
102          return NICKNAME;
103        if ("anonymous".equals(codeString))
104          return ANONYMOUS;
105        if ("old".equals(codeString))
106          return OLD;
107        if ("maiden".equals(codeString))
108          return MAIDEN;
109        throw new FHIRException("Unknown NameUse code '"+codeString+"'");
110        }
111        public String toCode() {
112          switch (this) {
113            case USUAL: return "usual";
114            case OFFICIAL: return "official";
115            case TEMP: return "temp";
116            case NICKNAME: return "nickname";
117            case ANONYMOUS: return "anonymous";
118            case OLD: return "old";
119            case MAIDEN: return "maiden";
120            default: return "?";
121          }
122        }
123        public String getSystem() {
124          return "http://hl7.org/fhir/name-use";
125        }
126        public String getDefinition() {
127          switch (this) {
128            case USUAL: return "Known as/conventional/the one you normally use.";
129            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\".";
130            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.";
131            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.";
132            case ANONYMOUS: return "Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).";
133            case OLD: return "This name is no longer in use (or was never correct, but retained for records).";
134            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.";
135            default: return "?";
136          }
137        }
138        public String getDisplay() {
139          switch (this) {
140            case USUAL: return "Usual";
141            case OFFICIAL: return "Official";
142            case TEMP: return "Temp";
143            case NICKNAME: return "Nickname";
144            case ANONYMOUS: return "Anonymous";
145            case OLD: return "Old";
146            case MAIDEN: return "Name changed for Marriage";
147            default: return "?";
148          }
149    }
150
151
152}
153