HL7 FHIR JP Core ImplementationGuide
1.1.0 - release Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.0). See the Directory of published versions

Data Type Profile: JP_MedicationRange_UnitOfTime - Detailed Descriptions

Active as of 2022-10-24

Definitions for the jp-medicationrange-unitoftime data type profile.

1. Range
Definition

範囲指定された時間の上限下限

A set of ordered Quantities defined by a low and high limit.

Comments

時間の上限量、下限量の範囲を持っている。単位指定された数量を割り当てている。Low,Highの値は時間の単位当てはめる。

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

2. Range.low
3. Range.low.value
Definition

時間範囲(下限)

Control0..?
4. Range.low.unit
Control0..?
5. Range.low.system
Definition

UCUMを識別するURL。固定値。

Control0..?
BindingThe codes SHOULD be taken from UnitsOfTime
6. Range.low.code
Control0..?
BindingThe codes SHOULD be taken from UnitsOfTime
7. Range.high
8. Range.high.value
Definition

時間範囲(上限)

Control0..?
9. Range.high.unit
Control0..?
10. Range.high.system
Definition

UCUMを識別するURL。固定値。

Control0..?
BindingThe codes SHOULD be taken from UnitsOfTime
11. Range.high.code
Control0..?
BindingThe codes SHOULD be taken from UnitsOfTime
1. Range
Definition

範囲指定された時間の上限下限

A set of ordered Quantities defined by a low and high limit.

Control0..* This element is affected by the following invariants: ele-1
Comments

時間の上限量、下限量の範囲を持っている。単位指定された数量を割り当てている。Low,Highの値は時間の単位当てはめる。

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
rng-2: If present, low SHALL have a lower value than high (: low.empty() or high.empty() or (low <= high))
2. Range.low
Definition

The low limit. The boundary is inclusive.

Control0..1
TypeQuantity(SimpleQuantity)
Comments

If the low element is missing, the low boundary is not known.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Range.low.value
Definition

時間範囲(下限)

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

Control0..1
Typedecimal
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Range.low.comparator
Definition

Not allowed to be used in this context

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..01
BindingThe codes SHALL be taken from QuantityComparator

How the Quantity should be understood and represented.

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.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Range.low.unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Range.low.system
Definition

UCUMを識別するURL。固定値。

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
BindingThe codes SHOULD be taken from UnitsOfTimeFor codes, see (unbound)
Typeuri
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Range.low.code
Definition

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

Control0..1
BindingThe codes SHOULD be taken from UnitsOfTimeFor codes, see (unbound)
Typecode
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

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Range.high
Definition

The high limit. The boundary is inclusive.

Control0..1
TypeQuantity(SimpleQuantity)
Comments

If the high element is missing, the high boundary is not known.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Range.high.value
Definition

時間範囲(上限)

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

Control0..1
Typedecimal
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Range.high.comparator
Definition

Not allowed to be used in this context

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..01
BindingThe codes SHALL be taken from QuantityComparator

How the Quantity should be understood and represented.

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.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Range.high.unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Range.high.system
Definition

UCUMを識別するURL。固定値。

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
BindingThe codes SHOULD be taken from UnitsOfTimeFor codes, see (unbound)
Typeuri
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Range.high.code
Definition

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

Control0..1
BindingThe codes SHOULD be taken from UnitsOfTimeFor codes, see (unbound)
Typecode
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

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Range
Definition

範囲指定された時間の上限下限

Control0..* This element is affected by the following invariants: ele-1
Comments

時間の上限量、下限量の範囲を持っている。単位指定された数量を割り当てている。Low,Highの値は時間の単位当てはめる。

2. Range.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Range.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Range.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Range.low
Definition

The low limit. The boundary is inclusive.

Control0..1
TypeQuantity(SimpleQuantity)
Comments

If the low element is missing, the low boundary is not known.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Range.low.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
6. Range.low.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Range.low.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
7. Range.low.value
Definition

時間範囲(下限)

Control0..1
Typedecimal
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Range.low.comparator
Definition

Not allowed to be used in this context

Control0..0
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented
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.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Range.low.unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Range.low.system
Definition

UCUMを識別するURL。固定値。

Control0..1 This element is affected by the following invariants: qty-3
BindingThe codes SHOULD be taken from UnitsOfTime
Typeuri
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Range.low.code
Definition

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

Control0..1
BindingThe codes SHOULD be taken from UnitsOfTime
Typecode
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

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Range.high
Definition

The high limit. The boundary is inclusive.

Control0..1
TypeQuantity(SimpleQuantity)
Comments

If the high element is missing, the high boundary is not known.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Range.high.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. Range.high.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Range.high.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
15. Range.high.value
Definition

時間範囲(上限)

Control0..1
Typedecimal
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Range.high.comparator
Definition

Not allowed to be used in this context

Control0..0
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented
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.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Range.high.unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Range.high.system
Definition

UCUMを識別するURL。固定値。

Control0..1 This element is affected by the following invariants: qty-3
BindingThe codes SHOULD be taken from UnitsOfTime
Typeuri
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Range.high.code
Definition

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

Control0..1
BindingThe codes SHOULD be taken from UnitsOfTime
Typecode
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

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))