R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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: R4B R4

Extension: statusReason

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use 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, Element ID DeviceRequest, Element ID ServiceRequest, Element ID NutritionOrder, Element ID SupplyRequest or Element ID DeviceUseStatement

usage info: insert a list of places where this extension is used

Summary

Name	Flags	Card.	Type	Description & Constraints
statusReason		0..1	CodeableConcept	URL = 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, Element ID DeviceRequest, Element ID ServiceRequest, Element ID NutritionOrder, Element ID SupplyRequest or Element ID DeviceUseStatement
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = 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, Element ID DeviceRequest, Element ID ServiceRequest, Element ID NutritionOrder, Element ID SupplyRequest or Element ID DeviceUseStatement
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/event-statusReason"
valueCodeableConcept	0..1	CodeableConcept	Value of extension Binding: (unbound) (example)
Documentation for this format

XML Template

<!-- statusReason -->

<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

Name	Flags	Card.	Type	Description & Constraints
statusReason		0..1	CodeableConcept	URL = 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, Element ID DeviceRequest, Element ID ServiceRequest, Element ID NutritionOrder, Element ID SupplyRequest or Element ID DeviceUseStatement
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = 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, Element ID DeviceRequest, Element ID ServiceRequest, Element ID NutritionOrder, Element ID SupplyRequest or Element ID DeviceUseStatement
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/event-statusReason"
valueCodeableConcept	0..1	CodeableConcept	Value of extension Binding: (unbound) (example)
Documentation for this format

XML Template

<!-- statusReason -->

<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')]))