This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Financial Management Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
Definition for Code System ContractResourceStatusCodes
<?xml version="1.0" encoding="UTF-8"?> <CodeSystem xmlns="http://hl7.org/fhir"> <id value="contract-status"/> <meta> <lastUpdated value="2020-08-20T17:41:31.970+10:00"/> <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p> This code system http://hl7.org/fhir/contract-status defines the following codes:</p> <table class="codes"> <tr> <td style="white-space:nowrap"> <b> Code</b> </td> <td> <b> Display</b> </td> <td> <b> Definition</b> </td> </tr> <tr> <td style="white-space:nowrap">amended <a name="contract-status-amended"> </a> </td> <td> Amended</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">appended <a name="contract-status-appended"> </a> </td> <td> Appended</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">cancelled <a name="contract-status-cancelled"> </a> </td> <td> Cancelled</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">disputed <a name="contract-status-disputed"> </a> </td> <td> Disputed</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">entered-in-error <a name="contract-status-entered-in-error"> </a> </td> <td> Entered in Error</td> <td> Contract was created in error. No Precedence Order. Status may be applied to a Contract with any status.</td> </tr> <tr> <td style="white-space:nowrap">executable <a name="contract-status-executable"> </a> </td> <td> Executable</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">executed <a name="contract-status-executed"> </a> </td> <td> Executed</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">negotiable <a name="contract-status-negotiable"> </a> </td> <td> Negotiable</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">offered <a name="contract-status-offered"> </a> </td> <td> Offered</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">policy <a name="contract-status-policy"> </a> </td> <td> Policy</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">rejected <a name="contract-status-rejected"> </a> </td> <td> Rejected</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">renewed <a name="contract-status-renewed"> </a> </td> <td> Renewed</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">revoked <a name="contract-status-revoked"> </a> </td> <td> Revoked</td> <td> A Contract that is rescinded. May be required prior to replacing with an updated Contract. Comparable FHIR and v.3 status codes: nullified.</td> </tr> <tr> <td style="white-space:nowrap">resolved <a name="contract-status-resolved"> </a> </td> <td> Resolved</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">terminated <a name="contract-status-terminated"> </a> </td> <td> Terminated</td> <td> 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.</td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fm"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1"/> </extension> <url value="http://hl7.org/fhir/contract-status"/> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:2.16.840.1.113883.4.642.1.744"/> </identifier> <version value="4.5.0"/> <name value="ContractResourceStatusCodes"/> <title value="Contract Resource Status Codes"/> <status value="draft"/> <experimental value="false"/> <publisher value="Financial Management"/> <contact> <name value="FHIR project team"/> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <description value="This value set contract specific codes for status."/> <copyright value="HL7 International."/> <caseSensitive value="true"/> <valueSet value="http://hl7.org/fhir/ValueSet/contract-status"/> <content value="complete"/> <concept> <code value="amended"/> <display value="Amended"/> <definition value="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."/> </concept> <concept> <code value="appended"/> <display value="Appended"/> <definition value="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."/> </concept> <concept> <code value="cancelled"/> <display value="Cancelled"/> <definition value="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."/> </concept> <concept> <code value="disputed"/> <display value="Disputed"/> <definition value="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."/> </concept> <concept> <code value="entered-in-error"/> <display value="Entered in Error"/> <definition value="Contract was created in error. No Precedence Order. Status may be applied to a Contract with any status."/> </concept> <concept> <code value="executable"/> <display value="Executable"/> <definition value="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."/> </concept> <concept> <code value="executed"/> <display value="Executed"/> <definition value="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."/> </concept> <concept> <code value="negotiable"/> <display value="Negotiable"/> <definition value="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."/> </concept> <concept> <code value="offered"/> <display value="Offered"/> <definition value="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."/> </concept> <concept> <code value="policy"/> <display value="Policy"/> <definition value="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."/> </concept> <concept> <code value="rejected"/> <display value="Rejected"/> <definition value=" 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."/> </concept> <concept> <code value="renewed"/> <display value="Renewed"/> <definition value="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."/> </concept> <concept> <code value="revoked"/> <display value="Revoked"/> <definition value="A Contract that is rescinded. May be required prior to replacing with an updated Contract. Comparable FHIR and v.3 status codes: nullified."/> </concept> <concept> <code value="resolved"/> <display value="Resolved"/> <definition value="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."/> </concept> <concept> <code value="terminated"/> <display value="Terminated"/> <definition value="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."/> </concept> </CodeSystem>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.