Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). 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

Using Codes Code Systems Value Sets Concept Maps Identifier Systems 4.3.14.96 Code System http://terminology.hl7.org/CodeSystem/special-values

Example CodeSystem/contract-status (Turtle)

Committee:
FHIR Infrastructure Financial Management Work Group   Maturity Level : 0 N/A Informative Use Context Standards Status : Any This is a code system defined by the FHIR project. Summary Defining URL: http://terminology.hl7.org/CodeSystem/special-values Version: 4.0.1 Name: SpecialValues Title: SpecialValues Definition: Informative A set of generally useful codes defined so they can be included in value sets.
    FHIR Infrastructure
  • Narrative Work Group OID: 2.16.840.1.113883.4.642.4.1049 (for OID based terminology systems) Source Resource
  • XML / JSON This Code system is used in the following value sets: ValueSet: SpecialValues (A set of generally useful codes defined so they can be included in value sets.) ValueSet: SpecialValues (A set of generally useful codes defined so they can be included in value sets.)
    • 4.3.14.96.1 Content
  • 4.3.14.96.2 JSON SpecialValues
  • TTL A set of generally useful codes defined so they can be included in value sets.

This code system http://terminology.hl7.org/CodeSystem/special-values defines the following codes: Code Display Definition Comments true true Boolean true. false false Boolean false. trace Raw Turtle Trace Amount Detected The content is greater than zero, but too small to be quantified. sufficient (+ also see Turtle/RDF Format Specification Sufficient Quantity The specific quantity is not known, but is known to be non-zero and is not specified because it makes up the bulk of the material. used in formulations (e.g. 'Add 10mg of ingredient X, 50mg of ingredient Y, and sufficient quantity of water to 100mL.' This code would be used to express the quantity of water. ) withdrawn Value Withdrawn The value is no longer available. nil-known Nil Known The are no known applicable values in this context. The existence of this subject to review  

See the full registry of code systems defined as part of FHIR. Explanation of the columns that may appear on this page: Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. See Code System Definition for further information. Source The source of the definition of the code (when the value set draws in codes defined elsewhere) Code The code (used as the code in the resource instance). If the code is in italics, this indicates SystemContractStatus 


@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

# - resource -------------------------------------------------------------------

[] a fhir:CodeSystem;
  fhir:Resource.id [ fhir:value "contract-status"];
  fhir:Resource.meta [
     fhir:Meta.lastUpdated [ fhir:value "2022-09-10T04:52:37.223+10:00" ];
     fhir:Meta.profile [ fhir:value "http://hl7.org/fhir/StructureDefinition/shareablecodesystem" ]
  ];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ]
  ];
  fhir:DomainResource.extension [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ];
     fhir:Extension.value [ fhir:value "fm" ]
  ];
  fhir:CanonicalResource.url [ fhir:value "http://hl7.org/fhir/contract-status"];
  fhir:CanonicalResource.identifier [
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.4.744" ]
  ];
  fhir:CanonicalResource.version [ fhir:value "5.0.0-ballot"];
  fhir:CanonicalResource.name [ fhir:value "ContractStatus"];
  fhir:CanonicalResource.status [ fhir:value "draft"];
  fhir:CanonicalResource.experimental [ fhir:value "true"];
  fhir:CanonicalResource.date [ fhir:value "2017-02-13"];
  fhir:CanonicalResource.publisher [ fhir:value "HL7 International"];
  fhir:CanonicalResource.contact [
     fhir:ContactDetail.name [ fhir:value "FHIR project team" ];
     fhir:ContactDetail.telecom [
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ]
  ];
  fhir:CanonicalResource.description [ fhir:value "This CodeSystem contains FHIR-defined contract status types. Each definition includes usage notes explaining the precedence order in contract lifecycle - i.e., while only some stages are required, the order in which they may occur is deterministic; and a map to comparable FHIR and v.3 status codes. It follows guidance about use of status codes in FHIR at http://hl7.org/fhir/2022Sep/sc.html."];
  fhir:CodeSystem.url [ fhir:value "http://hl7.org/fhir/contract-status"];
  fhir:CodeSystem.identifier [
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.4.744" ]
  ];
  fhir:CodeSystem.version [ fhir:value "5.0.0-ballot"];
  fhir:CodeSystem.name [ fhir:value "ContractStatus"];
  fhir:CodeSystem.status [ fhir:value "draft"];
  fhir:CodeSystem.experimental [ fhir:value "true"];
  fhir:CodeSystem.date [ fhir:value "2017-02-13"];
  fhir:CodeSystem.publisher [ fhir:value "HL7 International"];
  fhir:CodeSystem.contact [
     fhir:ContactDetail.name [ fhir:value "FHIR project team" ];
     fhir:ContactDetail.telecom [
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ]
  ];
  fhir:CodeSystem.description [ fhir:value "This CodeSystem contains FHIR-defined contract status types. Each definition includes usage notes explaining the precedence order in contract lifecycle - i.e., while only some stages are required, the order in which they may occur is deterministic; and a map to comparable FHIR and v.3 status codes. It follows guidance about use of status codes in FHIR at http://hl7.org/fhir/2022Sep/sc.html."];
  fhir:CodeSystem.caseSensitive [ fhir:value "true"];
  fhir:CodeSystem.content [ fhir:value "complete"];
  fhir:CodeSystem.concept [
     fhir:ConceptDefinitionComponent.code [ fhir:value "amended" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Amended" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "appended" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Appended" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "cancelled" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Cancelled" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "disputed" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Disputed" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "entered-in-error" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Entered in Error" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Contract was created in error. No Precedence Order.  Status may be applied to a Contract with any status." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "executable" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Executable" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "executed" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Executed" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "negotiable" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Negotiable" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "offered" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Offered" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "policy" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Policy" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "rejected" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Rejected" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "renewed" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Renewed" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "revoked" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Revoked" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "A Contract that is rescinded.  May be required prior to replacing with an updated Contract. Comparable FHIR and v.3 status codes: nullified." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "resolved" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Resolved" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "terminated" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Terminated" ];
     fhir:ConceptDefinitionComponent.definition [ fhir: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." ]
  ] .

# -------------------------------------------------------------------------------------

Usage note: every effort has been made to ensure that the code is examples are correct and useful, but they are not selectable ('Abstract') Display The display (used in the display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application Definition An explanation of the meaning normative part of the concept Comments Additional notes about how to use the code specification.