Current Build

Extension: statusReason

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/event-statusReason

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

Captures the reason for the current state of the resource.

Comment:

This is generally only used for "exception" statuses such as "not-done", "suspended" or "cancelled". The reason for performing the event at all is captured in reasonCode, not here. (distinct reason codes for different statuses can be enforced using invariants if they are universal bindings).

Context of Use: Use on Element ID Observation, Element ID DiagnosticReport, Element ID Media, Element ID SupplyDelivery or Element ID DeviceUseStatement

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. statusReason0..1CodeableConceptURL = http://hl7.org/fhir/StructureDefinition/event-statusReason
statusReason: Captures the reason for the current state of the resource.


Binding: (unbound) (example)
Use on Element ID Observation, Element ID DiagnosticReport, Element ID Media, Element ID SupplyDelivery or Element ID DeviceUseStatement

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/event-statusReason
statusReason: Captures the reason for the current state of the resource.


Use on Element ID Observation, Element ID DiagnosticReport, Element ID Media, Element ID SupplyDelivery or Element ID DeviceUseStatement
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/event-statusReason"
... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: (unbound) (example)

doco Documentation for this format

XML Template

<!-- statusReason -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/event-statusReason" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!-- 0..1 CodeableConcept 
     Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // statusReason
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/event-statusReason", // R! 
    "valueCodeableConcept" : { CodeableConcept } //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. statusReason0..1CodeableConceptURL = http://hl7.org/fhir/StructureDefinition/event-statusReason
statusReason: Captures the reason for the current state of the resource.


Binding: (unbound) (example)
Use on Element ID Observation, Element ID DiagnosticReport, Element ID Media, Element ID SupplyDelivery or Element ID DeviceUseStatement

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/event-statusReason
statusReason: Captures the reason for the current state of the resource.


Use on Element ID Observation, Element ID DiagnosticReport, Element ID Media, Element ID SupplyDelivery or Element ID DeviceUseStatement
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/event-statusReason"
... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: (unbound) (example)

doco Documentation for this format

XML Template

<!-- statusReason -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/event-statusReason" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!-- 0..1 CodeableConcept 
     Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // statusReason
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/event-statusReason", // R! 
    "valueCodeableConcept" : { CodeableConcept } //Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))