Release 5 Ballot

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

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits

Version: 5.0.0-ballot

Name: allowedUnits

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: Identifies the units of measure in which the element should be captured or expressed.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

Identifies the units of measure in which the element should be captured or expressed.

Comment:

Use a value set if more than one unit of measure is possible. Value sets will typically be short enough to display in a drop-down selection list.

Context of Use: Use on Element ID ElementDefinition

Summary

Name	Flags	Card.	Type	Description & Constraints
allowedUnits		0..1	CodeableConcept, canonical(ValueSet)	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits allowedUnits: Identifies the units of measure in which the element should be captured or expressed. Binding: UCUM Codes (required) Use on Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits allowedUnits: Identifies the units of measure in which the element should be captured or expressed. Use on Element ID ElementDefinition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
value[x]	1..1		Value of extension Binding: UCUM Codes (required)
valueCodeableConcept		CodeableConcept
valueCanonical		canonical(ValueSet)
Documentation for this format

XML Template

<!-- allowedUnits -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 CodeableConcept|canonical Value of extension --></value[x]>
</extension>

JSON Template

{ // allowedUnits
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits", // R! 
  // value[x]: Value of extension. One of these 2:
    "valueCodeableConcept" : { CodeableConcept }, // I R! Value of extension
    "valueCanonical" : "<canonical>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
allowedUnits		0..1	CodeableConcept, canonical(ValueSet)	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits allowedUnits: Identifies the units of measure in which the element should be captured or expressed. Binding: UCUM Codes (required) Use on Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits allowedUnits: Identifies the units of measure in which the element should be captured or expressed. Use on Element ID ElementDefinition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
value[x]	1..1		Value of extension Binding: UCUM Codes (required)
valueCodeableConcept		CodeableConcept
valueCanonical		canonical(ValueSet)
Documentation for this format

XML Template

<!-- allowedUnits -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 CodeableConcept|canonical Value of extension --></value[x]>
</extension>

JSON Template

{ // allowedUnits
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits", // R! 
  // value[x]: Value of extension. One of these 2:
    "valueCodeableConcept" : { CodeableConcept }, // I R! Value of extension
    "valueCanonical" : "<canonical>" // 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.