FHIR Extensions Pack
5.3.0-ballot - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Workflow Status Reason

Official URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason Version: 5.3.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: WorkflowStatusReason
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1540

Captures the reason for the current state of the resource. Note that any change to the state requires the removal of any existing statusReasons, and, if appropriate, populating new statusReasons.

Context of Use

This extension may be used on the following element(s)

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • New Content

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension with the type CodeableConcept: Captures the reason for the current state of the resource. Note that any change to the state requires the removal of any existing statusReasons, and, if appropriate, populating new statusReasons.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Why was the status changed?
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-statusReason"
    ... value[x] 1..1 CodeableConcept Value of extension
    Binding: StatusReasonValueSet (example)

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Why was the status changed?
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-statusReason"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type CodeableConcept: Captures the reason for the current state of the resource. Note that any change to the state requires the removal of any existing statusReasons, and, if appropriate, populating new statusReasons.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Why was the status changed?
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-statusReason"
    ... value[x] 1..1 CodeableConcept Value of extension
    Binding: StatusReasonValueSet (example)

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Why was the status changed?
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-statusReason"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.value[x]exampleStatusReasonValueSet
    http://hl7.org/fhir/ValueSet/status-reason
    From this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)