Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/request-status (JSON)

Patient Care Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code SystemRequestStatus

{
  "resourceType" : "CodeSystem",
  "id" : "request-status",
  "meta" : {
    "lastUpdated" : "2023-03-26T15:21:02.749+11:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/request-status</code> 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\">draft<a name=\"request-status-draft\"> </a></td><td>Draft</td><td>The request has been created but is not yet complete or ready for action.</td></tr><tr><td style=\"white-space:nowrap\">active<a name=\"request-status-active\"> </a></td><td>Active</td><td>The request is in force and ready to be acted upon.</td></tr><tr><td style=\"white-space:nowrap\">on-hold<a name=\"request-status-on-hold\"> </a></td><td>On Hold</td><td>The request (and any implicit authorization to act) has been temporarily withdrawn but is expected to resume in the future.</td></tr><tr><td style=\"white-space:nowrap\">revoked<a name=\"request-status-revoked\"> </a></td><td>Revoked</td><td>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.</td></tr><tr><td style=\"white-space:nowrap\">completed<a name=\"request-status-completed\"> </a></td><td>Completed</td><td>The activity described by the request has been fully performed.  No further activity will occur.</td></tr><tr><td style=\"white-space:nowrap\">entered-in-error<a name=\"request-status-entered-in-error\"> </a></td><td>Entered in Error</td><td>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 &quot;revoked&quot; rather than &quot;entered-in-error&quot;.).</td></tr><tr><td style=\"white-space:nowrap\">unknown<a name=\"request-status-unknown\"> </a></td><td>Unknown</td><td>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 &quot;other&quot; - one of the listed statuses is presumed to apply,  but the authoring/source system does not know which.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pc"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 4
  }],
  "url" : "http://hl7.org/fhir/request-status",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.112"
  }],
  "version" : "5.0.0",
  "name" : "RequestStatus",
  "title" : "RequestStatus",
  "status" : "draft",
  "experimental" : true,
  "date" : "2023-03-26T15:21:02+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Codes identifying the lifecycle stage of a request.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/request-status",
  "content" : "complete",
  "concept" : [{
    "code" : "draft",
    "display" : "Draft",
    "definition" : "The request has been created but is not yet complete or ready for action."
  },
  {
    "code" : "active",
    "display" : "Active",
    "definition" : "The request is in force and ready to be acted upon."
  },
  {
    "code" : "on-hold",
    "display" : "On Hold",
    "definition" : "The request (and any implicit authorization to act) has been temporarily withdrawn but is expected to resume in the future."
  },
  {
    "code" : "revoked",
    "display" : "Revoked",
    "definition" : "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."
  },
  {
    "code" : "completed",
    "display" : "Completed",
    "definition" : "The activity described by the request has been fully performed.  No further activity will occur."
  },
  {
    "code" : "entered-in-error",
    "display" : "Entered in Error",
    "definition" : "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 \"revoked\" rather than \"entered-in-error\".)."
  },
  {
    "code" : "unknown",
    "display" : "Unknown",
    "definition" : "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."
  }]
}

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.