Medication Quantity DataType - Definitions

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

Active as of 2022-10-24

Definitions for the jp-medicationsimplequantity data type profile.

1. Quantity
Definition	薬剤に関する数量と単位を定めた簡易データイプ The comparator is not used on a SimpleQuantity
Comments	薬剤に関する簡易的な数量と単位を定めている。ValueおよびCodeを必須とし、comparatorは記述不可。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD) The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
2. Quantity.value
Definition	計測された量。精度を含めた値が暗示される。 The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Control	10..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).
3. Quantity.unit
Definition	人間にも可読な単位表現 A human-readable form of the unit.
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)。
4. Quantity.system
Definition	単位をコード化して表現するシステムについてのID。 The identification of the system that provides the coded form of the unit.
Binding	The codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSetFor codes, see (unbound)
Requirements	システムによって定義される単位のコードを把握しておく必要がある。 Need to know the system that defines the coded form of the unit.
Comments	以下参照。 http://en.wikipedia.org/wiki/Uniform_resource_identifier
5. Quantity.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)
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.

1. Quantity
Definition	薬剤に関する数量と単位を定めた簡易データイプ A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
Control	0..* This element is affected by the following invariants: ele-1
Comments	薬剤に関する簡易的な数量と単位を定めている。ValueおよびCodeを必須とし、comparatorは記述不可。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD) The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
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()) sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty())
2. Quantity.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()))
3. Quantity.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.
Control	0..01
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()))
4. Quantity.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()))
5. Quantity.system
Definition	単位をコード化して表現するシステムについてのID。 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
Binding	The codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSetFor codes, see (unbound)
Type	uri
Requirements	システムによって定義される単位のコードを把握しておく必要がある。 Need to know the system that defines the coded form of the unit.
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()))
6. Quantity.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()))

1. Quantity
Definition	薬剤に関する数量と単位を定めた簡易データイプ
Control	0..* This element is affected by the following invariants: ele-1
Comments	薬剤に関する簡易的な数量と単位を定めている。ValueおよびCodeを必須とし、comparatorは記述不可。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD)
2. Quantity.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. Quantity.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 Quantity.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Quantity.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()))
5. Quantity.comparator
Definition	Not allowed to be used in this context
Control	0..0
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()))
6. Quantity.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()))
7. Quantity.system
Definition	単位をコード化して表現するシステムについてのID。
Control	0..1 This element is affected by the following invariants: qty-3
Binding	The codes SHOULD be taken from JP Core Medication MERIT9 Unit ValueSet
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()))
8. Quantity.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()))

IG © 2022+ FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI). Package hl7.fhir.jp.core#1.1.0 based on FHIR 4.0.1. Generated 2022-11-03
Links: Table of Contents | QA Report