This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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
| Modeling and Methodology Work Group | Maturity Level: N/A | Ballot Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Definition for Code System Canonical Status Codes for FHIR Resources
{
"resourceType" : "CodeSystem",
"id" : "resource-status",
"meta" : {
"lastUpdated" : "2018-08-19T21:48:56.559+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueString" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "mnm"
}],
"url" : "http://hl7.org/fhir/resource-status",
"name" : "Canonical Status Codes for FHIR Resources",
"status" : "draft",
"publisher" : "FHIR Project",
"description" : "The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes.",
"caseSensitive" : true,
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-status",
"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"
},
{
"code" : "not-ready",
"display" : "not-ready",
"definition" : "Behind the planned timelines"
},
{
"code" : "transduc-discon",
"display" : "transduc-discon",
"definition" : "The device transducer is disconnected"
},
{
"code" : "hw-discon",
"display" : "hw-discon",
"definition" : "The hardware is disconnected"
}]
}
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.