HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build
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
Active as of 2023-10-31 |
Definitions for the jp-medicationratio-doseperperiod data type profile.
Guidance on how to interpret the contents of this table can be found here
0. Ratio | |
Definition | 単位時間内での薬剤の容量 A relationship of two Quantity values - expressed as a numerator and a denominator. |
Short | 単位時間内での薬剤の容量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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | ele-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) rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ((numerator.exists() and denominator.exists()) or (numerator.empty() and denominator.empty() and extension.exists())) |
2. Ratio.numerator | |
Definition | 投与量 The value of the numerator. |
Short | 投与量Numerator value |
Control | 0..1 |
Type | Quantity(JP Core Medication Quantity DataType) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Ratio.numerator.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). |
Control | 10..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
6. Ratio.numerator.comparator | |
Definition | 実際の値が計測して示された値よりも大きいのか小さいのかなど、値がどのように解釈され、表現されるのかを示している。たとえば、もし、comparatorエレメントが"<"であれば、実際の値は示された値よりも小さい(<)。 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 |
Comments | FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。 |
Control | 0..1 |
Binding | The 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 ) |
Type | code |
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | 計測法に制限があって値が<5ug/L や >400mg/L として示されるような場合でも値を扱えるようなフレームワークが必要である。 Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. Ratio.numerator.unit | |
Definition | 投与量の単位。 A human-readable form of the unit. |
Short | 投与量の単位Unit representation |
Comments | FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。 |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | コンテキストによってさまざまな単位の表現がある。固定された特定の表現が求められることがある。たとえば、mcgはmicrogramを表す。 There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Ratio.numerator.code | |
Definition | 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨(SHOULD) A computer processable form of the unit in some unit representation system. |
Short | 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨Coded form of the unit |
Comments | 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨(SHOULD)されるが、ローカルコード等を利用することも可能とする 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. |
Control | 10..1 |
Binding | The codes SHOULD be taken from For codes, see JP Core Medication MERIT9 Unit ValueSet (preferred to http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUnitMERIT9_VS ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Ratio.denominator | |
Definition | 単位時間 The value of the denominator. |
Short | 単位時間Denominator value |
Control | 0..1 |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. Ratio.denominator.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). |
Control | 0..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Invariants | 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. |
Short | < | <= | >= | > - how to understand the value |
Control | 0..1 |
Binding | The 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 ) |
Type | code |
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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 Missing | If there is no comparator, then there is no modification of the value |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Ratio.denominator.unit | |
Definition | 単位時間の単位。UCUMを使用する。 A human-readable form of the unit. |
Short | 単位時間の単位Unit representation |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Ratio.denominator.system | |
Definition | UCUMを識別するURL。固定値。 The identification of the system that provides the coded form of the unit. |
Short | UCUMを識別するURLSystem that defines coded unit form |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Ratio.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Short | Coded 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. |
Control | 0..1 |
Binding | The codes SHOULD be taken from For codes, see UnitsOfTime (preferred to http://hl7.org/fhir/ValueSet/units-of-time ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Invariants | ele-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. Ratio | |
Definition | 単位時間内での薬剤の容量 |
Short | 単位時間内での薬剤の容量 |
2. Ratio.numerator | |
Definition | 投与量 |
Short | 投与量 |
Type | Quantity(JP Core Medication Quantity DataType) |
4. Ratio.numerator.value | |
Definition | 投与量 |
Short | 投与量 |
6. Ratio.numerator.unit | |
Definition | 投与量の単位。 |
Short | 投与量の単位 |
8. Ratio.denominator | |
Definition | 単位時間 |
Short | 単位時間 |
10. Ratio.denominator.value | |
Definition | 単位時間 |
Short | 単位時間 |
12. Ratio.denominator.unit | |
Definition | 単位時間の単位。UCUMを使用する。 |
Short | 単位時間の単位 |
14. Ratio.denominator.system | |
Definition | UCUMを識別するURL。固定値。 |
Short | UCUMを識別するURL |
16. Ratio.denominator.code | |
Binding | The 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. Ratio | |
Definition | 単位時間内での薬剤の容量 |
Short | 単位時間内での薬剤の容量 |
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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | ele-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 )rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ( (numerator.exists() and denominator.exists()) or (numerator.empty() and denominator.empty() and 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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on Ratio.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. Ratio.numerator | |
Definition | 投与量 |
Short | 投与量 |
Control | 0..1 |
Type | Quantity(JP Core Medication Quantity DataType) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on Ratio.numerator.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
12. Ratio.numerator.value | |
Definition | 投与量 |
Short | 投与量 |
Comments | 暗示された精度については常に尊重すべきである。貨幣計算では制度に関する独自のルールがある(会計についての標準的な教科書を参照すること)。 |
Control | 1..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Invariants | ele-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)。 |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0 ) |
Type | code |
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | 計測法に制限があって値が<5ug/L や >400mg/L として示されるような場合でも値を扱えるようなフレームワークが必要である。 |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | ele-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)。 |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | コンテキストによってさまざまな単位の表現がある。固定された特定の表現が求められることがある。たとえば、mcgはmicrogramを表す。 |
Invariants | ele-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 |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | システムによって定義される単位のコードを把握しておく必要がある。 |
Invariants | ele-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)されるが、ローカルコード等を利用することも可能とする |
Control | 1..1 |
Binding | The codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSet (preferred to http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUnitMERIT9_VS ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. Ratio.denominator | |
Definition | 単位時間 |
Short | 単位時間 |
Control | 0..1 |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on Ratio.denominator.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. Ratio.denominator.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). |
Control | 0..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Invariants | ele-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 |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.3.0 ) |
Type | code |
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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 Missing | If there is no comparator, then there is no modification of the value |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. Ratio.denominator.unit | |
Definition | 単位時間の単位。UCUMを使用する。 |
Short | 単位時間の単位 |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. Ratio.denominator.system | |
Definition | UCUMを識別するURL。固定値。 |
Short | UCUMを識別するURL |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants | ele-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. |
Short | Coded 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. |
Control | 0..1 |
Binding | The codes SHOULD be taken from UnitsOfTime (preferred to http://hl7.org/fhir/ValueSet/units-of-time ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |