R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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 R3

Extension: patientInstruction

Orders and Observations Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction

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

Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.

Context of Use: Use on element: DeviceRequest

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.
Use on element: DeviceRequest
... lang1..1codeCode for Language.
... content1..1stringThe actual text containing the instructions.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.
Use on element: DeviceRequest
... extension 1..1ExtensionLanguage
.... url 1..1uri"lang"
.... valueCode 0..1codeValue of extension
Binding: Common Languages (required)
... extension 1..1ExtensionText
.... url 1..1uri"content"
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- patientInstruction -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="lang"> 1..1 Extension  <!-- 1..1 Language -->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="content"> 1..1 Extension  <!-- 1..1 Text -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // patientInstruction
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Language // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "lang", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Text // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "content", // R! 
        "valueString" : "<string>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction", // R! 
// value[x]: Value of extension. One of these 46:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.
Use on element: DeviceRequest
... lang1..1codeCode for Language.
... content1..1stringThe actual text containing the instructions.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.
Use on element: DeviceRequest
... extension 1..1ExtensionLanguage
.... url 1..1uri"lang"
.... valueCode 0..1codeValue of extension
Binding: Common Languages (required)
... extension 1..1ExtensionText
.... url 1..1uri"content"
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- patientInstruction -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="lang"> 1..1 Extension  <!-- 1..1 Language -->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="content"> 1..1 Extension  <!-- 1..1 Text -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // patientInstruction
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Language // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "lang", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Text // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "content", // R! 
        "valueString" : "<string>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction", // R! 
// value[x]: Value of extension. One of these 46:
  }

 

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