FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

3.8 FHIR Status Codes Grid

FHIR Infrastructure icon Work GroupMaturity Level: N/AStandards Status: Informative

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.

code error proposed planned draft requested received declined accepted arrived active suspended failed replaced complete inactive abandoned unknown unconfirmed confirmed resolved refuted differential partial busy-unavailable free on-target ahead-of-target behind-target not-ready transduc-discon hw-discon not-done
stated codes entered-in-error, marked deleted proposed planned tentative, draft requested received refused, declined, rejected accepted, scheduled, booked, reserved arrived active, in-progress, published on hold, onleave suspended stopped, aborted, failed Amended, replaced completed, final, finished, achieved, done, dispensed, delivered superseded, retired, not in use, inactive, off, refuted cancelled, withdrawn, not done, abandoned unknown unconfirmed confirmed resolved refuted differential partial busy-unavailable free on-target ahead-of-target behind-target not-ready transduc-disconnected hardware-disconnected not-done
actual codes entered-in-error offered, proposed, proposed,waitlist, submitted draft, intended, planned, preparation, triaged attested, data-requested, draft, negotiable,policy, partial, preliminary, partial,preliminary,modified, pending, planned, preliminary, presumed, tentative, waitlist requested received, registered data-required, declined, disagree, not-billable, rejected, resolved-no-change accepted, agree, booked, busy, reserved, resolved-change-required, specimen-in-process, validated active, arrived active, active,recurrence,relapse, applied, available, billable, current, executable,resolved, in-process, in-progress, in-progress, sustaining, improving, worsening, no-change, issued, on, pending, successful disputed, inactive,remission, noshow, on-hold, onhold, standby, suspended, waiting, waiting-for-input,deferred abandoned, aborted, cancelled, deprecated, error, failed, failure, needs-action, not-done, resolved, revoked, stopped, unfulfilled, unsatisfactory, val-fail, reval-fail amended, amended,appended,renewed, corrected, amended, appended, req-revalid achieved, available, balanced, billed, complete, completed, corrected, amended, appended, executed, final, finished, fulfilled, issued, published,duplicate, recorded, retired, success final, inactive, mitigated, off, retired, superseded, unavailable abandoned, cancelled, cancelled,rejected,terminated, discontinued, not-attainable, not-done, returned, unknown cancelled, health-unknown, needs-action, unknown busy-tentative, cannot-be-obtained, pending, unconfirmed, unconfirmed, provisional, unknown allocated, cannot-be-obtained, confirmed resolved refuted differential checked-in, discharged, limited, partial busy-unavailable, unavailable free ready cancelled, declined, no-progress, not-achieved, not-done
Issues? check test in the Event pattern check data required check busy check on, check Goal check no-show check needs-action check needs action check busy-tentative
Account.status entered-in-error active on-hold inactive unknown
ActivityDefinition.status draft active retired unknown
ActorDefinition.status draft active retired unknown
AdministrableProductDefinition.status draft active retired unknown
AdverseEvent.status entered-in-error in-progress completed unknown
AllergyIntolerance.clinicalStatus active inactive resolved
AllergyIntolerance.verificationStatus entered-in-error presumed unconfirmed confirmed refuted
Appointment.participant.status tentative declined accepted needs-action
Appointment.status entered-in-error proposed,waitlist pending booked arrived noshow fulfilled cancelled checked-in
AppointmentResponse.participantStatus entered-in-error tentative declined accepted needs-action
ArtifactAssessment.workflowStatus entered-in-error submitted triaged resolved-no-change resolved-change-required applied waiting-for-input,deferred published,duplicate
BiologicallyDerivedProduct.productStatus available unavailable
BiologicallyDerivedProductDispense.status entered-in-error preparation in-progress unfulfilled issued returned unknown allocated
CapabilityStatement.status draft active retired unknown
CarePlan.status entered-in-error draft active on-hold revoked completed unknown
CareTeam.status entered-in-error proposed active suspended inactive
ChargeItem.status entered-in-error planned not-billable billable aborted billed unknown
ChargeItemDefinition.status draft active retired unknown
Citation.status draft active retired unknown
Claim.status entered-in-error draft active cancelled
ClaimResponse.status entered-in-error draft active cancelled
ClinicalImpression.status entered-in-error preparation in-progress on-hold stopped completed not-done unknown
CodeSystem.status draft active retired unknown
Communication.status entered-in-error preparation in-progress on-hold stopped completed not-done unknown
CommunicationRequest.status entered-in-error draft active on-hold revoked completed unknown
CompartmentDefinition.status draft active retired unknown
Composition.status entered-in-error partial, preliminary registered deprecated corrected, amended, appended final cancelled unknown
ConceptMap.status draft active retired unknown
Condition.clinicalStatus active,recurrence,relapse inactive,remission resolved
Condition.verificationStatus entered-in-error unconfirmed, provisional confirmed refuted differential
ConditionDefinition.status draft active retired unknown
Consent.status entered-in-error draft active not-done inactive unknown
Contract.contentDefinition.publicationStatus entered-in-error offered negotiable,policy executable,resolved disputed revoked amended,appended,renewed executed cancelled,rejected,terminated
Contract.status entered-in-error offered negotiable,policy executable,resolved disputed revoked amended,appended,renewed executed cancelled,rejected,terminated
Coverage.status entered-in-error draft active cancelled
CoverageEligibilityRequest.status entered-in-error draft active cancelled
CoverageEligibilityResponse.status entered-in-error draft active cancelled
DetectedIssue.status entered-in-error preliminary final mitigated
Device.status entered-in-error active inactive
DeviceAlert.status entered-in-error in-progress completed
DeviceDispense.status entered-in-error preparation in-progress on-hold stopped completed unknown cancelled, declined
DeviceMetric.operationalStatus entered-in-error on standby off
DeviceRequest.status entered-in-error draft active on-hold revoked completed unknown
DeviceUsage.status entered-in-error intended active on-hold stopped completed not-done
DiagnosticReport.status entered-in-error partial,preliminary,modified registered corrected, amended, appended final cancelled unknown
DocumentReference.docStatus entered-in-error partial, preliminary registered deprecated corrected, amended, appended final cancelled unknown
DocumentReference.status entered-in-error current superseded
Encounter.location.status planned reserved active completed
Encounter.status entered-in-error planned in-progress on-hold cancelled completed discontinued unknown discharged
EncounterHistory.status entered-in-error planned in-progress on-hold cancelled completed discontinued unknown discharged
Endpoint.status entered-in-error active suspended error off limited
EnrollmentRequest.status entered-in-error draft active cancelled
EnrollmentResponse.status entered-in-error draft active cancelled
EpisodeOfCare.status entered-in-error planned waitlist active onhold finished cancelled
EpisodeOfCare.statusHistory.status entered-in-error planned waitlist active onhold finished cancelled
EventDefinition.status draft active retired unknown
Evidence.status draft active retired unknown
EvidenceReport.status draft active retired unknown
EvidenceVariable.status draft active retired unknown
ExampleScenario.status draft active retired unknown
ExplanationOfBenefit.status entered-in-error draft active cancelled
FamilyMemberHistory.status entered-in-error completed health-unknown partial
Flag.status entered-in-error active inactive
FormularyItem.status entered-in-error active inactive
GenomicStudy.status entered-in-error registered available cancelled unknown
Goal.acceptance.status disagree agree pending
Goal.achievementStatus in-progress, sustaining, improving, worsening, no-change achieved not-attainable no-progress, not-achieved
Goal.lifecycleStatus entered-in-error proposed planned rejected accepted active on-hold completed cancelled
GraphDefinition.status draft active retired unknown
Group.status draft active retired unknown
GuidanceResponse.status entered-in-error data-requested data-required in-progress failure success
ImagingSelection.status entered-in-error available inactive unknown
ImagingStudy.status entered-in-error registered available cancelled unknown
Immunization.status entered-in-error completed not-done
ImmunizationEvaluation.status entered-in-error completed
ImplementationGuide.status draft active retired unknown
Ingredient.status draft active retired unknown
InsuranceProduct.status draft active retired unknown
InventoryItem.status entered-in-error active inactive unknown
InventoryReport.status entered-in-error draft requested active
Invoice.status entered-in-error draft issued cancelled balanced
Library.status draft active retired unknown
List.status entered-in-error current retired
Location.status active suspended inactive
ManufacturedItemDefinition.status draft active retired unknown
Measure.status draft active retired unknown
MeasureReport.status pending error complete
Medication.status entered-in-error active inactive
MedicationAdministration.status entered-in-error in-progress on-hold stopped completed unknown not-done
MedicationDispense.status entered-in-error preparation in-progress on-hold stopped completed unknown cancelled, declined
MedicationKnowledge.status draft active retired unknown
MedicationRequest.status entered-in-error draft active on-hold stopped completed cancelled unknown
MedicationStatement.status entered-in-error draft recorded
MessageDefinition.status draft active retired unknown
NamingSystem.status draft active retired unknown
NutritionIntake.status entered-in-error preparation in-progress on-hold stopped completed unknown not-done
NutritionOrder.status entered-in-error draft active on-hold revoked completed unknown
NutritionProduct.status entered-in-error active inactive
Observation.status entered-in-error preliminary registered specimen-in-process corrected, amended, appended final cancelled unknown cannot-be-obtained
ObservationDefinition.status draft active retired unknown
OperationDefinition.status draft active retired unknown
PaymentNotice.status entered-in-error draft active cancelled
PaymentReconciliation.status entered-in-error draft active cancelled
Permission.status entered-in-error draft rejected active
PlanDefinition.status draft active retired unknown
Procedure.status entered-in-error preparation in-progress on-hold stopped completed not-done unknown
Questionnaire.status draft active retired unknown
QuestionnaireResponse.status entered-in-error in-progress stopped amended completed
RelatedArtifact.publicationStatus draft active retired unknown
RequestOrchestration.status entered-in-error draft active on-hold revoked completed unknown
Requirements.status draft active retired unknown
ResearchStudy.status draft active retired unknown
ResearchSubject.status draft active retired unknown
RiskAssessment.status entered-in-error preliminary registered specimen-in-process corrected, amended, appended final cancelled unknown cannot-be-obtained
SearchParameter.status draft active retired unknown
ServiceRequest.status entered-in-error draft active on-hold revoked completed unknown
Slot.status entered-in-error busy busy-tentative busy-unavailable free
Specimen.status entered-in-error available unsatisfactory unavailable
SpecimenDefinition.status draft active retired unknown
StructureDefinition.status draft active retired unknown
StructureMap.status draft active retired unknown
Subscription.status entered-in-error requested active error off
SubscriptionStatus.status entered-in-error requested active error off
SubscriptionTopic.status draft active retired unknown
Substance.status entered-in-error active inactive
SupplyDelivery.status entered-in-error in-progress completed abandoned
SupplyRequest.status entered-in-error draft active suspended completed cancelled unknown
Task.status entered-in-error draft requested received rejected accepted in-progress on-hold failed completed cancelled ready
TerminologyCapabilities.status draft active retired unknown
TestPlan.status draft active retired unknown
TestReport.status entered-in-error in-progress waiting stopped completed
TestScript.status draft active retired unknown
Transport.status entered-in-error planned in-progress abandoned completed cancelled
ValueSet.status draft active retired unknown
VerificationResult.primarySource.validationStatus successful failed unknown
VerificationResult.status entered-in-error attested validated in-process val-fail, reval-fail req-revalid
VisionPrescription.status entered-in-error draft active cancelled

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

Definitions for matching codes:

  • Contract was created in error. No Precedence Order. Status may be applied to a Contract with any status.
  • Permission was entered in error and is not active.
  • Some of the actions that are implied by the medication usage 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 VerificationResult record was created erroneously and is not appropriated for use.
  • The administration was entered in error and therefore nullified.
  • The assessment was entered in error
  • 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 record is not current and is not appropriate for reference in new instances.
  • The dispense was entered in error and therefore nullified.
  • The flag was added in error and should no longer be displayed.
  • The genomic 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 goal was entered in error and voided.
  • The imaging selection has been withdrawn following a 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 "inactive" rather than "entered-in-error".).
  • 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 item record was entered in error.
  • The list was never accurate. It is retained for medico-legal purposes only.
  • The medication record was created erroneously and is not appropriated for reference in new instances.
  • 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.
  • 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 request was recorded against the wrong patient or for some reason should not have been recorded (e.g. wrong medication, wrong dose, etc.). 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.
  • The resource instance was entered in error.
  • The response was entered in error.
  • The service or product referred to by this FormularyItem was entered in error within the drug database or inventory system.
  • 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 alert record was created in error and is not valid.
  • 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 subscription has been flagged as incorrect.
  • This test report was entered or created in error.
  • the invoice was determined as entered in error before it was issued.

3.8.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 comment has been submitted, but the responsible party has not yet been determined, or the responsible party has not yet determined the next steps to be taken.

3.8.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 comment has been triaged, meaning the responsible party has been determined and next steps have been identified to address the comment.
  • 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. initial preparing of the device. Preparation stages may be tracked e.g. for planning, supply or 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 dispense process has started but not yet completed.
  • 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.8.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.
  • Permission is being defined.
  • Planned transport that is not yet requested.
  • Some or all of the participant(s) have not finalized their acceptance of the appointment request.
  • The available clinical information supports a high liklihood of the propensity for a reaction to the identified substance.
  • The consent is in development or awaiting use but is not yet intended to be acted upon.
  • The existence of the report is registered, but it is still without content or only some preliminary content.
  • The medication usage is draft or preliminary.
  • 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 request has been created but is not yet complete or ready for action.
  • The request 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 was processed successfully, but more data may result in a more complete evaluation.
  • The task is not yet ready to be acted upon.
  • This episode has been placed on a waitlist, pending the episode being made active (or cancelled).
  • 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.8.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 inventory report has been requested but there is no data available.
  • The task is ready to be acted upon and action is sought.

3.8.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 composition is registered, but there is nothing yet available.
  • The existence of the genomic study is registered, but there is nothing yet available.
  • 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.8.0.0.7 declined

The fulfiller chose not to perform the action

Definitions for matching codes:

  • A proposed goal was rejected.
  • Permission not granted.
  • Stakeholder is not in support of the pursuit of the goal.
  • The charge item has been determined to be not billable (e.g. due to rules associated with the billing code).
  • The comment has been resolved and no changes resulted from the resolution
  • 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.8.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.
  • Indicates that the time interval is busy because one or more events have been scheduled for that interval.
  • Stakeholder supports pursuit of the goal.
  • The comment has been resolved and changes are required to address the comment
  • The participant has accepted the appointment.
  • The potential performer has agreed to execute the task but has not yet started work.
  • The specimen being processed in the laboratory but no results are available yet.
  • This location is held empty for this patient.

3.8.0.0.9 arrived

The pre-conditions for the action are all fulfilled, and it is imminent

Definitions for matching codes:

  • The patient/patients has/have arrived and is/are waiting to be seen.
  • This resource is ready for normal use.

3.8.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.
  • Permission is given.
  • Product is currently available for use.
  • Supply has been requested, but not delivered.
  • The DeviceMetric is operating and will generate Observations.
  • 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 alert condition is present, or any signal from a previously present condition is not off
  • The care team is currently participating in the coordination and delivery of care.
  • The charge item is ready for billing.
  • The comment is resolved and any necessary changes have been applied
  • The consent is to be followed and enforced.
  • The device is still being used.
  • The device record is current and is appropriate for reference in new instances.
  • The dispense process is in progress.
  • 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 item is active and can be referenced.
  • The list is considered to be an active part of the patient's record.
  • The location is operational.
  • The medication record is current and is appropriate for reference in new instances.
  • 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 product can be used.
  • The report is currently being generated.
  • The request is 'actionable', but not all actions that are implied by it have occurred yet.
  • 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 selected resources are available..
  • The service or product referred to by this FormularyItem is in active use within the drug database or inventory system.
  • 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 report is submitted as current.
  • This resource is ready for normal use.
  • Transport has started but not completed.
  • the invoice has been finalized and sent to the recipient.

3.8.0.0.11 suspended

The process described/requested in this resource has been halted for some reason

Definitions for matching codes:

  • 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 request are to be temporarily halted. The request might or might not be resumed. 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".
  • 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 Observations.
  • The Encounter has begun, but is currently on hold, e.g. because 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.8.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 request 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.
  • An error occurred attempting to generate the report.
  • The Encounter has ended before it has begun.
  • The consent development has been terminated prior to completion.
  • The dispense could not be completed.
  • 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 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 subject is not presently experiencing the condition or situation and there is a negligible perceived risk of the condition or situation returning.
  • The task was attempted but was not successful. No further activity will occur for this task.
  • The test script execution was manually stopped.
  • This QuestionnaireResponse has been partially filled out with answers but has been abandoned. No subsequent changes can be made.
  • This composition has been withdrawn or superseded and should no longer be used.
  • 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.
  • Transport was started but not completed.
  • the invoice was cancelled.

3.8.0.0.13 replaced

The information in this resource has been replaced by information in another resource

Definitions for matching codes:

  • ***TODO***
  • This QuestionnaireResponse has been filled out with answers, then marked as complete, yet changes or additions have been made to it afterwards.

3.8.0.0.14 complete

The process described/requested in the resource has been completed, and no further action is planned

Definitions for matching codes:

  • 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 request 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.
  • At least one instance has been associated with this genomic study.
  • 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 action of recording the medication statement is finished.
  • The activity described by the request has been fully performed. No further activity will occur.
  • The alert condition is not present, and all signals are off
  • 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 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. Also, this status applies for situations where there is a "not-asked" code for dataAbsentReason.
  • 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.
  • Transport has been completed.
  • the invoice has been balaced / completely paid.

3.8.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 record is not current and is not appropriate for reference in new instances.
  • The flag no longer needs to be displayed.
  • The imaging selection is no longer valid.
  • The item is presently inactive - there may be references to it but the item is not expected to be used.
  • The list is "old" and should no longer be considered accurate or relevant.
  • The location is no longer used.
  • The medication record is not current and is not is appropriate for reference in new instances.
  • 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. Also, this status applies for situations where there is a "not-asked" code for dataAbsentReason.
  • The product is not expected or allowed to be used.
  • The service or product referred to by this FormularyItem is not in active use within the drug database or inventory system.
  • 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.8.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:

  • Delivery was not completed.
  • The Encounter has started, but was not able to be completed. Further action may need to be performed, such as rescheduling appointments related to this encounter.
  • 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 composition is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
  • The device was not used.
  • The dispensed product was returned.
  • 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 genomic study is unavailable because the genomic study was not started or not completed (also sometimes called "aborted").
  • 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 report is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
  • The request has been withdrawn before any administrations have occurred
  • The resource instance is withdrawn, rescinded or reversed.
  • The task was not completed.
  • Transport was cancelled before started.

3.8.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 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 applies for this dispense. 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 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 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 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 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 item status has not been determined.
  • The observation is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
  • The participant needs to indicate if they accept the appointment by changing this status to one of the other statuses.
  • The resource is in an indeterminate state.
  • 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.8.0.0.18 unconfirmed

The information in this resource is not yet approved

Definitions for matching codes:

  • Indicates that the time interval is busy because one or more events have been tentatively scheduled for that interval.
  • Stakeholder has not yet made a decision on whether they support the goal.
  • 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 observation cannot be obtained.
  • The propensity for a reaction to the identified substance has not been objectively verified.

3.8.0.0.19 confirmed

The information in this resource is approved

Definitions for matching codes:

  • The observation cannot be obtained.
  • The propensity for a reaction to the identified substance has been objectively verified (which may include clinical evidence by testing, rechallenge, or observation).
  • The requested product has been allocated and is ready for transport.
  • There is sufficient evidence to assert the presence of the subject's condition.

3.8.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.8.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 subsequent diagnostic and clinical evidence.

3.8.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.8.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.
  • The Encounter has been clinically completed, the patient has been discharged from the facility or the visit has ended, and the patient may have departed (refer to subjectStatus). While the encounter is in this status, administrative activities are usually performed, collating all required documentation and charge information before being released for billing, at which point the status will move to completed.
  • This endpoint is available for limited use (for example, it is undergoing internal testing). I.e. the endpoint is not fully available, might not always be available, or might only be available for some users.
  • 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.8.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.8.0.0.25 free

Free for scheduling

Definitions for matching codes:

  • Indicates that the time interval is free for scheduling.

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

3.8.0.0.27 ahead-of-target

Ahead of the planned timelines

Definitions for matching codes:

3.8.0.0.28 behind-target

Behind the planned timelines

Definitions for matching codes:

3.8.0.0.29 not-ready

Not ready to act

Definitions for matching codes:

3.8.0.0.30 transduc-discon

The device transducer is disconnected

Definitions for matching codes:

3.8.0.0.31 hw-discon

The hardware is disconnected

Definitions for matching codes:

3.8.0.0.32 not-done

Definitions for matching codes:

  • The administration was terminated prior to any impact on the subject (though preparatory actions may have been taken)
  • 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.