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 MatchGrade {
037
038  /**
039   * This record meets the matching criteria to be automatically considered as a
040   * full match.
041   */
042  CERTAIN,
043  /**
044   * This record is a close match, but not a certain match. Additional review
045   * (e.g. by a human) may be required before using this as a match.
046   */
047  PROBABLE,
048  /**
049   * This record may be a matching one. Additional review (e.g. by a human) SHOULD
050   * be performed before using this as a match.
051   */
052  POSSIBLE,
053  /**
054   * This record is known not to be a match. Note that usually non-matching
055   * records are not returned, but in some cases records previously or likely
056   * considered as a match may specifically be negated by the matching engine.
057   */
058  CERTAINLYNOT,
059  /**
060   * added to help the parsers
061   */
062  NULL;
063
064  public static MatchGrade fromCode(String codeString) throws FHIRException {
065    if (codeString == null || "".equals(codeString))
066      return null;
067    if ("certain".equals(codeString))
068      return CERTAIN;
069    if ("probable".equals(codeString))
070      return PROBABLE;
071    if ("possible".equals(codeString))
072      return POSSIBLE;
073    if ("certainly-not".equals(codeString))
074      return CERTAINLYNOT;
075    throw new FHIRException("Unknown MatchGrade code '" + codeString + "'");
076  }
077
078  public String toCode() {
079    switch (this) {
080    case CERTAIN:
081      return "certain";
082    case PROBABLE:
083      return "probable";
084    case POSSIBLE:
085      return "possible";
086    case CERTAINLYNOT:
087      return "certainly-not";
088    case NULL:
089      return null;
090    default:
091      return "?";
092    }
093  }
094
095  public String getSystem() {
096    return "http://terminology.hl7.org/CodeSystem/match-grade";
097  }
098
099  public String getDefinition() {
100    switch (this) {
101    case CERTAIN:
102      return "This record meets the matching criteria to be automatically considered as a full match.";
103    case PROBABLE:
104      return "This record is a close match, but not a certain match. Additional review (e.g. by a human) may be required before using this as a match.";
105    case POSSIBLE:
106      return "This record may be a matching one. Additional review (e.g. by a human) SHOULD be performed before using this as a match.";
107    case CERTAINLYNOT:
108      return "This record is known not to be a match. Note that usually non-matching records are not returned, but in some cases records previously or likely considered as a match may specifically be negated by the matching engine.";
109    case NULL:
110      return null;
111    default:
112      return "?";
113    }
114  }
115
116  public String getDisplay() {
117    switch (this) {
118    case CERTAIN:
119      return "Certain Match";
120    case PROBABLE:
121      return "Probable Match";
122    case POSSIBLE:
123      return "Possible Match";
124    case CERTAINLYNOT:
125      return "Certainly Not a Match";
126    case NULL:
127      return null;
128    default:
129      return "?";
130    }
131  }
132
133}