[%settitle Resource Life Cycle Page%] [%file newheader%] [%file newnavbar%]

FHIR Life Cycle Page

This page describes several issues around lifecycle management for the resources and the content they contain. Specifically, this page describes:

• Resource Status: how resource status codes work
• Current List: issues associated with retrieving "current X list" of resources
• Entered in Error: information about how erroneous entry is handled for the resources

Resource Status

Many FHIR resources have a status element that represents the lifecycle state of the resource or the clinical process represented by the resource. Work groups can specify status values appropriate to the individual resource. Although consistency between resources is not the primary objective, it is helpful to users and developers to have well-crafted value sets that cover all possible states (since the value sets are typically required and non-extensible).

To understand existing status elements, and to help create extensions and resources involving resource states, we note that status value sets follow one of the following life cycles:

• Clinical workflow process life cycle
• Request/Order life cycle
• Entity status life cycle
• Clinical status life cycle

For additional information about managing resource life cycles, see:

• Resource Identity
• Technical vs Business Versions
• Managing Resource Identity (including "Consistent Resource Identification")

Clinical Workflow Process Life Cycle

Describes the lifecycle states of complex activities common in healthcare. Typically, these states follow a chronological life cycle that leads from initiation to the conclusion of the action. A characteristic (but non-exhaustive) set of states for the clinical workflow process life cycle include:

• planned - resources for the activity are being allocated but the activity has not begun
• cancelled - the planned activity did not start and will not take place
• in-progress - the activity has begun
• on-hold (suspended) - the activity has been temporarily interrupted
• stopped (aborted, failed) - the activity has not been completed but no future action is planned
• completed (finished) - the activity has been completed

Examples of the clinical workflow life cycle:

• Communication.status: <%sclist Communication.status%>
• Appointment.status: <%sclist Appointment.status%>
• Encounter.status: <%sclist Encounter.status%>
• Goal.lifecycleStatus: <%sclist Goal.lifecycleStatus%>
• MedicationAdministration.status: <%sclist MedicationAdministration.status%>
• MedicationDispense.status: <%sclist MedicationDispense.status%>
• Procedure.status: <%sclist Procedure.status%>

Request/Order Life Cycle

Some resources in FHIR represent orders or requests. The request lifecycle can be generalized in terms of four stages: creating the request, sending the request, receiving acceptance or refusal of the request, and fulfillment of the request. A characteristic (but non-exhaustive) set of states for the request/order pattern include:

• proposed: An actor (e.g., a clinical decision support system) has proposed an action to be requested
• draft: The request is in preliminary form, prior to being requested
• requested: The request has been made
• rejected: The request receiver has declined the request
• accepted: The request receiver has accepted the request
• in-progress: Work to fulfill the request has begun
• on-hold (suspended): Work on the request has been interrupted
• stopped (aborted): The activity has not been completed but no future action is planned
• completed: Work on the requested task has been completed, and no further action is required
• cancelled: The request has been withdrawn

Examples of the request/order life cycle:

• CommunicationRequest.status: <%sclist CommunicationRequest.status%>
• DeviceRequest.status: <%sclist DeviceRequest.status%>
• MedicationRequest.status: <%sclist MedicationRequest.status%>
• ServiceRequest.status: <%sclist ServiceRequest.status%>

Entity Availability Life Cycle

The entity availability life cycle indicates if the resource, or the entity described by the resource, is ready for use, not yet ready for use, or has been retired from use. A characteristic (but non-exhaustive) set of states for the entity availability life cycle include:

• draft: The entity is being prepared but is not yet in use
• active: The entity is in use
• suspended: The entity is not in use at the moment, but may return to active status
• amended: The entity has undergone a revision but is still active
• retired (superseded): The entity is no longer in use.

Examples of the entity availability life cycle:

• DiagnosticReport.status: <%sclist DiagnosticReport.status%>
• MedicationStatement.status: <%sclist MedicationStatement.status%>. (note: in-progress and completed are states reflecting the administration of the medication)
• CapabilityStatement.status: <%sclist CapabilityStatement.status%>
• StructureDefinition.status: <%sclist StructureDefinition.status%>
• Questionnaire.status: <%sclist Questionnaire.status%>
• DocumentReference.status: <%sclist DocumentReference.status%>
• QuestionnaireResponse.status: <%sclist QuestionnaireResponse.status%>
• Flag.status: <%sclist Flag.status%>
• Location.status: <%sclist Location.status%>
• Organization.active: <%sclist Organization.active%>
• Patient.active: <%sclist Patient.active%>

Clinical Status Life Cycle

Clinical status is somewhat different than the previous status values, since it does not deal with workflow or lifecycle. Instead, it indicates how evidence is affecting a clinical interpretation. Here are two examples:

• AllergyIntolerance.clinicalStatus: <%sclist AllergyIntolerance.clinicalStatus%>
• Condition.clinicalStatus: <%sclist Condition.clinicalStatus%>

Current Resource Lists

The section regarding current lists has been removed due to lack of implementation experience and feedback. If there is continued interest in this topic, it may be reintroduced in the API Incubator.

Entered in Error Summary

The entered-in-error state indicates the resource was created accidentally and should be ignored. This state can apply to resources created by manual entry. It is usually not associated with the Clinical Workflow Process life cycle, but can be associated with the Request/Order and the Entity Availability life cycles.

Handling of erroneous data is tightly tied to business processes and thus there are no generic rules for what to do when data is flagged as erroneous. Implementation Guides may define additional guidance about what actions should be taken, such as data redaction, sending of notifications, etc.

This table summarizes what is expected to happen for each resource in the case that the data it contains is subsequently found to be an erroneous entry.

[%enteredInErrorTable%]

Note: Resources that are not listed in this table do not have any explicit documentation with regard to being entered in error.

[%file newfooter%]