Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: Release 5 Snapshot #1). 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: unitOption

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption

Status: draft. Extension maintained by: HL7

A unit that the user may choose when providing a quantity value.

Comment :

Provide either unit-option(s) unitOption(s) or unit-valueSet. unitValueSet. If either of the extensions are present, the units for a Quantity element are constrained to only the units listed by the extensions - i.e. it is treated as a "required", not an "extensible" binding. In the absence of either, any unit is valid. See additional guidance and examples in the SDC implementation guide .

Context of Use: Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, Questionnaire.item, with Context Invariant = type='quantity'

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . unitOption 0..* Coding URL = http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
unitOption: A unit that the user may choose when providing a quantity value.


Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
unitOption: A unit that the user may choose when providing a quantity value.


Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>
. . . Slices for extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption"
. . . value[x] I 1..1 Coding Value of extension

doco Documentation for this format

XML Template 

<!-- unitOption -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption" >
  <!-- from Element: extension -->
 <</valueCoding>

 <valueCoding><!-- ?? 1..1 Coding Value of extension --></valueCoding>

</extension>

JSON Template 

{ // unitOption
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption", // R! 
    "

    "valueCoding" : { Coding } // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . unitOption 0..* Coding URL = http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
unitOption: A unit that the user may choose when providing a quantity value.


Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
unitOption: A unit that the user may choose when providing a quantity value.


Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>
. . . Slices for extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption"
. . . value[x] I 1..1 Coding Value of extension

doco Documentation for this format

XML Template 

<!-- unitOption -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption" >
  <!-- from Element: extension -->
 <</valueCoding>

 <valueCoding><!-- ?? 1..1 Coding Value of extension --></valueCoding>

</extension>

JSON Template 

{ // unitOption
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption", // R! 
    "

    "valueCoding" : { Coding } // 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 )