Release 4B

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

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

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
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:level 0..1ExtensionThe proficiency level of the communication
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"level"
.... value[x] 1..1CodingValue of extension
Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.

... extension:type 0..*ExtensionThe proficiency type of the communication
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodingValue of extension
Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.

... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage

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><!-- ?? 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="type"> ?? 0..* Extension  <!-- ?? 0..* The proficiency type of the communication -->
  <valueCoding><!-- ?? 1..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 // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "level", // R! 
        "valueCoding" : { Coding } // C? R! Value of extension
      },
      { // The proficiency type of the communication // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCoding" : { Coding } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-proficiency", // R! 
// value[x]: Value of extension. One of these 51:
  }

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
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:level 0..1ExtensionThe proficiency level of the communication
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"level"
.... value[x] 1..1CodingValue of extension
Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.

... extension:type 0..*ExtensionThe proficiency type of the communication
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodingValue of extension
Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.

... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage

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