Package org.hl7.fhir.r4.model

Enum Contract.ContractStatus

java.lang.Object
java.lang.Enum<Contract.ContractStatus>
org.hl7.fhir.r4.model.Contract.ContractStatus
All Implemented Interfaces:
Serializable, Comparable<Contract.ContractStatus>
Enclosing class:
Contract
public static enum Contract.ContractStatus extends Enum<Contract.ContractStatus>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AMENDED
    Contract is augmented with additional information to correct errors in a predecessor or to updated values in a predecessor.
    APPENDED
    Contract is augmented with additional information that was missing from a predecessor Contract.
    CANCELLED
    Contract is terminated due to failure of the Grantor and/or the Grantee to fulfil one or more contract provisions.
    DISPUTED
    Contract is pended to rectify failure of the Grantor or the Grantee to fulfil contract provision(s).
    ENTEREDINERROR
    Contract was created in error.
    EXECUTABLE
    Contract execution pending; may be executed when either the Grantor or the Grantee accepts the contract provisions by signing.
    EXECUTED
    Contract is activated for period stipulated when both the Grantor and Grantee have signed it.
    NEGOTIABLE
    Contract execution is suspended while either or both the Grantor and Grantee propose and consider new or revised contract provisions.
    NULL
    added to help the parsers with the generic types
    OFFERED
    Contract is a proposal by either the Grantor or the Grantee.
    POLICY
    Contract template is available as the basis for an application or offer by the Grantor or Grantee.
    REJECTED
    Execution of the Contract is not completed because either or both the Grantor and Grantee decline to accept some or all of the contract provisions.
    RENEWED
    Beginning of a successor Contract at the termination of predecessor Contract lifecycle.
    RESOLVED
    Contract is reactivated after being pended because of faulty execution.
    REVOKED
    A Contract that is rescinded.
    TERMINATED
    Contract reaches its expiry date. It might or might not be renewed or renegotiated.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Contract.ContractStatus
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static Contract.ContractStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Contract.ContractStatus[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • AMENDED

      public static final Contract.ContractStatus AMENDED
      Contract is augmented with additional information to correct errors in a predecessor or to updated values in a predecessor. Usage: Contract altered within effective time. Precedence Order = 9. Comparable FHIR and v.3 status codes: revised; replaced.

    • APPENDED

      public static final Contract.ContractStatus APPENDED
      Contract is augmented with additional information that was missing from a predecessor Contract. Usage: Contract altered within effective time. Precedence Order = 9. Comparable FHIR and v.3 status codes: updated, replaced.

    • CANCELLED

      public static final Contract.ContractStatus CANCELLED
      Contract is terminated due to failure of the Grantor and/or the Grantee to fulfil one or more contract provisions. Usage: Abnormal contract termination. Precedence Order = 10. Comparable FHIR and v.3 status codes: stopped; failed; aborted.

    • DISPUTED

      public static final Contract.ContractStatus DISPUTED
      Contract is pended to rectify failure of the Grantor or the Grantee to fulfil contract provision(s). E.g., Grantee complaint about Grantor's failure to comply with contract provisions. Usage: Contract pended. Precedence Order = 7. Comparable FHIR and v.3 status codes: on hold; pended; suspended.

    • ENTEREDINERROR

      public static final Contract.ContractStatus ENTEREDINERROR
      Contract was created in error. No Precedence Order. Status may be applied to a Contract with any status.

    • EXECUTABLE

      public static final Contract.ContractStatus EXECUTABLE
      Contract execution pending; may be executed when either the Grantor or the Grantee accepts the contract provisions by signing. I.e., where either the Grantor or the Grantee has signed, but not both. E.g., when an insurance applicant signs the insurers application, which references the policy. Usage: Optional first step of contract execution activity. May be skipped and contracting activity moves directly to executed state. Precedence Order = 3. Comparable FHIR and v.3 status codes: draft; preliminary; planned; intended; active.

    • EXECUTED

      public static final Contract.ContractStatus EXECUTED
      Contract is activated for period stipulated when both the Grantor and Grantee have signed it. Usage: Required state for normal completion of contracting activity. Precedence Order = 6. Comparable FHIR and v.3 status codes: accepted; completed.

    • NEGOTIABLE

      public static final Contract.ContractStatus NEGOTIABLE
      Contract execution is suspended while either or both the Grantor and Grantee propose and consider new or revised contract provisions. I.e., where the party which has not signed proposes changes to the terms. E .g., a life insurer declines to agree to the signed application because the life insurer has evidence that the applicant, who asserted to being younger or a non-smoker to get a lower premium rate - but offers instead to agree to a higher premium based on the applicants actual age or smoking status. Usage: Optional contract activity between executable and executed state. Precedence Order = 4. Comparable FHIR and v.3 status codes: in progress; review; held.

    • OFFERED

      public static final Contract.ContractStatus OFFERED
      Contract is a proposal by either the Grantor or the Grantee. Aka - A Contract hard copy or electronic 'template', 'form' or 'application'. E.g., health insurance application; consent directive form. Usage: Beginning of contract negotiation, which may have been completed as a precondition because used for 0..* contracts. Precedence Order = 2. Comparable FHIR and v.3 status codes: requested; new.

    • POLICY

      public static final Contract.ContractStatus POLICY
      Contract template is available as the basis for an application or offer by the Grantor or Grantee. E.g., health insurance policy; consent directive policy. Usage: Required initial contract activity, which may have been completed as a precondition because used for 0..* contracts. Precedence Order = 1. Comparable FHIR and v.3 status codes: proposed; intended.

    • REJECTED

      public static final Contract.ContractStatus REJECTED
      Execution of the Contract is not completed because either or both the Grantor and Grantee decline to accept some or all of the contract provisions. Usage: Optional contract activity between executable and abnormal termination. Precedence Order = 5. Comparable FHIR and v.3 status codes: stopped; cancelled.

    • RENEWED

      public static final Contract.ContractStatus RENEWED
      Beginning of a successor Contract at the termination of predecessor Contract lifecycle. Usage: Follows termination of a preceding Contract that has reached its expiry date. Precedence Order = 13. Comparable FHIR and v.3 status codes: superseded.

    • REVOKED

      public static final Contract.ContractStatus REVOKED
      A Contract that is rescinded. May be required prior to replacing with an updated Contract. Comparable FHIR and v.3 status codes: nullified.

    • RESOLVED

      public static final Contract.ContractStatus RESOLVED
      Contract is reactivated after being pended because of faulty execution. *E.g., competency of the signer(s), or where the policy is substantially different from and did not accompany the application/form so that the applicant could not compare them. Aka - ''reactivated''. Usage: Optional stage where a pended contract is reactivated. Precedence Order = 8. Comparable FHIR and v.3 status codes: reactivated.

    • TERMINATED

      public static final Contract.ContractStatus TERMINATED
      Contract reaches its expiry date. It might or might not be renewed or renegotiated. Usage: Normal end of contract period. Precedence Order = 12. Comparable FHIR and v.3 status codes: Obsoleted.

    • NULL

      public static final Contract.ContractStatus NULL
      added to help the parsers with the generic types

  • Method Details

    • values

      public static Contract.ContractStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Contract.ContractStatus valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromCode

      public static Contract.ContractStatus fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • toCode

      public String toCode()

    • getSystem

      public String getSystem()

    • getDefinition

      public String getDefinition()

    • getDisplay

      public String getDisplay()