org.hl7.fhir.r4.model.codesystems.BindingStrength Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.hl7.fhir.r4 Show documentation
Builds the hapi fhir r4. Requires hapi-fhir-base and hapi-fhir-utilities be built first and be excluded from any other poms requiring it.
The newest version!
package org.hl7.fhir.r4.model.codesystems;

/*
  Copyright (c) 2011+, HL7, Inc.
  All rights reserved.
  
  Redistribution and use in source and binary forms, with or without modification, 
  are permitted provided that the following conditions are met:
  
   * Redistributions of source code must retain the above copyright notice, this 
     list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice, 
     this list of conditions and the following disclaimer in the documentation 
     and/or other materials provided with the distribution.
   * Neither the name of HL7 nor the names of its contributors may be used to 
     endorse or promote products derived from this software without specific 
     prior written permission.
  
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
  POSSIBILITY OF SUCH DAMAGE.
  
*/

// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0

import org.hl7.fhir.exceptions.FHIRException;

public enum BindingStrength {

  /**
   * To be conformant, the concept in this element SHALL be from the specified
   * value set.
   */
  REQUIRED,
  /**
   * 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.
   */
  EXTENSIBLE,
  /**
   * Instances are encouraged to draw from the specified codes for
   * interoperability purposes but are not required to do so to be considered
   * conformant.
   */
  PREFERRED,
  /**
   * 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.
   */
  EXAMPLE,
  /**
   * added to help the parsers
   */
  NULL;

  public static BindingStrength fromCode(String codeString) throws FHIRException {
    if (codeString == null || "".equals(codeString))
      return null;
    if ("required".equals(codeString))
      return REQUIRED;
    if ("extensible".equals(codeString))
      return EXTENSIBLE;
    if ("preferred".equals(codeString))
      return PREFERRED;
    if ("example".equals(codeString))
      return EXAMPLE;
    throw new FHIRException("Unknown BindingStrength code '" + codeString + "'");
  }

  public String toCode() {
    switch (this) {
    case REQUIRED:
      return "required";
    case EXTENSIBLE:
      return "extensible";
    case PREFERRED:
      return "preferred";
    case EXAMPLE:
      return "example";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

  public String getSystem() {
    return "http://hl7.org/fhir/binding-strength";
  }

  public String getDefinition() {
    switch (this) {
    case REQUIRED:
      return "To be conformant, the concept in this element SHALL be from the specified value set.";
    case EXTENSIBLE:
      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.";
    case PREFERRED:
      return "Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.";
    case EXAMPLE:
      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.";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

  public String getDisplay() {
    switch (this) {
    case REQUIRED:
      return "Required";
    case EXTENSIBLE:
      return "Extensible";
    case PREFERRED:
      return "Preferred";
    case EXAMPLE:
      return "Example";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

}