HL7 FHIR JP Core ImplementationGuide
1.1.1 - release
HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). See the Directory of published versions
Active as of 2022-10-31 |
Definitions for the jp-medicationratio-doseperperiod data type profile.
1. Ratio | |
Definition | 単位時間内での薬剤の容量 A relationship of two Quantity values - expressed as a numerator and a denominator. |
2. Ratio.numerator | |
Definition | 投与量 The value of the numerator. |
Type | Quantity(JP_MedicationQuantity) |
3. Ratio.numerator.value | |
Definition | 投与量 |
Control | 0..? |
4. Ratio.numerator.unit | |
Definition | 投与量の単位。 |
Control | 0..? |
5. Ratio.denominator | |
Definition | 単位時間 The value of the denominator. |
6. Ratio.denominator.value | |
Definition | 単位時間 |
Control | 0..? |
7. Ratio.denominator.unit | |
Definition | 単位時間の単位。UCUMを使用する。 |
Control | 0..? |
8. Ratio.denominator.system | |
Definition | UCUMを識別するURL。固定値。 |
Control | 0..? |
9. Ratio.denominator.code | |
Control | 0..? |
Binding | The codes SHOULD be taken from UnitsOfTime |
1. Ratio | |
Definition | 単位時間内での薬剤の容量 A relationship of two Quantity values - expressed as a numerator and a denominator. |
Control | 0..* 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. |
Invariants | Defined 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())) |
2. Ratio.numerator | |
Definition | 投与量 The value of the numerator. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(JP_MedicationQuantity) |
Comments | 薬剤に関する数量と単位を定めている。ValueおよびCodeを必須としている。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD) |
Invariants | Defined 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()) |
3. Ratio.numerator.value | |
Definition | 投与量 The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 10..1 |
Type | decimal |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented. |
Type | code |
Is Modifier | 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. |
Comments | FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。 |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. Ratio.numerator.unit | |
Definition | 投与量の単位。 A human-readable form of the unit. |
Control | 0..1 |
Type | string |
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. |
Comments | FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. Ratio.numerator.code | |
Definition | 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨(SHOULD) A computer processable form of the unit in some unit representation system. |
Control | 10..1 |
Binding | The codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSetFor codes, see (unbound) |
Type | code |
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)されるが、ローカルコード等を利用することも可能とする 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. Ratio.denominator | |
Definition | 単位時間 The value of the denominator. |
Control | 0..1 |
Type | Quantity |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. Ratio.denominator.value | |
Definition | 単位時間 The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 0..1 |
Type | decimal |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented. |
Type | code |
Is Modifier | 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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. Ratio.denominator.unit | |
Definition | 単位時間の単位。UCUMを使用する。 A human-readable form of the unit. |
Control | 0..1 |
Type | string |
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. Ratio.denominator.system | |
Definition | UCUMを識別するURL。固定値。 The identification of the system that provides the coded form of the unit. |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. Ratio.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 0..1 |
Binding | The codes SHOULD be taken from UnitsOfTimeFor codes, see (unbound) |
Type | code |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
1. Ratio | |
Definition | 単位時間内での薬剤の容量 |
Control | 0..* 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. |
Control | 0..1 |
Type | string |
XML Representation | In 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensionsuser 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Ratio.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Ratio.numerator | |
Definition | 投与量 |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(JP_MedicationQuantity) |
Comments | 薬剤に関する数量と単位を定めている。ValueおよびCodeを必須としている。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD) |
Invariants | Defined 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. |
Control | 0..1 |
Type | string |
XML Representation | In 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensionsuser 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Ratio.numerator.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
7. Ratio.numerator.value | |
Definition | 投与量 |
Control | 1..1 |
Type | decimal |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | 暗示された精度については常に尊重すべきである。貨幣計算では制度に関する独自のルールがある(会計についての標準的な教科書を参照すること)。 |
Invariants | Defined 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エレメントが"<"であれば、実際の値は示された値よりも小さい(<)。 |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented |
Type | code |
Is Modifier | true |
Requirements | 計測法に制限があって値が<5ug/L や >400mg/L として示されるような場合でも値を扱えるようなフレームワークが必要である。 |
Comments | FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。 |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | Defined 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 | 投与量の単位。 |
Control | 0..1 |
Type | string |
Requirements | コンテキストによってさまざまな単位の表現がある。固定された特定の表現が求められることがある。たとえば、mcgはmicrogramを表す。 |
Comments | FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。 |
Invariants | Defined 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。 |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Requirements | システムによって定義される単位のコードを把握しておく必要がある。 |
Comments | 以下参照。 http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants | Defined 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) |
Control | 1..1 |
Binding | The codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSet |
Type | code |
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)されるが、ローカルコード等を利用することも可能とする |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. Ratio.denominator | |
Definition | 単位時間 |
Control | 0..1 |
Type | Quantity |
Invariants | Defined 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. |
Control | 0..1 |
Type | string |
XML Representation | In 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensionsuser 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Ratio.denominator.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
15. Ratio.denominator.value | |
Definition | 単位時間 |
Control | 0..1 |
Type | decimal |
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). |
Invariants | Defined 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented |
Type | code |
Is Modifier | 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 | Defined 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を使用する。 |
Control | 0..1 |
Type | string |
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 | Defined 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。固定値。 |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants | Defined 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. |
Control | 0..1 |
Binding | The codes SHOULD be taken from UnitsOfTime |
Type | code |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |