HL7 FHIR JP Core ImplementationGuide
1.2.0-dev - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.2.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: JP Core Medication Rate Ratio DataType

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRatio_DosePerPeriod
Version 1.2.0-dev
Name

JP_MedicationRatio_DosePerPeriod

Title

JP Core Medication Rate Ratio DataType

Status Active ( 2023-10-31 )
Copyright

Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

このデータタイプはRatio DataTypeに対して、薬剤量/単位時間を表す比率を割り当てた制約と拡張を定めたものである。

Usage:

プロファイル詳細

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Ratio

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio 0..* Ratio 単位時間内での薬剤の容量
... numerator 0..1 JP_MedicationQuantity 投与量
.... value 1..1 decimal 投与量
.... unit 0..1 string 投与量の単位
... denominator 0..1 Quantity 単位時間
.... value 0..1 decimal 単位時間
.... unit 0..1 string 単位時間の単位
.... system 0..1 uri UCUMを識別するURL
.... code 0..1 code ユニットのコード化された形式 / Coded form of the unit
Binding: UnitsOfTime (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio 単位時間内での薬剤の容量
rat-1: 分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... numerator C 0..1 JP_MedicationQuantity 投与量
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
.... value Σ 1..1 decimal 投与量
.... comparator ?!Σ 0..1 code < | <= | >= | > - 値の解釈法
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 投与量の単位
.... code Σ 1..1 code 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨
Binding: JP Core Medication MERIT9 Unit ValueSet (preferred)
... denominator Σ 0..1 Quantity 単位時間
.... value Σ 0..1 decimal 単位時間
.... comparator ?!Σ 0..1 code <|<= |> = |> - 価値を理解する方法 / < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 単位時間の単位
.... system ΣC 0..1 uri UCUMを識別するURL
.... code Σ 0..1 code ユニットのコード化された形式 / Coded form of the unit
Binding: UnitsOfTime (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio 単位時間内での薬剤の容量
rat-1: 分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
... numerator C 0..1 JP_MedicationQuantity 投与量
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
.... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal 投与量
.... comparator ?!Σ 0..1 code < | <= | >= | > - 値の解釈法
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 投与量の単位
.... system ΣC 0..1 uri コード化された単位表現を規定するシステム
.... code Σ 1..1 code 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨
Binding: JP Core Medication MERIT9 Unit ValueSet (preferred)
... denominator Σ 0..1 Quantity 単位時間
.... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal 単位時間
.... comparator ?!Σ 0..1 code <|<= |> = |> - 価値を理解する方法 / < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 単位時間の単位
.... system ΣC 0..1 uri UCUMを識別するURL
.... code Σ 0..1 code ユニットのコード化された形式 / Coded form of the unit
Binding: UnitsOfTime (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ratio.numerator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Ratio.numerator.codepreferredJP_MedicationUnitMERIT9_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUnitMERIT9_VS
Ratio.denominator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Ratio.denominator.codepreferredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsすべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions両方ではなく、拡張または値[x]が必要です / Must have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRatio.numeratorユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatio分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / 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())

This structure is derived from Ratio

Differential View

This structure is derived from Ratio

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio 0..* Ratio 単位時間内での薬剤の容量
... numerator 0..1 JP_MedicationQuantity 投与量
.... value 1..1 decimal 投与量
.... unit 0..1 string 投与量の単位
... denominator 0..1 Quantity 単位時間
.... value 0..1 decimal 単位時間
.... unit 0..1 string 単位時間の単位
.... system 0..1 uri UCUMを識別するURL
.... code 0..1 code ユニットのコード化された形式 / Coded form of the unit
Binding: UnitsOfTime (preferred)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio 単位時間内での薬剤の容量
rat-1: 分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... numerator C 0..1 JP_MedicationQuantity 投与量
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
.... value Σ 1..1 decimal 投与量
.... comparator ?!Σ 0..1 code < | <= | >= | > - 値の解釈法
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 投与量の単位
.... code Σ 1..1 code 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨
Binding: JP Core Medication MERIT9 Unit ValueSet (preferred)
... denominator Σ 0..1 Quantity 単位時間
.... value Σ 0..1 decimal 単位時間
.... comparator ?!Σ 0..1 code <|<= |> = |> - 価値を理解する方法 / < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 単位時間の単位
.... system ΣC 0..1 uri UCUMを識別するURL
.... code Σ 0..1 code ユニットのコード化された形式 / Coded form of the unit
Binding: UnitsOfTime (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio 単位時間内での薬剤の容量
rat-1: 分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
... numerator C 0..1 JP_MedicationQuantity 投与量
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
.... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal 投与量
.... comparator ?!Σ 0..1 code < | <= | >= | > - 値の解釈法
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 投与量の単位
.... system ΣC 0..1 uri コード化された単位表現を規定するシステム
.... code Σ 1..1 code 単位のコード化された形式、【JP Core仕様】MERIT9医薬品単位略号マスタコードを推奨
Binding: JP Core Medication MERIT9 Unit ValueSet (preferred)
... denominator Σ 0..1 Quantity 単位時間
.... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal 単位時間
.... comparator ?!Σ 0..1 code <|<= |> = |> - 価値を理解する方法 / < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): 量を理解し、表現する方法。 / How the Quantity should be understood and represented.

.... unit Σ 0..1 string 単位時間の単位
.... system ΣC 0..1 uri UCUMを識別するURL
.... code Σ 0..1 code ユニットのコード化された形式 / Coded form of the unit
Binding: UnitsOfTime (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ratio.numerator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Ratio.numerator.codepreferredJP_MedicationUnitMERIT9_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUnitMERIT9_VS
Ratio.denominator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Ratio.denominator.codepreferredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsすべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensions両方ではなく、拡張または値[x]が必要です / Must have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRatio.numeratorユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatio分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / 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())

This structure is derived from Ratio

 

Other representations of profile: CSV, Excel, Schematron

本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けております。