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

  /**
   * The request has been created but is not yet complete or ready for action.
   */
  DRAFT,
  /**
   * The request is in force and ready to be acted upon.
   */
  ACTIVE,
  /**
   * The request (and any implicit authorization to act) has been temporarily
   * withdrawn but is expected to resume in the future.
   */
  ONHOLD,
  /**
   * The request (and any implicit authorization to act) has been terminated prior
   * to the known full completion of the intended actions. No further activity
   * should occur.
   */
  REVOKED,
  /**
   * The activity described by the request has been fully performed. No further
   * activity will occur.
   */
  COMPLETED,
  /**
   * This request should never have existed and should be considered 'void'. (It
   * is possible that real-world decisions were based on it. If real-world
   * activity has occurred, the status should be "cancelled" rather than
   * "entered-in-error".).
   */
  ENTEREDINERROR,
  /**
   * The authoring/source 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, but the
   * authoring/source system does not know which.
   */
  UNKNOWN,
  /**
   * added to help the parsers
   */
  NULL;

  public static RequestStatus fromCode(String codeString) throws FHIRException {
    if (codeString == null || "".equals(codeString))
      return null;
    if ("draft".equals(codeString))
      return DRAFT;
    if ("active".equals(codeString))
      return ACTIVE;
    if ("on-hold".equals(codeString))
      return ONHOLD;
    if ("revoked".equals(codeString))
      return REVOKED;
    if ("completed".equals(codeString))
      return COMPLETED;
    if ("entered-in-error".equals(codeString))
      return ENTEREDINERROR;
    if ("unknown".equals(codeString))
      return UNKNOWN;
    throw new FHIRException("Unknown RequestStatus code '" + codeString + "'");
  }

  public String toCode() {
    switch (this) {
    case DRAFT:
      return "draft";
    case ACTIVE:
      return "active";
    case ONHOLD:
      return "on-hold";
    case REVOKED:
      return "revoked";
    case COMPLETED:
      return "completed";
    case ENTEREDINERROR:
      return "entered-in-error";
    case UNKNOWN:
      return "unknown";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

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

  public String getDefinition() {
    switch (this) {
    case DRAFT:
      return "The request has been created but is not yet complete or ready for action.";
    case ACTIVE:
      return "The request is in force and ready to be acted upon.";
    case ONHOLD:
      return "The request (and any implicit authorization to act) has been temporarily withdrawn but is expected to resume in the future.";
    case REVOKED:
      return "The request (and any implicit authorization to act) has been terminated prior to the known full completion of the intended actions.  No further activity should occur.";
    case COMPLETED:
      return "The activity described by the request has been fully performed.  No further activity will occur.";
    case ENTEREDINERROR:
      return "This request should never have existed and should be considered 'void'.  (It is possible that real-world decisions were based on it.  If real-world activity has occurred, the status should be \"cancelled\" rather than \"entered-in-error\".).";
    case UNKNOWN:
      return "The authoring/source 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,  but the authoring/source system does not know which.";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

  public String getDisplay() {
    switch (this) {
    case DRAFT:
      return "Draft";
    case ACTIVE:
      return "Active";
    case ONHOLD:
      return "On Hold";
    case REVOKED:
      return "Revoked";
    case COMPLETED:
      return "Completed";
    case ENTEREDINERROR:
      return "Entered in Error";
    case UNKNOWN:
      return "Unknown";
    case NULL:
      return null;
    default:
      return "?";
    }
  }

}