org.hl7.fhir.r4.model.codesystems.MedicationAdminStatus 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 MedicationAdminStatus {

  /**
   * The administration has started but has not yet completed.
   */
  INPROGRESS,
  /**
   * The administration was terminated prior to any impact on the subject (though
   * preparatory actions may have been taken)
   */
  NOTDONE,
  /**
   * Actions implied by the administration have been temporarily halted, but are
   * expected to continue later. May also be called 'suspended'.
   */
  ONHOLD,
  /**
   * All actions that are implied by the administration have occurred.
   */
  COMPLETED,
  /**
   * The administration was entered in error and therefore nullified.
   */
  ENTEREDINERROR,
  /**
   * Actions implied by the administration have been permanently halted, before
   * all of them occurred.
   */
  STOPPED,
  /**
   * The authoring system does not know which of the status values currently
   * applies for this request. Note: This concept is not to be used for 'other' -
   * one of the listed statuses is presumed to apply, it's just not known which
   * one.
   */
  UNKNOWN,
  /**
   * added to help the parsers
   */
  NULL;

  public static MedicationAdminStatus fromCode(String codeString) throws FHIRException {
    if (codeString == null || "".equals(codeString))
      return null;
    if ("in-progress".equals(codeString))
      return INPROGRESS;
    if ("not-done".equals(codeString))
      return NOTDONE;
    if ("on-hold".equals(codeString))
      return ONHOLD;
    if ("completed".equals(codeString))
      return COMPLETED;
    if ("entered-in-error".equals(codeString))
      return ENTEREDINERROR;
    if ("stopped".equals(codeString))
      return STOPPED;
    if ("unknown".equals(codeString))
      return UNKNOWN;
    throw new FHIRException("Unknown MedicationAdminStatus code '" + codeString + "'");
  }

  public String toCode() {
    switch (this) {
    case INPROGRESS:
      return "in-progress";
    case NOTDONE:
      return "not-done";
    case ONHOLD:
      return "on-hold";
    case COMPLETED:
      return "completed";
    case ENTEREDINERROR:
      return "entered-in-error";
    case STOPPED:
      return "stopped";
    case UNKNOWN:
      return "unknown";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

  public String getSystem() {
    return "http://terminology.hl7.org/CodeSystem/medication-admin-status";
  }

  public String getDefinition() {
    switch (this) {
    case INPROGRESS:
      return "The administration has started but has not yet completed.";
    case NOTDONE:
      return "The administration was terminated prior to any impact on the subject (though preparatory actions may have been taken)";
    case ONHOLD:
      return "Actions implied by the administration have been temporarily halted, but are expected to continue later. May also be called 'suspended'.";
    case COMPLETED:
      return "All actions that are implied by the administration have occurred.";
    case ENTEREDINERROR:
      return "The administration was entered in error and therefore nullified.";
    case STOPPED:
      return "Actions implied by the administration have been permanently halted, before all of them occurred.";
    case UNKNOWN:
      return "The authoring system does not know which of the status values currently applies for this request. Note: This concept is not to be used for 'other' - one of the listed statuses is presumed to apply, it's just not known which one.";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

  public String getDisplay() {
    switch (this) {
    case INPROGRESS:
      return "In Progress";
    case NOTDONE:
      return "Not Done";
    case ONHOLD:
      return "On Hold";
    case COMPLETED:
      return "Completed";
    case ENTEREDINERROR:
      return "Entered in Error";
    case STOPPED:
      return "Stopped";
    case UNKNOWN:
      return "Unknown";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

}