DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R4B R4 R3 R2

1.25.1.4 1.30.1.4 Using UCUM with FHIR Using UCUM with FHIR

The Units of Measure
Vocabulary Vocabulary Work Group Work Group Maturity Level : N/A Maturity Level : N/A Ballot Status : DSTU 2 Ballot Status : DSTU 2

The Units of Measure Coding System (UCUM) is recommended for use with the Coding System (UCUM) is recommended for use with the Quantity data type. data type.

1.25.1.4.1 1.30.1.4.1 Summary Summary

Source UCUM is made available by the Regenstrief Institute, Inc UCUM is made available by the Regenstrief Institute, Inc and The UCUM Organization at http://unitsofmeasure.org and The UCUM Organization at http://unitsofmeasure.org
System The URI http://unitsofmeasure.org The URI http://unitsofmeasure.org identifies UCUM codes identifies UCUM codes
Version Where a version is used, it should be the standard UCUM version e.g. 1.9. There is no need to use version in the Where a version is used, it should be the standard UCUM version e.g. 1.9. There is no need to use version in the Coding data type, only in Value sets that use UCUM codes data type, only in Value sets that use UCUM codes
Code Valid expressions using the case sensitive symbols Valid expressions using the case sensitive symbols
Display There is no defined display; the UCUM code is used directly for the display There is no defined display; the UCUM code is used directly for the display
Filter Properties Filter Properties Two filter properties are defined as described below Two filter properties are defined as described below

1.25.1.4.2 1.30.1.4.2 Copyright Copyright UCUM is Copyright © 1999-2013 Regenstrief Institute, Inc. and The UCUM Organization, Indianapolis, IN. All rights reserved. See TermsOfUse

UCUM is Copyright © 1999-2013 Regenstrief Institute, Inc. and The UCUM Organization, Indianapolis, IN. All rights reserved. See TermsOfUse for details. for details.

1.25.1.4.3 1.30.1.4.3 UCUM Filter Properties UCUM Filter Properties This section documents the property filters that can be used with the UCUM code system in value set composition statements.

This section documents the property filters that can be used with the UCUM code system in value set composition statements.

1.25.1.4.3.1 1.30.1.4.3.1 Property filter Property filter

Description Restricts the expression to a describe a particular UCUM base property Restricts the expression to a describe a particular UCUM base property
Property Name Property Name property
Operations Allowed Operations Allowed =
Values Allowed Values Allowed [string name of property] [string name of property]
Comments Restricts expressions to any expression that is comparable to a base unit with a matching property value. Note: this does not match the property on units, only base units Restricts expressions to any expression that is comparable to a base unit with a matching property value. Note: this does not match the property on units, only base units

1.25.1.4.3.2 1.30.1.4.3.2 Canonical Filter Canonical Filter

Description Allows for any expression that is comparable to the named unit Allows for any expression that is comparable to the named unit
Property Name Property Name canonical
Operations Allowed Operations Allowed = / in = / in
Values Allowed Values Allowed UCUM expression UCUM expression
Comments This allows any expression that is comparable to the given unit(s) This allows any expression that is comparable to the given unit(s)

1.25.1.4.4 1.30.1.4.4 Implicit Value Sets Implicit Value Sets Implicit value sets are those whose specification can be predicted based on the grammar of the underlying code system, and the known structure of the URL that refers to them. There is one set of implicit value sets defined for UCUM: By Canonical Value. If any value set resources exist with an identifier that conforms to the URL patterns specified below, the content of the resource must conform to the template provided. Profiles and other value set references are allowed to reference these value sets directly. The value set identifier http://unitsofmeasure.org/vs is a value set that contains all LOINC codes.

Implicit value sets are those whose specification can be predicted based on the grammar of the underlying code system, and the known structure of the URL that refers to them. There is one set of implicit value sets defined for UCUM: By Canonical Value.

If any value set resources exist with an identifier that conforms to the URL patterns specified below, the content of the resource must conform to the template provided. Profiles and other value set references are allowed to reference these value sets directly.

The value set identifier http://unitsofmeasure.org/vs is a value set that contains all UCUM codes.

1.25.1.4.4.1 1.30.1.4.4.1 Multi-Axial Hierarchy Entry UCUM Comparable Value Set A value set with an identifier of "http://unitsofmeasure.org/vs/[expression]" must conform to this template, where [expression] is a valid UCUM expression:

A value set with an identifier of "http://unitsofmeasure.org/vs/[expression]" must conform to this template, where [expression] is a valid UCUM expression: 

<ValueSet xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      [some html that identifies that this value set 
      includes all UCUM expressions that are comparable to the provided expression]
    </div>
  </text>
  <identifier value="http://unitsofmeasure.org/vs/[expression]"/>
  <version value="[optional - but recommended - UCUM version]"/>
  <name value="Ucum Expressions comparable to [expression]"/>
  <description value="Ucum Expressions comparable to [expression]"/>
  <status value="active"/>
  <date value="[optional date of LOINC release]"/>

  <date value="[optional date of UCUM release]"/>

  <compose>
    <include>
      <system value="http://unitsofmeasure.org"/>
      <filter>
        <property value="comparable"/>
        <op value="="/>
        <value value="[expression]"/>
      </filter>
    </include>
  </compose>
</ValueSet>
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:44+1100.
Links:
Search