This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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: R5R4BR4R3R2
This is an internal QA page. The intent of this table is to help
reviewers compare the mappings between the general resource
status codes and the status codes on particular resources.
Note: This page is not proscriptive; it's descriptive and comparative,
to assist with review. The FHIR methodology says that if two domains
use different terms for the same concept (e.g. 'withdrawn' and 'cancelled')
then the domain concept name should be used. Conversely, where there
is no explicit reason for the codes to differ based on domain usage,
they should not.
All status codes must be mapped to one of the general status codes,
which are found in the Resource Status code system.
Note: Bold indicates that the element is marked as a modifier.
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)
Definitions for matching codes:
Care plan activity was entered in error and voided.
Contract was created in error. No Precedence Order. Status may be applied to a Contract with any status.
Some of the actions that are implied by the medication request may have occurred. For example, the medication may have been dispensed and the patient may have taken some of the medication. Clinical decision support systems should take this status into account
Some of the actions that are implied by the medication statement may have occurred. For example, the patient may have taken some of the medication. Clinical decision support systems should take this status into account.
The DeviceMetric was entered in error.
The administration was entered in error and therefore nullified.
The care team should have never existed.
The charge item has been entered in error and should not be processed for billing.
The composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid.
The consent was created wrongly (e.g. wrong patient) and should be ignored.
The device was entered in error and voided.
The dispense was entered in error and therefore nullified.
The flag was added in error and should no longer be displayed.
The goal was entered in error and voided.
The imaging study has been withdrawn following a previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".).
The instance was entered in error.
The list was never accurate. It is retained for medico-legal purposes only.
The medication was entered in error.
The observation has been withdrawn following previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".).
The report has been withdrawn following a previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".).
The resource instance was entered in error.
The response was entered in error.
The specimen was entered in error and therefore nullified.
The statement was entered in error and is not valid.
The statement was recorded incorrectly.
The substance was entered in error.
The task should never have existed and is retained only because of the possibility it may have used.
This QuestionnaireResponse was entered in error and voided.
This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".).
This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "stopped" rather than "entered-in-error".).
This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "abandoned" rather than "entered-in-error".).
This instance should not have been part of this patient's medical record.
This reference was created in error.
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".).
This test report was entered or created in error.
the invoice was determined as entered in error before it was issued.
3.7.0.0.2 proposed
The resource describes an action or plan that is proposed, and not yet approved by the participants
Definitions for matching codes:
A goal is proposed for this patient.
Contract is a proposal by either the Grantor or the Grantee. Aka - A Contract hard copy or electronic 'template', 'form' or 'application'. E.g., health insurance application; consent directive form. Usage: Beginning of contract negotiation, which may have been completed as a precondition because used for 0..* contracts. Precedence Order = 2. Comparable FHIR and v.3 status codes: requested; new.
The care team has been drafted and proposed, but not yet participating in the coordination and delivery of patient care.
The consent has been proposed but not yet agreed to by all parties. The negotiation stage.
3.7.0.0.3 planned
The resource describes a course of action that is planned and agreed/approved, but at the time of recording was still future
Definitions for matching codes:
A goal is planned for this patient.
The Encounter has not yet started.
The charge item has been entered, but the charged service is not yet complete, so it shall not be billed yet but might be used in the context of pre-authorization.
The core event has not started yet, but some staging activities have begun (e.g. initial compounding or packaging of medication). Preparation stages may be tracked for billing purposes.
The core event has not started yet, but some staging activities have begun (e.g. surgical suite preparation). Preparation stages may be tracked for billing purposes.
The device may be used at some time in the future.
The medication may be taken at some time in the future.
The patient is planned to be moved to this location at some point in the future.
This episode of care is planned to start at the date specified in the period.start. During this status, an organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to make resources available to provide care services.
This resource is still under development and is not yet considered to be ready for normal use.
3.7.0.0.4 draft
The information in the resource is still being prepared and edited
Definitions for matching codes:
***TODO***
A new instance the contents of which is not complete.
A new resource instance the contents of which is not complete.
Care plan activity is planned but no action has yet been taken.
Protocol is submitted to the review board for approval.
Some or all of the participant(s) have not finalized their acceptance of the appointment request.
The consent is in development or awaiting use but is not yet intended to be acted upon.
The participant has tentatively accepted the appointment. This could be automatically created by a system and requires further processing before it can be accepted. There is no commitment that attendance will occur.
The prescription is not yet 'actionable', e.g. it is a work in progress, requires sign-off, verification or needs to be run through decision support process.
The request has been created but is not yet complete or ready for action.
The request was processed successfully, but more data may result in a more complete evaluation.
The task is not yet ready to be acted upon.
This endpoint is not intended for production usage.
This episode has been placed on a waitlist, pending the episode being made active (or cancelled).
This is a preliminary composition or document (also known as initial or interim). The content may be incomplete or unverified.
This is an initial or interim observation: data may be incomplete or unverified.
This resource is still under development and is not yet considered to be ready for normal use.
the invoice has been prepared but not yet finalized.
3.7.0.0.5 requested
A fulfiller has been asked to perform this action, but it has not yet occurred
Definitions for matching codes:
The client has requested the subscription, and the server has not yet set it up.
The task is ready to be acted upon and action is sought.
3.7.0.0.6 received
The fulfiller has received the request, but not yet agreed to carry out the action
Definitions for matching codes:
A potential performer has claimed ownership of the task and is evaluating whether to perform it.
The existence of the imaging study is registered, but there is nothing yet available.
The existence of the observation is registered, but there is no result yet available.
The existence of the report is registered, but there is nothing yet available.
3.7.0.0.7 declined
The fulfiller chose not to perform the action
Definitions for matching codes:
A person who did not meet one or more criteria required for participation in a study is considered to have failed screening or
is ineligible for the study.
A proposed goal was rejected.
Protocol was disapproved by the review board.
The charge item has been determined to be not billable (e.g. due to rules associated with the billing code).
The consent has been rejected by one or more of the parties.
The participant has declined the appointment and will not participate in the appointment.
The potential performer who claimed ownership of the task has decided not to execute it prior to performing any action.
The request was processed, but more data is required to complete the evaluation.
3.7.0.0.8 accepted
The fulfiller has decided to perform the action, and plans are in train to do this in the future
Definitions for matching codes:
***TODO***
A proposed goal was accepted or acknowledged.
All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.
Appointment or other booking has occurred but activity has not yet begun.
Indicates that the time interval is busy because one or more events have been scheduled for that interval.
Protocol is approved by the review board.
The participant has accepted the appointment.
The patient has been assessed for the priority of their treatment based on the severity of their condition.
The potential performer has agreed to execute the task but has not yet started work.
This location is held empty for this patient.
3.7.0.0.9 arrived
The pre-conditions for the action are all fulfilled, and it is imminent
Definitions for matching codes:
The Patient is present for the encounter, however is not currently meeting with a practitioner.
The patient/patients has/have arrived and is/are waiting to be seen.
This resource is ready for normal use.
3.7.0.0.10 active
The resource describes information that is currently valid or a process that is presently occuring
Definitions for matching codes:
***TODO***
A current flag that should be displayed to a user. A system may use the category to determine which user roles should view the flag.
A test operations is currently executing.
At least one instance has been associated with this imaging study.
Care plan activity has been started but is not yet complete.
Product is currently available for use.
Supply has been requested, but not delivered.
The DeviceMetric is operating and will generate DeviceObservations.
The Encounter has begun and the patient is present / the practitioner and the patient are meeting.
The administration has started but has not yet completed.
The care team is currently participating in the coordination and delivery of care.
The charge item is ready for billing.
The consent is to be followed and enforced.
The device is available for use. Note: For *implanted devices* this means that the device is implanted in the patient.
The device is still being used.
The dispensed product is ready for pickup.
The event is currently occurring.
The goal is being sought actively.
The instance is currently in-force.
The list is considered to be an active part of the patient's record.
The location is operational.
The medication is available for use.
The medication is still being taken.
The patient is currently at this location, or was between the period specified.
A system may update these records when the patient leaves the location to either reserved, or completed.
The physical specimen is present and in good condition.
The prescription is 'actionable', but not all actions that are implied by it have occurred yet.
The report is currently being generated.
The request is currently being processed.
The request is in force and ready to be acted upon.
The request is ready to be acted upon.
The resource instance is currently in-force.
The subject is currently experiencing, or is at risk of, a reaction to the identified substance.
The subscription is active.
The substance is considered for use or reference.
The task has been started but is not yet complete.
This QuestionnaireResponse has been partially filled out with answers but changes or additions are still expected to be made to it.
This account is active and may be used.
This endpoint is expected to be active and can be used.
This episode of care is current.
This is the current reference for this document.
This resource is ready for normal use.
the invoice has been finalized and sent to the recipient.
3.7.0.0.11 suspended
The process described/requested in this resource has been halted for some reason
Definitions for matching codes:
A person is pre-registered for a study.
A test operation is waiting for an external client request.
Actions implied by the administration have been temporarily halted, but are expected to continue later. May also be called 'suspended'.
Actions implied by the prescription are to be temporarily halted, but are expected to continue later. May also be called 'suspended'.
Actions implied by the statement have been temporarily halted, but are expected to continue later. May also be called "suspended".
Actions implied by the statement have been temporarily halted, but are expected to continue later. May also be called 'suspended'.
Care plan activity was started but has temporarily ceased with an expectation of resumption at a future time.
Contract is pended to rectify failure of the Grantor or the Grantee to fulfil contract provision(s). E.g., Grantee complaint about Grantor's failure to comply with contract provisions. Usage: Contract pended. Precedence Order = 7. Comparable FHIR and v.3 status codes: on hold; pended; suspended.
Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).
The DeviceMetric is operating, but will not generate any DeviceObservations.
The Encounter has begun, but the patient is temporarily on leave.
The authorization/request to act has been temporarily withdrawn but is expected to resume in the future.
The care team is temporarily on hold or suspended and not participating in the coordination and delivery of care.
The dispense process is paused while waiting for an external event to reactivate the dispense. For example, new stock has arrived or the prescriber has called.
The event has been temporarily stopped but is expected to resume in the future.
The goal remains a long term objective but is no longer being actively pursued for a temporary period of time.
The location is temporarily closed.
The request (and any implicit authorization to act) has been temporarily withdrawn but is expected to resume in the future.
The task has been started but work has been paused.
This account is on hold.
This endpoint is temporarily unavailable.
This episode of care is on hold; the organization has limited responsibility for the patient (such as while on respite).
3.7.0.0.12 failed
The process described/requested in the resource could not be completed, and no further action is planned
Definitions for matching codes:
A Contract that is rescinded. May be required prior to replacing with an updated Contract. Comparable FHIR and v.3 status codes: nullified.
Actions implied by the administration have been permanently halted, before all of them occurred.
Actions implied by the dispense have been permanently halted, before all of them occurred.
Actions implied by the prescription are to be permanently halted, before all of the administrations occurred. This should not be used if the original order was entered in error
Actions implied by the statement have been permanently halted, before all of them occurred.
Actions implied by the statement have been permanently halted, before all of them occurred. This should not be used if the statement was entered in error.
An error occurred attempting to generate the report.
The event was terminated prior to the full completion of the intended activity but after at least some of the 'main' activity (beyond preparation) has occurred.
The participant needs to indicate if they accept the appointment by changing this status to one of the other statuses.
The person has withdrawn their participation in the study before registration.
The planned care plan activity has been ended prior to completion after the activity was started.
The processing of the charge was aborted.
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.
The request was not processed successfully.
The server has an error executing the notification.
The specimen cannot be used because of a quality issue such as a broken container, contamination, or too old.
The task was attempted but could not be completed due to some error.
The test script execution was manually stopped.
This QuestionnaireResponse has been partially filled out with answers but has been abandoned. It is unknown whether changes or additions are expected to be made to it.
This endpoint has exceeded connectivity thresholds and is considered in an error state and should no longer be attempted to connect to until corrective action is taken.
the invoice was cancelled.
3.7.0.0.13 replaced
The information in this resource has been replaced by information in another resource
Definitions for matching codes:
***TODO***
A person is no longer receiving study intervention and/or being evaluated with tests and procedures according to the protocol, but they are being monitored on a protocol-prescribed schedule.
The composition content or the referenced resources have been modified (edited or added to) subsequent to being released as "final" and the composition is complete and verified by an authorized person.
This QuestionnaireResponse has been filled out with answers, then marked as complete, yet changes or additions have been made to it afterwards.
3.7.0.0.14 complete
The process described/requested in the resource has been completed, and no further action is planned
Definitions for matching codes:
A person that has ended their participation on a study either because their treatment/observation is complete or through not
responding, withdrawal, non-compliance and/or adverse event.
Activity against the request has been sufficiently completed to the satisfaction of the requester.
All actions that are implied by the administration have occurred.
All actions that are implied by the prescription have occurred.
All available related health information is captured as of the date (and possibly time) when the family member history was taken.
All test operations have completed.
Care plan activity has been completed (more or less) as planned.
Contract is activated for period stipulated when both the Grantor and Grantee have signed it. Usage: Required state for normal completion of contracting activity. Precedence Order = 6. Comparable FHIR and v.3 status codes: accepted; completed.
Supply has been delivered ("completed").
The Encounter has ended.
The activity described by the request has been fully performed. No further activity will occur.
The charge item has been billed (e.g. a billing engine has generated financial transactions by applying the associated ruled for the charge item to the context of the Encounter, and placed them into Claims/Invoices.
The device is no longer being used.
The dispensed product has been picked up.
The event has now concluded.
The goal has been met.
The goal is no longer being sought.
The medication is no longer being taken.
The observation is complete and there are no further actions needed. Additional information such "released", "signed", etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied.
The patient was at this location during the period specified.
Not to be used when the patient is currently at the location.
The planning stages of the appointment are now complete, the encounter resource will exist and will track further status changes. Note that an encounter may exist before the appointment status is fulfilled for many reasons.
The report is complete and ready for use.
The report is complete and verified by an authorized person.
The request was processed successfully.
The task has been completed.
This QuestionnaireResponse has been filled out with answers and the current content is regarded as definitive.
This episode of care is finished and the organization is not expecting to be providing further care to the patient. Can also be known as "closed", "completed" or other similar terms.
This resource has been withdrawn or superseded and should no longer be used.
This version of the composition is complete and verified by an appropriate person and no further work is planned. Any subsequent updates would be on a new version of the composition.
the invoice has been balaced / completely paid.
3.7.0.0.15 inactive
The resource describes information that is no longer valid or a process that is stopped occurring
Definitions for matching codes:
The DeviceMetric is not operating.
The care team was, but is no longer, participating in the coordination and delivery of care.
The consent is terminated or replaced.
The device is no longer available for use (e.g. lost, expired, damaged). Note: For *implanted devices* this means that the device has been removed from the patient.
The flag no longer needs to be displayed.
The list is "old" and should no longer be considered accurate or relevant.
The location is no longer used.
The medication is not available for use.
The subject is no longer at risk of a reaction to the identified substance.
The substance is considered for reference, but not for use.
There is no physical specimen because it is either lost, destroyed or consumed.
This account is inactive and should not be used to track financial information.
This endpoint is no longer to be used.
This reference has been superseded by another reference.
This resource has been withdrawn or superseded and should no longer be used.
Too many errors have occurred or the subscription has expired.
3.7.0.0.16 abandoned
The process described/requested in the resource did not complete - usually due to some workflow error, and no further action is planned
Definitions for matching codes:
A person for whom registration was not completed.
Delivery was not completed.
Protocol was withdrawn by the lead organization.
The Encounter has ended before it has begun.
The appointment has been cancelled.
The authoring system does not know which of the status values currently applies for this resource. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, it's just not known which one.
The authorization/request to act has been terminated prior to the full completion of the intended actions. No further activity should occur.
The episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care. It indicates that services terminated outside the planned/expected workflow.
The event was terminated prior to any activity beyond preparation. I.e. The 'main' activity has not yet begun. The boundary between preparatory and the 'main' activity is context-specific.
The goal has been abandoned.
The goal is not possible to be met.
The imaging study is unavailable because the imaging study was not started or not completed (also sometimes called "aborted").
The instance is withdrawn, rescinded or reversed.
The observation is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
The planned care plan activity has been withdrawn.
The prescription has been withdrawn before any administrations have occurred
The report is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
The resource instance is withdrawn, rescinded or reversed.
The task was not completed.
3.7.0.0.17 unknown
Authoring system does not know the status
Definitions for matching codes:
Health information for this family member is unavailable/unknown.
The account status is unknown.
The authoring system does not know which of the status values applies for this medication dispense. Note: this concept is not to be used for other - one of the listed statuses is presumed to apply, it's just now known which one.
The authoring system does not know which of the status values currently applies for this charge item Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, it's just not known which one.
The authoring 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, it's just not known which one.
The authoring system does not know which of the status values currently applies for this resource. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, it's just not known which one.
The authoring/source system does not know which of the status values currently applies for this event. 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.
The authoring/source system does not know which of the status values currently applies for this observation. 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.
The authoring/source system does not know which of the status values currently applies for this observation. 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.
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.
The current state of the care plan activity is not known. 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 one.
The encounter status is unknown. Note that "unknown" is a value of last resort and every attempt should be made to provide a meaningful value other than "unknown".
The participant needs to indicate if they accept the appointment by changing this status to one of the other statuses.
The state of the medication use is not currently known.
The status of the device has not been determined.
The 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, it's just not known which one.
The validations status has not been determined yet
3.7.0.0.18 unconfirmed
The information in this resource is not yet approved
Definitions for matching codes:
A low level of certainty about the propensity for a reaction to the identified substance.
Indicates that the time interval is busy because one or more events have been tentatively scheduled for that interval.
3.7.0.0.19 confirmed
The information in this resource is approved
Definitions for matching codes:
A high level of certainty about the propensity for a reaction to the identified substance, which may include clinical evidence by testing or rechallenge.
There is sufficient diagnostic and/or clinical evidence to treat this as a confirmed condition.
3.7.0.0.20 resolved
The issue identified by this resource is no longer of concern
Definitions for matching codes:
A reaction to the identified substance has been clinically reassessed by testing or re-exposure and is considered no longer to be present. Re-exposure could be accidental, unplanned, or outside of any clinical setting.
3.7.0.0.21 refuted
This information has been ruled out by testing and evaluation
Definitions for matching codes:
A propensity for a reaction to the identified substance has been disputed or disproven with a sufficient level of clinical certainty to justify invalidating the assertion. This might or might not include testing or rechallenge.
This condition has been ruled out by diagnostic and clinical evidence.
3.7.0.0.22 differential
Potentially true?
Definitions for matching codes:
One of a set of potential (and typically mutually exclusive) diagnoses asserted to further guide the diagnostic process and preliminary treatment.
3.7.0.0.23 partial
This information is still being assembled
Definitions for matching codes:
Some health information is known and captured, but not complete - see notes for details.
When checked in, all pre-encounter administrative work is complete, and the encounter may begin. (where multiple patients are involved, they are all present).
3.7.0.0.24 busy-unavailable
not available at this time/location
Definitions for matching codes:
Indicates that the time interval is busy and that the interval cannot be scheduled.
Product is not currently available for use.
3.7.0.0.25 free
Free for scheduling
Definitions for matching codes:
Indicates that the time interval is free for scheduling.
3.7.0.0.26 on-target
Ready to act
Definitions for matching codes:
The task is ready to be performed, but no action has yet been taken. Used in place of requested/received/accepted/rejected when request assignment and acceptance is a given.
Exchange
. Page versions: R5 R4B R4 R3 R2
|
Propose a change