HL7 FHIR JP Core ImplementationGuide
1.1.1 - release Japan flag

Publication Build: This will be filled in by the publication tooling

Data Type Profile: JP_MedicationRatio_DosePerDay - Detailed Descriptions

Active as of 2022-10-24

Definitions for the jp-medicationratio-doseperday data type profile.

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

0. Ratio
Definition

1日当たりでの薬剤の投入量

Short1日当たりでの薬剤の投入量
2. Ratio.denominator
4. Ratio.denominator.value
Definition

単位時間(1日)固定

Short単位時間(1日)
Fixed Value1
6. Ratio.denominator.unit
Fixed Value
8. Ratio.denominator.system
Fixed Valuehttp://unitsofmeasure.org
10. Ratio.denominator.code
BindingThe codes SHALL be taken from UnitsOfTime
Fixed Valued

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

0. Ratio
Definition

1日当たりでの薬剤の投入量


A relationship of two Quantity values - expressed as a numerator and a denominator.

Short1日当たりでの薬剤の投入量A ratio of two Quantity values - a numerator and a denominator
Comments

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ((numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()))
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ((numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()))

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

0. Ratio
Definition

1日当たりでの薬剤の投入量

Short1日当たりでの薬剤の投入量
Comments

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ((numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()))
2. Ratio.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Ratio.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 Ratio.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Ratio.numerator
Definition

投与量

Short投与量
Comments

薬剤に関する数量と単位を定めている。ValueおよびCodeを必須としている。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD)

Control0..1
This element is affected by the following invariants: ele-1
TypeQuantity(JP Core Medication Quantity DataType)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
8. Ratio.numerator.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. Ratio.numerator.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 Ratio.numerator.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. Ratio.numerator.value
Definition

投与量

Short投与量
Comments

暗示された精度については常に尊重すべきである。貨幣計算では制度に関する独自のルールがある(会計についての標準的な教科書を参照すること)。

Control1..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. Ratio.numerator.comparator
Definition

実際の値が計測して示された値よりも大きいのか小さいのかなど、値がどのように解釈され、表現されるのかを示している。たとえば、もし、comparatorエレメントが"<"であれば、実際の値は示された値よりも小さい(<)。

Short< | <= | >= | > - 値の解釈法
Comments

FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。

Control0..1
BindingThe codes SHALL be taken from QuantityComparator

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; 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

計測法に制限があって値が<5ug/L や >400mg/L として示されるような場合でも値を扱えるようなフレームワークが必要である。

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. Ratio.numerator.unit
Definition

投与量の単位。

Short投与量の単位
Comments

FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。

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

コンテキストによってさまざまな単位の表現がある。固定された特定の表現が求められることがある。たとえば、mcgはmicrogramを表す。

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

単位をコード化して表現するシステムについてのID。

Shortコード化された単位表現を規定するシステム
Comments

以下参照。 http://en.wikipedia.org/wiki/Uniform_resource_identifier

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

システムによって定義される単位のコードを把握しておく必要がある。

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

単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨(SHOULD)

Short単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨
Comments

単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨(SHOULD)されるが、ローカルコード等を利用することも可能とする

Control1..1
BindingThe codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSet
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. Ratio.denominator
Definition

単位時間

Short単位時間
Control0..1
TypeQuantity
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Ratio.denominator.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
26. Ratio.denominator.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 Ratio.denominator.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. Ratio.denominator.value
Definition

単位時間(1日)固定

Short単位時間(1日)
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.

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

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..1
BindingThe codes SHALL be taken from QuantityComparator

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; 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. Ratio.denominator.unit
Definition

単位時間の単位。UCUMを使用する。

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.

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

Fixed Valuehttp://unitsofmeasure.org
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Ratio.denominator.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 SHALL be taken from UnitsOfTime
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.

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