Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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 R2

Extension: interpreterRequired

Patient Administration Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired

Status: draft. Extension maintained by: HL7

This Patient requires an interpreter to communicate healthcare information to the practitioner.

Comment:

The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.

Context of Use: Use on Element ID Patient

Summary

Name	Flags	Card.	Type	Description & Constraints
interpreterRequired		0..1	boolean	URL = http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired interpreterRequired: This Patient requires an interpreter to communicate healthcare information to the practitioner. Use on Element ID Patient
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired interpreterRequired: This Patient requires an interpreter to communicate healthcare information to the practitioner. Use on Element ID Patient
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	1..1	boolean	Value of extension
Documentation for this format

XML Template

<!-- interpreterRequired -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // interpreterRequired
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired", // R! 
    "valueBoolean" : <boolean> // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
interpreterRequired		0..1	boolean	URL = http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired interpreterRequired: This Patient requires an interpreter to communicate healthcare information to the practitioner. Use on Element ID Patient
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired interpreterRequired: This Patient requires an interpreter to communicate healthcare information to the practitioner. Use on Element ID Patient
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	1..1	boolean	Value of extension
Documentation for this format

XML Template

<!-- interpreterRequired -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // interpreterRequired
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired", // R! 
    "valueBoolean" : <boolean> // C? R! Value of extension
  }

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.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)