R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (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

Extension: proficiency

Patient Administration Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

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

Status: draft. Extension maintained by: HL7

Proficiency level of the communication.

Context of Use: Use on Element ID Patient.communication

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. proficiency0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-proficiency
proficiency: Proficiency level of the communication.


Use on Element ID Patient.communication
... level0..1CodingHow well the patient can communicate this communication (good, poor, etc.).

... type0..*CodingWhat type of communication for the proficiency (spoken, written, etc.).


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-proficiency
proficiency: Proficiency level of the communication.


Use on Element ID Patient.communication
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 0..1ExtensionThe proficiency level of the communication
.... extension 0..0
.... url 1..1uri"level"
.... valueCoding 0..1CodingValue of extension
Binding: LanguageAbilityProficiency (preferred)
... extension 0..*ExtensionThe proficiency type of the communication
.... extension 0..0
.... url 1..1uri"type"
.... valueCoding 0..1CodingValue of extension
Binding: LanguageAbilityMode (preferred)
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-proficiency"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- proficiency -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-proficiency" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="level"> 0..1 Extension  <!-- 0..1 The proficiency level of the communication -->
  <valueCoding><!-- 0..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="type"> 0..* Extension  <!-- 0..* The proficiency type of the communication -->
  <valueCoding><!-- 0..1 Coding Value of extension --></valueCoding>
 </extension>
</extension>

JSON Template

{ // proficiency
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The proficiency level of the communication //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "level", // R! 
        "valueCoding" : { Coding } //Value of extension
      },
      { // The proficiency type of the communication //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCoding" : { Coding } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-proficiency", // R! 
// value[x]: Value of extension. One of these 49:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. proficiency0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-proficiency
proficiency: Proficiency level of the communication.


Use on Element ID Patient.communication
... level0..1CodingHow well the patient can communicate this communication (good, poor, etc.).

... type0..*CodingWhat type of communication for the proficiency (spoken, written, etc.).


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-proficiency
proficiency: Proficiency level of the communication.


Use on Element ID Patient.communication
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 0..1ExtensionThe proficiency level of the communication
.... extension 0..0
.... url 1..1uri"level"
.... valueCoding 0..1CodingValue of extension
Binding: LanguageAbilityProficiency (preferred)
... extension 0..*ExtensionThe proficiency type of the communication
.... extension 0..0
.... url 1..1uri"type"
.... valueCoding 0..1CodingValue of extension
Binding: LanguageAbilityMode (preferred)
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-proficiency"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- proficiency -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-proficiency" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="level"> 0..1 Extension  <!-- 0..1 The proficiency level of the communication -->
  <valueCoding><!-- 0..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="type"> 0..* Extension  <!-- 0..* The proficiency type of the communication -->
  <valueCoding><!-- 0..1 Coding Value of extension --></valueCoding>
 </extension>
</extension>

JSON Template

{ // proficiency
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The proficiency level of the communication //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "level", // R! 
        "valueCoding" : { Coding } //Value of extension
      },
      { // The proficiency type of the communication //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCoding" : { Coding } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-proficiency", // 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')]))