HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v2.0.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: JP_MedicationRange_UnitOfTime - Detailed Descriptions

Active as of 2023-10-31

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

Guidance on how to interpret the contents of this table can be found here

0. Range
Definition

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


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

Short範囲指定された時間の上限下限Set of values bounded by low and high
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.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
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.

Short時間範囲(下限)Low limit
Comments

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

Control0..1
TypeQuantity(SimpleQuantity)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Range.low.value
Definition

時間範囲(下限)


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

Short時間範囲(下限)Numerical value (with implicit precision)
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).

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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.

Short< | <= | >= | > - how to understand the value
Control0..01
BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0)
Typecode
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Range.low.unit
Definition

A human-readable form of the unit.

Short単位時間の単位Unit representation
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

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

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


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

ShortUCUMを識別するURLSystem that defines coded unit form
Control0..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Range.low.code
Definition

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

ShortCoded form of the unit
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.

Control0..1
BindingThe codes SHOULD be taken from For codes, see UnitsOfTime
(preferred to http://hl7.org/fhir/ValueSet/units-of-time)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Range.high
Definition

The high limit. The boundary is inclusive.

Short時間範囲(上限)High limit
Comments

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

Control0..1
TypeQuantity(SimpleQuantity)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Range.high.value
Definition

時間範囲(上限)


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

Short時間範囲(上限)Numerical value (with implicit precision)
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).

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. 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.

Short< | <= | >= | > - how to understand the value
Control0..01
BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0)
Typecode
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Range.high.unit
Definition

A human-readable form of the unit.

Short単位時間の単位Unit representation
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Range.high.system
Definition

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


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

ShortUCUMを識別するURLSystem that defines coded unit form
Control0..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Range.high.code
Definition

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

ShortCoded form of the unit
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.

Control0..1
BindingThe codes SHOULD be taken from For codes, see UnitsOfTime
(preferred to http://hl7.org/fhir/ValueSet/units-of-time)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Range
Definition

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

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

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

2. Range.low
Short時間範囲(下限)
4. Range.low.value
Definition

時間範囲(下限)

Short時間範囲(下限)
6. Range.low.unit
Short単位時間の単位
8. Range.low.system
Definition

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

ShortUCUMを識別するURL
10. Range.low.code
BindingThe codes SHOULD be taken from UnitsOfTime
(preferred to http://hl7.org/fhir/ValueSet/units-of-time)
12. Range.high
Short時間範囲(上限)
14. Range.high.value
Definition

時間範囲(上限)

Short時間範囲(上限)
16. Range.high.unit
Short単位時間の単位
18. Range.high.system
Definition

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

ShortUCUMを識別するURL
20. Range.high.code
BindingThe codes SHOULD be taken from UnitsOfTime
(preferred to http://hl7.org/fhir/ValueSet/units-of-time)

Guidance on how to interpret the contents of this table can be found here

0. Range
Definition

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

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

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

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
rng-2: If present, low SHALL have a lower value than high (low.empty() or high.empty() or (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.

ShortUnique id for inter-element referencing
Control0..1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Range.low
    Definition

    The low limit. The boundary is inclusive.

    Short時間範囲(下限)
    Comments

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

    Control0..1
    TypeQuantity(SimpleQuantity)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. 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.

    ShortUnique id for inter-element referencing
    Control0..1
    Typeid
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    10. 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.

    ShortAdditional content defined by implementations
    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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 areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. Range.low.value
      Definition

      時間範囲(下限)

      Short時間範囲(下限)
      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).

      Control0..1
      Typedecimal
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Precision is handled implicitly in almost all cases of measurement.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      14. Range.low.comparator
      Definition

      Not allowed to be used in this context

      Short< | <= | >= | > - how to understand the value
      Control0..0
      BindingThe codes SHALL be taken from QuantityComparator
      (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0)
      Typecode
      Is Modifiertrue because 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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      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
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Range.low.unit
      Definition

      A human-readable form of the unit.

      Short単位時間の単位
      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Range.low.system
      Definition

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

      ShortUCUMを識別するURL
      Control0..1
      This element is affected by the following invariants: qty-3
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Range.low.code
      Definition

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

      ShortCoded form of the unit
      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.

      Control0..1
      BindingThe codes SHOULD be taken from UnitsOfTime
      (preferred to http://hl7.org/fhir/ValueSet/units-of-time)
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      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.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Range.high
      Definition

      The high limit. The boundary is inclusive.

      Short時間範囲(上限)
      Comments

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

      Control0..1
      TypeQuantity(SimpleQuantity)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. 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.

      ShortUnique id for inter-element referencing
      Control0..1
      Typeid
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      26. 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.

      ShortAdditional content defined by implementations
      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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 areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 28. Range.high.value
        Definition

        時間範囲(上限)

        Short時間範囲(上限)
        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).

        Control0..1
        Typedecimal
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Precision is handled implicitly in almost all cases of measurement.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. Range.high.comparator
        Definition

        Not allowed to be used in this context

        Short< | <= | >= | > - how to understand the value
        Control0..0
        BindingThe codes SHALL be taken from QuantityComparator
        (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0)
        Typecode
        Is Modifiertrue because 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
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        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
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Range.high.unit
        Definition

        A human-readable form of the unit.

        Short単位時間の単位
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Range.high.system
        Definition

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

        ShortUCUMを識別するURL
        Control0..1
        This element is affected by the following invariants: qty-3
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Range.high.code
        Definition

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

        ShortCoded form of the unit
        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.

        Control0..1
        BindingThe codes SHOULD be taken from UnitsOfTime
        (preferred to http://hl7.org/fhir/ValueSet/units-of-time)
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けております。