This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: patientInstruction

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

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
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 ID DeviceRequest
lang		1..1	code	Code for Language.
content		1..1	string	The actual text containing the instructions.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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 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
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction"
value[x]		0..0
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
Documentation for this format

XML Template

<!-- patientInstruction -->

<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]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="content">  1..1 Extension  <!--  1..1 Text -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
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 ID DeviceRequest
lang		1..1	code	Code for Language.
content		1..1	string	The actual text containing the instructions.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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 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
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction"
value[x]		0..0
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
Documentation for this format

XML Template

<!-- patientInstruction -->

<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]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="content">  1..1 Extension  <!--  1..1 Text -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

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

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)
• 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)