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 . Page versions: R4B R4 R3

Extension: patientInstruction

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

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
Version:5.0.0-ballot
Name:patientInstruction
Title:Directions
Modifier:This extension is not a modifier extension
Status:draft
Definition:Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.
Committee:Orders and Observations Work Group

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 ID DeviceRequest

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. patientInstruction0..*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 ID DeviceRequest
... lang1..1codeLanguage

Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding

... content1..1stringText


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 ID DeviceRequest
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:lang 1..1ExtensionLanguage
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"lang"
.... value[x] 1..1codeValue of extension
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... extension:content 1..1ExtensionText
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"content"
.... value[x] 1..1stringValue of extension
... 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"> I 1..1 Extension  <!-- I 1..1 Language -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="content"> I 1..1 Extension  <!-- I 1..1 Text -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. patientInstruction0..*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 ID DeviceRequest
... lang1..1codeLanguage

Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding

... content1..1stringText


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 ID DeviceRequest
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:lang 1..1ExtensionLanguage
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"lang"
.... value[x] 1..1codeValue of extension
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... extension:content 1..1ExtensionText
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"content"
.... value[x] 1..1stringValue of extension
... 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"> I 1..1 Extension  <!-- I 1..1 Language -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="content"> I 1..1 Extension  <!-- I 1..1 Text -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

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

 

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.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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • 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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • 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.