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 BindingStrength {
037
038  /**
039   * To be conformant, the concept in this element SHALL be from the specified
040   * value set.
041   */
042  REQUIRED,
043  /**
044   * To be conformant, the concept in this element SHALL be from the specified
045   * value set if any of the codes within the value set can apply to the concept
046   * being communicated. If the value set does not cover the concept (based on
047   * human review), alternate codings (or, data type allowing, text) may be
048   * included instead.
049   */
050  EXTENSIBLE,
051  /**
052   * Instances are encouraged to draw from the specified codes for
053   * interoperability purposes but are not required to do so to be considered
054   * conformant.
055   */
056  PREFERRED,
057  /**
058   * Instances are not expected or even encouraged to draw from the specified
059   * value set. The value set merely provides examples of the types of concepts
060   * intended to be included.
061   */
062  EXAMPLE,
063  /**
064   * added to help the parsers
065   */
066  NULL;
067
068  public static BindingStrength fromCode(String codeString) throws FHIRException {
069    if (codeString == null || "".equals(codeString))
070      return null;
071    if ("required".equals(codeString))
072      return REQUIRED;
073    if ("extensible".equals(codeString))
074      return EXTENSIBLE;
075    if ("preferred".equals(codeString))
076      return PREFERRED;
077    if ("example".equals(codeString))
078      return EXAMPLE;
079    throw new FHIRException("Unknown BindingStrength code '" + codeString + "'");
080  }
081
082  public String toCode() {
083    switch (this) {
084    case REQUIRED:
085      return "required";
086    case EXTENSIBLE:
087      return "extensible";
088    case PREFERRED:
089      return "preferred";
090    case EXAMPLE:
091      return "example";
092    case NULL:
093      return null;
094    default:
095      return "?";
096    }
097  }
098
099  public String getSystem() {
100    return "http://hl7.org/fhir/binding-strength";
101  }
102
103  public String getDefinition() {
104    switch (this) {
105    case REQUIRED:
106      return "To be conformant, the concept in this element SHALL be from the specified value set.";
107    case EXTENSIBLE:
108      return "To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated.  If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.";
109    case PREFERRED:
110      return "Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.";
111    case EXAMPLE:
112      return "Instances are not expected or even encouraged to draw from the specified value set.  The value set merely provides examples of the types of concepts intended to be included.";
113    case NULL:
114      return null;
115    default:
116      return "?";
117    }
118  }
119
120  public String getDisplay() {
121    switch (this) {
122    case REQUIRED:
123      return "Required";
124    case EXTENSIBLE:
125      return "Extensible";
126    case PREFERRED:
127      return "Preferred";
128    case EXAMPLE:
129      return "Example";
130    case NULL:
131      return null;
132    default:
133      return "?";
134    }
135  }
136
137}