Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU 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

Using Codes Code Systems Value Sets Concept Maps Identifier Systems

4.3.14.32 4.3.2.22 Code System CodeSystem http://hl7.org/fhir/resource-status

Modeling and Methodology icon Work Group   Maturity Level : 3 Trial Use Use Context : Any Country: World, Not yet ready for Production use
This is a code system defined by the FHIR project.
    Summary
  • Narrative Defining URL:
    • http://hl7.org/fhir/resource-status
  • XML Version:
    • 4.3.0
  • JSON Name:
    • Canonical Status Codes for FHIR Resources
  • TTL Title:
Committee:
Official URL : http://hl7.org/fhir/resource-status The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes. Version : 5.0.0-draft-final
draft as of 2023-03-01 Modeling and Methodology Computable Name : FHIRCanonicalStatusCodes Work Group
OID: (for OID based terminology systems) Flags : Experimental, CaseSensitive, Complete. All codes ValueSet: Canonical Status Codes for FHIR Resources Source Resource XML / JSON OID : 2.16.840.1.113883.4.642.4.1828

This Code system is used in the following value sets:

4.3.2.22.1 Definition

The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes.

4.3.14.32.1 4.3.2.22.2 Content

This code system http://hl7.org/fhir/resource-status defines the following codes:

Code Display Definition Definition Copy
error 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) btn   btn
proposed proposed The resource describes an action or plan that is proposed, and not yet approved by the participants btn   btn
planned planned The resource describes a course of action that is planned and agreed/approved, but at the time of recording was still future btn   btn
draft draft The information in the resource is still being prepared and edited btn   btn
requested requested A fulfiller has been asked to perform this action, but it has not yet occurred btn   btn
received received The fulfiller has received the request, but not yet agreed to carry out the action btn   btn
declined declined The fulfiller chose not to perform the action btn   btn
accepted accepted The fulfiller has decided to perform the action, and plans are in train to do this in the future btn   btn
arrived arrived The pre-conditions for the action are all fulfilled, and it is imminent btn   btn
active active The resource describes information that is currently valid or a process that is presently occuring btn   btn
suspended suspended The process described/requested in this resource has been halted for some reason btn   btn
failed failed The process described/requested in the resource could not be completed, and no further action is planned btn   btn
replaced replaced The information in this resource has been replaced by information in another resource btn   btn
complete complete The process described/requested in the resource has been completed, and no further action is planned btn   btn
inactive inactive The resource describes information that is no longer valid or a process that is stopped occurring btn   btn
abandoned abandoned The process described/requested in the resource did not complete - usually due to some workflow error, and no further action is planned btn   btn
unknown unknown Authoring system does not know the status btn   btn
unconfirmed unconfirmed The information in this resource is not yet approved btn   btn
confirmed confirmed The information in this resource is approved btn   btn
resolved resolved The issue identified by this resource is no longer of concern btn   btn
refuted refuted This information has been ruled out by testing and evaluation btn   btn
differential differential Potentially true? Potentially true? btn   btn
partial partial This information is still being assembled btn   btn
busy-unavailable busy-unavailable not available at this time/location btn   btn
free free Free for scheduling btn   btn
on-target on-target Ready to act btn   btn
ahead-of-target ahead-of-target Ahead of the planned timelines btn   btn
behind-target behind-target Behind the planned timelines btn   btn
not-ready not-ready Not ready to act Behind the planned timelines btn   btn
transduc-discon transduc-discon The device transducer is disconnected btn   btn
hw-discon hw-discon The hardware is disconnected btn   btn

 

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 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