Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: reason

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/workflow-reason

Version: 5.0.0-ballot

Name: reason

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: References a resource or provides a code or text that explains why this event occurred or request was created.

Committee: FHIR Infrastructure Work Group

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

References a resource or provides a code or text that explains why this event occurred or request was created.

Comment:

For free text (uncoded data) use reasonCode.text.

Context of Use: Use on Element ID Observation, Element ID DiagnosticReport, Element ID DocumentReference or Element ID NutritionOrder

Summary

Name	Flags	Card.	Type	Description & Constraints
reason		0..*	CodeableReference(Condition \| DiagnosticReport \| DocumentReference \| Observation)	URL = http://hl7.org/fhir/StructureDefinition/workflow-reason reason: References a resource or provides a code or text that explains why this event occurred or request was created. Binding: Condition Cause Codes (example) Use on Element ID Observation, Element ID DiagnosticReport, Element ID DocumentReference or Element ID NutritionOrder
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/workflow-reason reason: References a resource or provides a code or text that explains why this event occurred or request was created. Use on Element ID Observation, Element ID DiagnosticReport, Element ID DocumentReference or Element ID NutritionOrder
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-reason"
value[x]	1..1	CodeableReference(Condition \| DiagnosticReport \| DocumentReference \| Observation)	Value of extension Binding: Condition Cause Codes (example)
Documentation for this format

XML Template

<!-- reason -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-reason" >
  <!-- from Element: extension -->
 <valueCodeableReference><!-- I 1..1 CodeableReference Value of extension --></valueCodeableReference>
</extension>

JSON Template

{ // reason
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-reason", // R! 
    "valueCodeableReference" : { CodeableReference(Condition) } // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
reason		0..*	CodeableReference(Condition \| DiagnosticReport \| DocumentReference \| Observation)	URL = http://hl7.org/fhir/StructureDefinition/workflow-reason reason: References a resource or provides a code or text that explains why this event occurred or request was created. Binding: Condition Cause Codes (example) Use on Element ID Observation, Element ID DiagnosticReport, Element ID DocumentReference or Element ID NutritionOrder
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/workflow-reason reason: References a resource or provides a code or text that explains why this event occurred or request was created. Use on Element ID Observation, Element ID DiagnosticReport, Element ID DocumentReference or Element ID NutritionOrder
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-reason"
value[x]	1..1	CodeableReference(Condition \| DiagnosticReport \| DocumentReference \| Observation)	Value of extension Binding: Condition Cause Codes (example)
Documentation for this format

XML Template

<!-- reason -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-reason" >
  <!-- from Element: extension -->
 <valueCodeableReference><!-- I 1..1 CodeableReference Value of extension --></valueCodeableReference>
</extension>

JSON Template

{ // reason
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-reason", // R! 
    "valueCodeableReference" : { CodeableReference(Condition) } // I R! 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')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.