Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.3.0: R4B - STU ). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: patientInstruction DeviceRequest Patient Directions

Orders and Observations Work Group   Maturity Level : 1 Informative Trial Use Use Context : Any
Official URL for this extension: : http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction Version : 5.0.0-snapshot3
draft as of 2015-02-21 Computable Name : DRPatientInstruction
Flags : Non-Modifier OID : 2.16.840.1.113883.4.642.5.1094

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG Context of Use : Use on Element ID DeviceRequest

Definition

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

Name Flags Card. Type Description & Constraints doco
. . patientInstruction DRPatientInstruction 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: DRPatientInstruction: Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.


Use on Element ID DeviceRequest
. . . lang 1..1 code Code for Language. Language

Binding: Common Languages ( preferred ): IETF language tag

Additional Bindings Purpose
All Languages Max Binding

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


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: DRPatientInstruction: 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..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:lang 1..1 Extension Language
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "lang"
. . . . value[x] 1..1 code Value of extension
Binding: Common Languages ( preferred ): IETF language tag

Additional Bindings Purpose
All Languages Max Binding
. . . extension:content 1..1 Extension Text
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "content"
. . . . value[x] 1..1 string Value of extension
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- patientInstruction -->

<!-- DRPatientInstruction -->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 

{ // 

{ // DRPatientInstruction

    "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

Name Flags Card. Type Description & Constraints doco
. . patientInstruction DRPatientInstruction 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: DRPatientInstruction: Simple concise instructions to be read by the patient. For example “twice a day” rather than “BID.”.


Use on Element ID DeviceRequest
. . . lang 1..1 code Code for Language. Language

Binding: Common Languages ( preferred ): IETF language tag

Additional Bindings Purpose
All Languages Max Binding

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


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
patientInstruction: DRPatientInstruction: 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..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:lang 1..1 Extension Language
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "lang"
. . . . value[x] 1..1 code Value of extension
Binding: Common Languages ( preferred ): IETF language tag

Additional Bindings Purpose
All Languages Max Binding
. . . extension:content 1..1 Extension Text
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "content"
. . . . value[x] 1..1 string Value of extension
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- patientInstruction -->

<!-- DRPatientInstruction -->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 

{ // 

{ // DRPatientInstruction

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

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.