FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.3.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 R3 R2

Extension: allowedUnits

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

URL for this extension: 


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

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.

Context of Use: Use on data type: Element ID ElementDefinition

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 CodeableConcept , Reference 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 data type: Element ID ElementDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . 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 data type: Element ID ElementDefinition
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
. . . value[x] 1..1 CodeableConcept , Reference canonical ( ValueSet ) Value of extension
Binding: UCUM Codes ( required )

doco Documentation for this format

XML Template 

<!-- allowedUnits -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" >
  <!-- from Element: extension -->
 <</value[x]>

 <value[x]><!-- 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 ]

    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits", // R! 
// value[x]: Value of extension. One of these 2:
    "
    "

    "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
    "valueCanonical" : "<canonical>", // R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 CodeableConcept , Reference 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 data type: Element ID ElementDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . 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 data type: Element ID ElementDefinition
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
. . . value[x] 1..1 CodeableConcept , Reference canonical ( ValueSet ) Value of extension
Binding: UCUM Codes ( required )

doco Documentation for this format

XML Template 

<!-- allowedUnits -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" >
  <!-- from Element: extension -->
 <</value[x]>

 <value[x]><!-- 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 ]

    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits", // R! 
// value[x]: Value of extension. One of these 2:
    "
    "

    "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
    "valueCanonical" : "<canonical>", // 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')]) )