This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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
FHIR Infrastructure Work Group | Maturity Level: 0 | Informative | Use Context: Any |
This is a value set defined by the FHIR project.
Summary
Defining URL: | http://hl7.org/fhir/ValueSet/resource-status |
Version: | 5.0.0-ballot |
Name: | CanonicalStatusCodesForFHIRResources |
Title: | Canonical Status Codes for FHIR Resources |
Status: | draft |
Definition: | The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes. |
Committee: | FHIR Infrastructure Work Group |
OID: | 2.16.840.1.113883.4.642.3.117 (for OID based terminology systems) |
Flags: |
This value set is used in the following places:
http://hl7.org/fhir/resource-status
This expansion generated 10 Sep 2022
This value set contains 31 concepts
Expansion based on Canonical Status Codes for FHIR Resources v5.0.0-ballot (CodeSystem)
Code | System | Display | Definition |
error | http://hl7.org/fhir/resource-status | error | 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) |
proposed | http://hl7.org/fhir/resource-status | proposed | The resource describes an action or plan that is proposed, and not yet approved by the participants |
planned | http://hl7.org/fhir/resource-status | planned | The resource describes a course of action that is planned and agreed/approved, but at the time of recording was still future |
draft | http://hl7.org/fhir/resource-status | draft | The information in the resource is still being prepared and edited |
requested | http://hl7.org/fhir/resource-status | requested | A fulfiller has been asked to perform this action, but it has not yet occurred |
received | http://hl7.org/fhir/resource-status | received | The fulfiller has received the request, but not yet agreed to carry out the action |
declined | http://hl7.org/fhir/resource-status | declined | The fulfiller chose not to perform the action |
accepted | http://hl7.org/fhir/resource-status | accepted | The fulfiller has decided to perform the action, and plans are in train to do this in the future |
arrived | http://hl7.org/fhir/resource-status | arrived | The pre-conditions for the action are all fulfilled, and it is imminent |
active | http://hl7.org/fhir/resource-status | active | The resource describes information that is currently valid or a process that is presently occuring |
suspended | http://hl7.org/fhir/resource-status | suspended | The process described/requested in this resource has been halted for some reason |
failed | http://hl7.org/fhir/resource-status | failed | The process described/requested in the resource could not be completed, and no further action is planned |
replaced | http://hl7.org/fhir/resource-status | replaced | The information in this resource has been replaced by information in another resource |
complete | http://hl7.org/fhir/resource-status | complete | The process described/requested in the resource has been completed, and no further action is planned |
inactive | http://hl7.org/fhir/resource-status | inactive | The resource describes information that is no longer valid or a process that is stopped occurring |
abandoned | http://hl7.org/fhir/resource-status | abandoned | The process described/requested in the resource did not complete - usually due to some workflow error, and no further action is planned |
unknown | http://hl7.org/fhir/resource-status | unknown | Authoring system does not know the status |
unconfirmed | http://hl7.org/fhir/resource-status | unconfirmed | The information in this resource is not yet approved |
confirmed | http://hl7.org/fhir/resource-status | confirmed | The information in this resource is approved |
resolved | http://hl7.org/fhir/resource-status | resolved | The issue identified by this resource is no longer of concern |
refuted | http://hl7.org/fhir/resource-status | refuted | This information has been ruled out by testing and evaluation |
differential | http://hl7.org/fhir/resource-status | differential | Potentially true? |
partial | http://hl7.org/fhir/resource-status | partial | This information is still being assembled |
busy-unavailable | http://hl7.org/fhir/resource-status | busy-unavailable | not available at this time/location |
free | http://hl7.org/fhir/resource-status | free | Free for scheduling |
on-target | http://hl7.org/fhir/resource-status | on-target | Ready to act |
ahead-of-target | http://hl7.org/fhir/resource-status | ahead-of-target | Ahead of the planned timelines |
behind-target | http://hl7.org/fhir/resource-status | behind-target | Behind the planned timelines |
not-ready | http://hl7.org/fhir/resource-status | not-ready | Not ready to act |
transduc-discon | http://hl7.org/fhir/resource-status | transduc-discon | The device transducer is disconnected |
hw-discon | http://hl7.org/fhir/resource-status | hw-discon | The hardware is disconnected |
See the full registry of value sets defined as part of FHIR.
Explanation of the columns that may appear on this page:
Lvl | A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System 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 that the code is 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 of the concept |
Comments | Additional notes about how to use the code |