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_MedicationRatio_DosePerDay - Detailed Descriptions

Active as of 2022-10-24

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

1. Ratio
Definition

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

単位時間内での薬剤の容量

2. Ratio.denominator
Control0..?
3. Ratio.denominator.value
Definition

単位時間(1日)固定

単位時間

Fixed Value1
4. Ratio.denominator.unit
Fixed Value
5. Ratio.denominator.system
Fixed Valuehttp://unitsofmeasure.org
6. Ratio.denominator.code
BindingThe codes SHALL be taken from UnitsOfTimeThe codes SHOULD be taken from UnitsOfTime
Fixed Valued
1. Ratio
Definition

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

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

Control0..* This element is affected by the following invariants: ele-1
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.

InvariantsDefined on this element
ele-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()))
1. Ratio
Definition

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

Control0..* This element is affected by the following invariants: ele-1
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.

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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. 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.

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 Ratio.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Ratio.numerator
Definition

投与量

Control0..1 This element is affected by the following invariants: ele-1
TypeQuantity(JP_MedicationQuantity)
Comments

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

InvariantsDefined on this element
ele-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())
5. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
6. 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.

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 Ratio.numerator.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
7. Ratio.numerator.value
Definition

投与量

Control1..1
Typedecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

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

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

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

Control0..1
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented
Typecode
Is Modifiertrue
Requirements

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

Comments

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

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

投与量の単位。

Control0..1
Typestring
Requirements

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

Comments

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

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

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

Control0..1 This element is affected by the following invariants: qty-3
BindingThe codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSet
Typeuri
Requirements

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

Comments

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

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

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

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

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

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

単位時間

Control0..1
TypeQuantity
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. 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.

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 Ratio.denominator.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
15. Ratio.denominator.value
Definition

単位時間(1日)固定

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).

Fixed Value1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. 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.

Control0..1
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. Ratio.denominator.unit
Definition

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

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.

Fixed Value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Ratio.denominator.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.

Fixed Valuehttp://unitsofmeasure.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Ratio.denominator.code
Definition

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

Control0..1
BindingThe codes SHALL 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.

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