Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.3.0: R4B - STU ). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . 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 Trial Use Use Context : Any
Official URL for this extension: : http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits Version : 5.0.0-snapshot3
draft as of 2015-02-28 Computable Name : allowedUnits
Flags : Non-Modifier OID : TBD

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG Context of Use : Use on Element ID ElementDefinition

Definition

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . 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

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 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 )

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]><!-- 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 doco
. . 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

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 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 )

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]><!-- 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 unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters hasValue() or (children().count() > id.count()) )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.