Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

Summary

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

Version: 5.0.0-ballot

Name: unitOption

Title: null

Modifier: This extension is not a modifier extension

Status: draft

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

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: HL7

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

Comment:

Provide either unitOption(s) or 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. If this extension present and an answer is provided for the question item in the QuestionnaireResponse, then the valueQuantity SHALL have a Quantity.code and Quantity.system that match the Coding.code and system of one of the allowed values if the Coding has a code and/or system. If the Coding only has a display, then the Quantity.unit must match. (Note that Coding with only a display is strongly discouraged.) If there is a match on code and system, but no match on display/unit, systems MAY raise a warning. However, because of translation and bandwidth considerations, some systems MAY opt to drop the unit or express it in an alternate language.

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

Summary

Name	Flags	Card.	Type	Description & Constraints
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 ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
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 ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption"
value[x]	1..1	Coding	Value of extension
Documentation for this format

XML Template

<!-- unitOption -->

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

JSON Template

{ // unitOption
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption", // R! 
    "valueCoding" : { Coding } // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
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 ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
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 ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='quantity'</code>
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption"
value[x]	1..1	Coding	Value of extension
Documentation for this format

XML Template

<!-- unitOption -->

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

JSON Template

{ // unitOption
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption", // R! 
    "valueCoding" : { Coding } // I 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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.