HL7 FHIR JP Core ImplementationGuide
1.1.1 - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). 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.1
Name

JP_MedicationDosageBase

Title

JP Core MedicationDosage Base DataType

Status Active ( 2022-10-24 )
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..*CodingCode 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..1uriIdentity 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..1uriIdentity 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..1SimpleQuantityA 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.30
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.40
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1string投与⽅法のテキスト表現
... doseAndRate Σ0..*Element薬剤の投与量
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConcept力価区分
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (preferred)
.... dose[x] C0..1SimpleQuantityA fixed quantity (no comparator)
.... rate[x] Σ0..1薬剤の投与量速度
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod C0..1JP_MedicationRatio_DosePerPeriod単位時間当たりの投薬量の上限
... maxDosePerAdministration C0..1JP_MedicationSimpleQuantity1回あたりの投薬量の上限
... maxDosePerLifetime C0..1JP_MedicationSimpleQuantity生涯の投薬量の上限

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Dosage.additionalInstructionpreferredJP_MedicationUsageJAMIAdditional_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.22)
Dosage.sitepreferredJP_MedicationBodySiteJAMIExternal_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.32)
Dosage.routepreferredJP_MedicationRouteHL70162_VS (a valid code from http://jpfhir.jp/fhir/core/CodeSystem/route-codes)
Dosage.methodexampleSNOMEDCTAdministrationMethodCodes
Dosage.method.coding:unitDigit1preferredJP_MedicationMethodJAMIBasicUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.30)
Dosage.method.coding:unitDigit2preferredJP_MedicationMethodJAMIDetailUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.40)
Dosage.doseAndRate.typepreferredJP_MedicationIngredientStrengthStrengthType_VS (a valid code from urn:oid:1.2.392.100495.20.2.22)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorDosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetimeIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorDosage.maxDosePerPeriodNumerator 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.maxDosePerLifetimeThe 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..*CodingCode 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..1uriIdentity 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..1uriIdentity 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..1SimpleQuantityA 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.30
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.392.200250.2.2.20.40
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1string投与⽅法のテキスト表現
... doseAndRate Σ0..*Element薬剤の投与量
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConcept力価区分
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (preferred)
.... dose[x] C0..1SimpleQuantityA fixed quantity (no comparator)
.... rate[x] Σ0..1薬剤の投与量速度
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... maxDosePerPeriod C0..1JP_MedicationRatio_DosePerPeriod単位時間当たりの投薬量の上限
... maxDosePerAdministration C0..1JP_MedicationSimpleQuantity1回あたりの投薬量の上限
... maxDosePerLifetime C0..1JP_MedicationSimpleQuantity生涯の投薬量の上限

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Dosage.additionalInstructionpreferredJP_MedicationUsageJAMIAdditional_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.22)
Dosage.sitepreferredJP_MedicationBodySiteJAMIExternal_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.32)
Dosage.routepreferredJP_MedicationRouteHL70162_VS (a valid code from http://jpfhir.jp/fhir/core/CodeSystem/route-codes)
Dosage.methodexampleSNOMEDCTAdministrationMethodCodes
Dosage.method.coding:unitDigit1preferredJP_MedicationMethodJAMIBasicUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.30)
Dosage.method.coding:unitDigit2preferredJP_MedicationMethodJAMIDetailUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.40)
Dosage.doseAndRate.typepreferredJP_MedicationIngredientStrengthStrengthType_VS (a valid code from urn:oid:1.2.392.100495.20.2.22)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorDosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetimeIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorDosage.maxDosePerPeriodNumerator 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.maxDosePerLifetimeThe comparator is not used on a SimpleQuantity
: comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron