FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 - Version 0.0.1-snapshot-2. See the Directory of published versions

: Canonical Status Codes for FHIR Resources - JSON Representation

Page standards status: Informative Maturity Level: 3

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "resource-status",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n            <p>This code system \n              <code>http://hl7.org/fhir/resource-status</code> defines the following codes:\n            </p>\n            <table class=\"codes\">\n              <tr>\n                <td style=\"white-space:nowrap\">\n                  <b>Code</b>\n                </td>\n                <td>\n                  <b>Definition</b>\n                </td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">error\n                  <a name=\"resource-status-error\"> </a>\n                </td>\n                <td>The resource was created in error, and should not be treated as valid (note: in many cases, for various data integrity related reasons, the information cannot be removed from the record)</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">proposed\n                  <a name=\"resource-status-proposed\"> </a>\n                </td>\n                <td>The resource describes an action or plan that is proposed, and not yet approved by the participants</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">planned\n                  <a name=\"resource-status-planned\"> </a>\n                </td>\n                <td>The resource describes a course of action that is planned and agreed/approved, but at the time of recording was still future</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">draft\n                  <a name=\"resource-status-draft\"> </a>\n                </td>\n                <td>The information in the resource is still being prepared and edited</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">requested\n                  <a name=\"resource-status-requested\"> </a>\n                </td>\n                <td>A fulfiller has been asked to perform this action, but it has not yet occurred</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">received\n                  <a name=\"resource-status-received\"> </a>\n                </td>\n                <td>The fulfiller has received the request, but not yet agreed to carry out the action</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">declined\n                  <a name=\"resource-status-declined\"> </a>\n                </td>\n                <td>The fulfiller chose not to perform the action</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">accepted\n                  <a name=\"resource-status-accepted\"> </a>\n                </td>\n                <td>The fulfiller has decided to perform the action, and plans are in train to do this in the future</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">arrived\n                  <a name=\"resource-status-arrived\"> </a>\n                </td>\n                <td>The pre-conditions for the action are all fulfilled, and it is imminent</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">active\n                  <a name=\"resource-status-active\"> </a>\n                </td>\n                <td>The resource describes information that is currently valid or a process that is presently occuring</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">suspended\n                  <a name=\"resource-status-suspended\"> </a>\n                </td>\n                <td>The process described/requested in this resource has been halted for some reason</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">failed\n                  <a name=\"resource-status-failed\"> </a>\n                </td>\n                <td>The process described/requested in the resource could not be completed, and no further action is planned</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">replaced\n                  <a name=\"resource-status-replaced\"> </a>\n                </td>\n                <td>The information in this resource has been replaced by information in another resource</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">complete\n                  <a name=\"resource-status-complete\"> </a>\n                </td>\n                <td>The process described/requested in the resource has been completed, and no further action is planned</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">inactive\n                  <a name=\"resource-status-inactive\"> </a>\n                </td>\n                <td>The resource describes information that is no longer valid or a process that is stopped occurring</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">abandoned\n                  <a name=\"resource-status-abandoned\"> </a>\n                </td>\n                <td>The process described/requested in the resource did not complete - usually due to some workflow error, and no further action is planned</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">unknown\n                  <a name=\"resource-status-unknown\"> </a>\n                </td>\n                <td>Authoring system does not know the status</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">unconfirmed\n                  <a name=\"resource-status-unconfirmed\"> </a>\n                </td>\n                <td>The information in this resource is not yet approved</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">confirmed\n                  <a name=\"resource-status-confirmed\"> </a>\n                </td>\n                <td>The information in this resource is approved</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">resolved\n                  <a name=\"resource-status-resolved\"> </a>\n                </td>\n                <td>The issue identified by this resource is no longer of concern</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">refuted\n                  <a name=\"resource-status-refuted\"> </a>\n                </td>\n                <td>This information has been ruled out by testing and evaluation</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">differential\n                  <a name=\"resource-status-differential\"> </a>\n                </td>\n                <td>Potentially true?</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">partial\n                  <a name=\"resource-status-partial\"> </a>\n                </td>\n                <td>This information is still being assembled</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">busy-unavailable\n                  <a name=\"resource-status-busy-unavailable\"> </a>\n                </td>\n                <td>not available at this time/location</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">free\n                  <a name=\"resource-status-free\"> </a>\n                </td>\n                <td>Free for scheduling</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">on-target\n                  <a name=\"resource-status-on-target\"> </a>\n                </td>\n                <td>Ready to act</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">ahead-of-target\n                  <a name=\"resource-status-ahead-of-target\"> </a>\n                </td>\n                <td>Ahead of the planned timelines</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">behind-target\n                  <a name=\"resource-status-behind-target\"> </a>\n                </td>\n                <td>Behind the planned timelines</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">not-ready\n                  <a name=\"resource-status-not-ready\"> </a>\n                </td>\n                <td>Not ready to act</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">transduc-discon\n                  <a name=\"resource-status-transduc-discon\"> </a>\n                </td>\n                <td>The device transducer is disconnected</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">hw-discon\n                  <a name=\"resource-status-hw-discon\"> </a>\n                </td>\n                <td>The hardware is disconnected</td>\n              </tr>\n            </table>\n          </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "informative"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 3
    },
    {
      "extension" : [
        {
          "url" : "packageId",
          "valueId" : "hl7.fhir.uv.xver-r5.r4"
        },
        {
          "url" : "version",
          "valueString" : "0.0.1-snapshot-2"
        }
      ],
      "url" : "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "mnm"
    }
  ],
  "url" : "http://hl7.org/fhir/resource-status",
  "version" : "5.0.0",
  "name" : "FHIRCanonicalStatusCodes",
  "title" : "Canonical Status Codes for FHIR Resources",
  "status" : "draft",
  "experimental" : true,
  "date" : "2025-09-13T16:55:28-04:00",
  "publisher" : "Modeling and Methodology",
  "contact" : [
    {
      "name" : "Modeling and Methodology",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/mnm"
        }
      ]
    }
  ],
  "description" : "The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/resource-status|4.0.1",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "concept" : [
    {
      "code" : "error",
      "display" : "error",
      "definition" : "The resource was created in error, and should not be treated as valid (note: in many cases, for various data integrity related reasons, the information cannot be removed from the record)"
    },
    {
      "code" : "proposed",
      "display" : "proposed",
      "definition" : "The resource describes an action or plan that is proposed, and not yet approved by the participants"
    },
    {
      "code" : "planned",
      "display" : "planned",
      "definition" : "The resource describes a course of action that is planned and agreed/approved, but at the time of recording was still future"
    },
    {
      "code" : "draft",
      "display" : "draft",
      "definition" : "The information in the resource is still being prepared and edited"
    },
    {
      "code" : "requested",
      "display" : "requested",
      "definition" : "A fulfiller has been asked to perform this action, but it has not yet occurred"
    },
    {
      "code" : "received",
      "display" : "received",
      "definition" : "The fulfiller has received the request, but not yet agreed to carry out the action"
    },
    {
      "code" : "declined",
      "display" : "declined",
      "definition" : "The fulfiller chose not to perform the action"
    },
    {
      "code" : "accepted",
      "display" : "accepted",
      "definition" : "The fulfiller has decided to perform the action, and plans are in train to do this in the future"
    },
    {
      "code" : "arrived",
      "display" : "arrived",
      "definition" : "The pre-conditions for the action are all fulfilled, and it is imminent"
    },
    {
      "code" : "active",
      "display" : "active",
      "definition" : "The resource describes information that is currently valid or a process that is presently occuring"
    },
    {
      "code" : "suspended",
      "display" : "suspended",
      "definition" : "The process described/requested in this resource has been halted for some reason"
    },
    {
      "code" : "failed",
      "display" : "failed",
      "definition" : "The process described/requested in the resource could not be completed, and no further action is planned"
    },
    {
      "code" : "replaced",
      "display" : "replaced",
      "definition" : "The information in this resource has been replaced by information in another resource"
    },
    {
      "code" : "complete",
      "display" : "complete",
      "definition" : "The process described/requested in the resource has been completed, and no further action is planned"
    },
    {
      "code" : "inactive",
      "display" : "inactive",
      "definition" : "The resource describes information that is no longer valid or a process that is stopped occurring"
    },
    {
      "code" : "abandoned",
      "display" : "abandoned",
      "definition" : "The process described/requested in the resource did not complete - usually due to some workflow error, and no further action is planned"
    },
    {
      "code" : "unknown",
      "display" : "unknown",
      "definition" : "Authoring system does not know the status"
    },
    {
      "code" : "unconfirmed",
      "display" : "unconfirmed",
      "definition" : "The information in this resource is not yet approved"
    },
    {
      "code" : "confirmed",
      "display" : "confirmed",
      "definition" : "The information in this resource is approved"
    },
    {
      "code" : "resolved",
      "display" : "resolved",
      "definition" : "The issue identified by this resource is no longer of concern"
    },
    {
      "code" : "refuted",
      "display" : "refuted",
      "definition" : "This information has been ruled out by testing and evaluation"
    },
    {
      "code" : "differential",
      "display" : "differential",
      "definition" : "Potentially true?"
    },
    {
      "code" : "partial",
      "display" : "partial",
      "definition" : "This information is still being assembled"
    },
    {
      "code" : "busy-unavailable",
      "display" : "busy-unavailable",
      "definition" : "not available at this time/location"
    },
    {
      "code" : "free",
      "display" : "free",
      "definition" : "Free for scheduling"
    },
    {
      "code" : "on-target",
      "display" : "on-target",
      "definition" : "Ready to act"
    },
    {
      "code" : "ahead-of-target",
      "display" : "ahead-of-target",
      "definition" : "Ahead of the planned timelines"
    },
    {
      "code" : "behind-target",
      "display" : "behind-target",
      "definition" : "Behind the planned timelines"
    },
    {
      "code" : "not-ready",
      "display" : "not-ready",
      "definition" : "Not ready to act"
    },
    {
      "code" : "transduc-discon",
      "display" : "transduc-discon",
      "definition" : "The device transducer is disconnected"
    },
    {
      "code" : "hw-discon",
      "display" : "hw-discon",
      "definition" : "The hardware is disconnected"
    }
  ]
}