PrescribeIT™ Specification and Guide Version 2.0 Revision F

 

Definitions for the dtprofile-quantity-drug Profile.

Quantity
Definition

A measured or counted amount of a medication expressed as a value and human-readable string with optional coded units expressed in a local coding system

Control0..*
Must Supporttrue
Comments

Usage Note: Quantity is used throughout the messages. It may be a drug form (e.g. TAB) an administrable drug (e.g. PUFF) form or a unit of measure (e.g. mg).

Max Length0
InvariantsDefined on this element
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty())
Quantity.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Quantity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Quantity.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control1..1
Typedecimal
Must Supporttrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Max Length0
Quantity.comparator
Definition

Not allowed to be used in this context

Control0..0
BindingHow the Quantity should be understood and represented.
The codes SHALL be taken from QuantityComparator
Typecode
Is Modifiertrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.

Max Length0
Meaning if MissingIf there is no comparator, then there is no modification of the value
Quantity.unit
Definition

A human-readable form of the unit.

Control1..1
Typestring
Must Supporttrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Usage Note: This must be used to convey the english display that is associated with the code. (Note: Rationale for change: to accommodate fax template)

Max Length0
Quantity.system
Definition

The identification of the system that provides the coded form of the unit.

Control0..1 This element is affected by the following invariants: qty-3
Typeuri
Must Supporttrue
Requirements

Need to know the system that defines the coded form of the unit.

Max Length0
Quantity.code
Definition

A computer processable form of the unit in some unit representation system.

Control0..1
BindingThe codes SHALL be taken from PrescribedQuantityUnit; other codes may be used where these codes are not suitable
Typecode
Must Supporttrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

Conformance Rule: A Code must be supplied if one is available from the PrescribedQuantityUnit subset. If the user picks a prescribed quantity unit that does not have a code in the PrescribedQuantityUnit subset, only then can unit be supplied without a code. If a receiving system receives a code that it doesn't recognize, the system must just display the unit.

Max Length0