FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (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 R3

Extension: patientInstruction

Orders and Observations Work Group   Maturity Level : 1 Informative Use 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.”.

Comment :

Should use only common terms and sentences. Use of unfamiliar words and jargon should be avoided.

Context of Use: Use on element: Element ID DeviceRequest

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension patientInstruction 0..* Extension URL = 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: Element ID DeviceRequest
. . . lang 1..1 code Code for Language.

. . . content 1..1 string The actual text containing the instructions.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = 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: Element ID DeviceRequest
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Language
. . . . extension 0..0
... . url 1..1 uri "lang" "lang"
. . . . valueCode 0..1 code Value of extension
Binding: Common Languages Language ( required preferred )
. . . extension 1..1 Extension Text
. . . . extension 0..0
... . url 1..1 uri "content" "content"
. . . . valueString 0..1 string Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction" "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 49:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension patientInstruction 0..* Extension URL = 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: Element ID DeviceRequest
. . . lang 1..1 code Code for Language.

. . . content 1..1 string The actual text containing the instructions.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = 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: Element ID DeviceRequest
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Language
. . . . extension 0..0
... . url 1..1 uri "lang" "lang"
. . . . valueCode 0..1 code Value of extension
Binding: Common Languages Language ( required preferred )
. . . extension 1..1 Extension Text
. . . . extension 0..0
... . url 1..1 uri "content" "content"
. . . . valueString 0..1 string Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction" "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 49:
  }

 

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