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

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

Data Type Profile: JP Core MedicationDosage Base DataType

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

JP_MedicationDosageBase

Title

JP Core MedicationDosage Base DataType

Status Active ( 2023-10-31 )
Copyright

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

このデータタイプは薬剤用法のDosageベースとして基礎となる制約と拡張のうち共通部分を定めている。


Usage:

プロファイル詳細

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

This structure is derived from Dosage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage薬の服用方法・服用した方法、または服用すべき方法
... sequence 0..1integer服用指示の順番
... text 0..1string投与⽅法のテキスト表現
... additionalInstruction 0..*CodeableConcept患者に対する補足指示や注意。たとえば、「食事と一緒に」「眠くなることがある」
Binding: JP Core Medication JAMI Additional Usage ValueSet (preferred)
... patientInstruction 0..1string患者あるいは消費者向けの指示
... timing 0..1JP_MedicationTiming投与日時
... asNeeded[x] 0..1boolean「頓用」指示
... site 0..1CodeableConcept投与される身体部位
Binding: JP Core Medication JAMI External Body Site ValueSet (preferred)
... route 0..1CodeableConcept投与経路
Binding: JP Core Medication HL70162-based Route ValueSet (preferred)
... method 0..1CodeableConcept投与方法
.... Slices for coding 0..*Coding用語システムによって定義されたコード / Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:unitDigit1 0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法1桁コード
Binding: JP Core Medication JAMI Basic Usage Type ValueSet (preferred)
...... system 1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.30
..... coding:unitDigit2 0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法2桁コード
Binding: JP Core Medication JAMI Detail Usage ValueSet (preferred)
...... system 1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.40
.... text 0..1string投与⽅法のテキスト表現
... doseAndRate 0..*Element薬剤の投与量
.... type 0..1CodeableConcept力価区分
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (preferred)
.... dose[x] 0..1SimpleQuantity固定数量(コンパレータなし) / A fixed quantity (no comparator)
.... rate[x] 0..1Ratio, Range, SimpleQuantity薬剤の投与量速度
... maxDosePerPeriod 0..1JP_MedicationRatio_DosePerPeriod単位時間当たりの投薬量の上限
... maxDosePerAdministration 0..1JP_MedicationSimpleQuantity1回あたりの投薬量の上限
... maxDosePerLifetime 0..1JP_MedicationSimpleQuantity生涯の投薬量の上限

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage薬の服用方法・服用した方法、または服用すべき方法
... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*Extension認識されていなくても無視できない拡張機能 / Extensions that cannot be ignored even if unrecognized
... sequence Σ0..1integer服用指示の順番
... text Σ0..1string投与⽅法のテキスト表現
... additionalInstruction Σ0..*CodeableConcept患者に対する補足指示や注意。たとえば、「食事と一緒に」「眠くなることがある」
Binding: JP Core Medication JAMI Additional Usage ValueSet (preferred)
... patientInstruction Σ0..1string患者あるいは消費者向けの指示
... timing 0..1JP_MedicationTiming投与日時
... asNeeded[x] Σ0..1boolean「頓用」指示
... site Σ0..1CodeableConcept投与される身体部位
Binding: JP Core Medication JAMI External Body Site ValueSet (preferred)
... route Σ0..1CodeableConcept投与経路
Binding: JP Core Medication HL70162-based Route ValueSet (preferred)
... method Σ0..1CodeableConcept投与方法
Binding: SNOMEDCTAdministrationMethodCodes (example): 薬が投与される手法を説明するコード化された概念。 / A coded concept describing the technique by which the medicine is administered.

.... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*Coding用語システムによって定義されたコード / Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:unitDigit1 Σ0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法1桁コード
Binding: JP Core Medication JAMI Basic Usage Type ValueSet (preferred)
...... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
...... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.30
...... version Σ0..1stringシステムのバージョン - 関連する場合 / Version of the system - if relevant
...... code Σ0..1codeシステムによって定義された構文のシンボル / Symbol in syntax defined by the system
...... display Σ0..1stringシステムによって定義された表現 / Representation defined by the system
...... userSelected Σ0..1booleanこのコーディングがユーザーによって直接選択された場合 / If this coding was chosen directly by the user
..... coding:unitDigit2 Σ0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法2桁コード
Binding: JP Core Medication JAMI Detail Usage ValueSet (preferred)
...... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
...... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.40
...... version Σ0..1stringシステムのバージョン - 関連する場合 / Version of the system - if relevant
...... code Σ0..1codeシステムによって定義された構文のシンボル / Symbol in syntax defined by the system
...... display Σ0..1stringシステムによって定義された表現 / Representation defined by the system
...... userSelected Σ0..1booleanこのコーディングがユーザーによって直接選択された場合 / If this coding was chosen directly by the user
.... text Σ0..1string投与⽅法のテキスト表現
... doseAndRate Σ0..*Element薬剤の投与量
.... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConcept力価区分
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (preferred)
.... dose[x] C0..1SimpleQuantity固定数量(コンパレータなし) / A fixed quantity (no comparator)
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
sqty-1: コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity
.... rate[x] Σ0..1薬剤の投与量速度
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod C0..1JP_MedicationRatio_DosePerPeriod単位時間当たりの投薬量の上限
rat-1: 分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... maxDosePerAdministration C0..1JP_MedicationSimpleQuantity1回あたりの投薬量の上限
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
sqty-1: コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity
... maxDosePerLifetime C0..1JP_MedicationSimpleQuantity生涯の投薬量の上限
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
sqty-1: コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.additionalInstructionpreferredJP_MedicationUsageJAMIAdditional_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUsageJAMIAdditional_VS
Dosage.sitepreferredJP_MedicationBodySiteJAMIExternal_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationBodySiteJAMIExternal_VS
Dosage.routepreferredJP_MedicationRouteHL70162_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationRouteHL70162_VS
Dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
Dosage.method.coding:unitDigit1preferredJP_MedicationMethodJAMIBasicUsage_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationMethodJAMIBasicUsage_VS
Dosage.method.coding:unitDigit2preferredJP_MedicationMethodJAMIDetailUsage_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationMethodJAMIDetailUsage_VS
Dosage.doseAndRate.typepreferredJP_MedicationIngredientStrengthStrengthType_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationIngredientStrengthStrengthType_VS

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-3errorDosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetimeユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorDosage.maxDosePerPeriod分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / 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())
sqty-1errorDosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetimeコンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from Dosage

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage薬の服用方法・服用した方法、または服用すべき方法
... sequence 0..1integer服用指示の順番
... text 0..1string投与⽅法のテキスト表現
... additionalInstruction 0..*CodeableConcept患者に対する補足指示や注意。たとえば、「食事と一緒に」「眠くなることがある」
Binding: JP Core Medication JAMI Additional Usage ValueSet (preferred)
... patientInstruction 0..1string患者あるいは消費者向けの指示
... timing 0..1JP_MedicationTiming投与日時
... asNeeded[x] 0..1boolean「頓用」指示
... site 0..1CodeableConcept投与される身体部位
Binding: JP Core Medication JAMI External Body Site ValueSet (preferred)
... route 0..1CodeableConcept投与経路
Binding: JP Core Medication HL70162-based Route ValueSet (preferred)
... method 0..1CodeableConcept投与方法
.... Slices for coding 0..*Coding用語システムによって定義されたコード / Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:unitDigit1 0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法1桁コード
Binding: JP Core Medication JAMI Basic Usage Type ValueSet (preferred)
...... system 1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.30
..... coding:unitDigit2 0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法2桁コード
Binding: JP Core Medication JAMI Detail Usage ValueSet (preferred)
...... system 1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.40
.... text 0..1string投与⽅法のテキスト表現
... doseAndRate 0..*Element薬剤の投与量
.... type 0..1CodeableConcept力価区分
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (preferred)
.... dose[x] 0..1SimpleQuantity固定数量(コンパレータなし) / A fixed quantity (no comparator)
.... rate[x] 0..1Ratio, Range, SimpleQuantity薬剤の投与量速度
... maxDosePerPeriod 0..1JP_MedicationRatio_DosePerPeriod単位時間当たりの投薬量の上限
... maxDosePerAdministration 0..1JP_MedicationSimpleQuantity1回あたりの投薬量の上限
... maxDosePerLifetime 0..1JP_MedicationSimpleQuantity生涯の投薬量の上限

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage薬の服用方法・服用した方法、または服用すべき方法
... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*Extension認識されていなくても無視できない拡張機能 / Extensions that cannot be ignored even if unrecognized
... sequence Σ0..1integer服用指示の順番
... text Σ0..1string投与⽅法のテキスト表現
... additionalInstruction Σ0..*CodeableConcept患者に対する補足指示や注意。たとえば、「食事と一緒に」「眠くなることがある」
Binding: JP Core Medication JAMI Additional Usage ValueSet (preferred)
... patientInstruction Σ0..1string患者あるいは消費者向けの指示
... timing 0..1JP_MedicationTiming投与日時
... asNeeded[x] Σ0..1boolean「頓用」指示
... site Σ0..1CodeableConcept投与される身体部位
Binding: JP Core Medication JAMI External Body Site ValueSet (preferred)
... route Σ0..1CodeableConcept投与経路
Binding: JP Core Medication HL70162-based Route ValueSet (preferred)
... method Σ0..1CodeableConcept投与方法
Binding: SNOMEDCTAdministrationMethodCodes (example): 薬が投与される手法を説明するコード化された概念。 / A coded concept describing the technique by which the medicine is administered.

.... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*Coding用語システムによって定義されたコード / Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:unitDigit1 Σ0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法1桁コード
Binding: JP Core Medication JAMI Basic Usage Type ValueSet (preferred)
...... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
...... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.30
...... version Σ0..1stringシステムのバージョン - 関連する場合 / Version of the system - if relevant
...... code Σ0..1codeシステムによって定義された構文のシンボル / Symbol in syntax defined by the system
...... display Σ0..1stringシステムによって定義された表現 / Representation defined by the system
...... userSelected Σ0..1booleanこのコーディングがユーザーによって直接選択された場合 / If this coding was chosen directly by the user
..... coding:unitDigit2 Σ0..1Coding投与⽅法に対応するJAMI 用法コード表基本用法2桁コード
Binding: JP Core Medication JAMI Detail Usage ValueSet (preferred)
...... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
...... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uri用語システムのアイデンティティ / Identity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.40
...... version Σ0..1stringシステムのバージョン - 関連する場合 / Version of the system - if relevant
...... code Σ0..1codeシステムによって定義された構文のシンボル / Symbol in syntax defined by the system
...... display Σ0..1stringシステムによって定義された表現 / Representation defined by the system
...... userSelected Σ0..1booleanこのコーディングがユーザーによって直接選択された場合 / If this coding was chosen directly by the user
.... text Σ0..1string投与⽅法のテキスト表現
... doseAndRate Σ0..*Element薬剤の投与量
.... id 0..1string要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..*Extension実装で定義された追加のコンテンツ / Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConcept力価区分
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (preferred)
.... dose[x] C0..1SimpleQuantity固定数量(コンパレータなし) / A fixed quantity (no comparator)
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
sqty-1: コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity
.... rate[x] Σ0..1薬剤の投与量速度
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod C0..1JP_MedicationRatio_DosePerPeriod単位時間当たりの投薬量の上限
rat-1: 分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... maxDosePerAdministration C0..1JP_MedicationSimpleQuantity1回あたりの投薬量の上限
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
sqty-1: コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity
... maxDosePerLifetime C0..1JP_MedicationSimpleQuantity生涯の投薬量の上限
qty-3: ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
sqty-1: コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Dosage.additionalInstructionpreferredJP_MedicationUsageJAMIAdditional_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUsageJAMIAdditional_VS
Dosage.sitepreferredJP_MedicationBodySiteJAMIExternal_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationBodySiteJAMIExternal_VS
Dosage.routepreferredJP_MedicationRouteHL70162_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationRouteHL70162_VS
Dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
Dosage.method.coding:unitDigit1preferredJP_MedicationMethodJAMIBasicUsage_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationMethodJAMIBasicUsage_VS
Dosage.method.coding:unitDigit2preferredJP_MedicationMethodJAMIDetailUsage_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationMethodJAMIDetailUsage_VS
Dosage.doseAndRate.typepreferredJP_MedicationIngredientStrengthStrengthType_VS
http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationIngredientStrengthStrengthType_VS

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-3errorDosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetimeユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorDosage.maxDosePerPeriod分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / 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())
sqty-1errorDosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetimeコンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity
: comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron