MedicationDosage DataType

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 DataType

項目	内容
定義URL	http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationDosage
Version	1.1.2-dev
Name	JP_MedicationDosage
Title	JP Core MedicationDosage DataType
Status	Active ( 2023-10-31 )
Copyright	Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

このデータタイプは内服用法の制約と拡張のうち共通部分を定めている。

Usage:

Use this DataType Constraint: JP Core MedicationDispense Profile and JP Core MedicationRequest Profile

プロファイル詳細

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

Text Summary
Differential Table
Snapshot Table
Terminology Bindings
Constraints
All

This structure is derived from JP_MedicationDosageBase

Summary

Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element Dosage.timing.repeat.bounds[x] is sliced based on the value of type:$this
The element Dosage.doseAndRate.rate[x] is sliced based on the value of type:$this

Name	Card.	Type	Description & Constraints
Dosage		JP_MedicationDosageBase
periodOfUse	0..1	Period	投与期間の開始日を明示するための拡張 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_MedicationDosage_PeriodOfUse
usageDuration	0..1	Duration	実投与日数 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_MedicationDosage_UsageDuration
timing
repeat
Slices for bounds[x]	0..1	Duration, Range, Period	服用・注射開始日から服用・注射終了日までの全日数 Slice: Unordered, Open by type:$this
bounds[x]:boundsDuration	0..1	Duration	服用・注射開始日から服用・注射終了日までの全日数
value	0..1	decimal	投薬日数
unit	0..1	string	投薬日数の単位 Fixed Value: 日
system	0..1	uri	UCUM Fixed Value: http://unitsofmeasure.org
code	0..1	code	投与日数の単位 Fixed Value: d
code	0..1	CodeableConcept	入札\|TID \|QID \|AM \|PM \|QD \|qod \|+ / BID \| TID \| QID \| AM \| PM \| QD \| QOD \| + Binding: JP Core Medication JAMI Usage ValueSet (preferred)
doseAndRate
dose[x]	0..1	JP_MedicationSimpleQuantity	1回投与量
Slices for rate[x]	0..1	Ratio, Range, SimpleQuantity	薬剤の投与量速度 Slice: Unordered, Open by type:$this
rate[x]:rateRatio	0..1	JP_MedicationRatio_DosePerDay	１日当たりでの薬剤の投入量
rate[x]:rateRange	0..1	JP_MedicationRange_UnitOfTime	範囲指定された時間の上限下限
rate[x]:rateQuantity	0..1	SimpleQuantity	投与速度(量/時間)を指定する
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Dosage		0..*	JP_MedicationDosageBase	薬の服用方法・服用した方法、または服用すべき方法
id		0..1	string	要素間参照のための一意のID / Unique id for inter-element referencing
Slices for extension		0..*	Extension	実装で定義された追加のコンテンツ / Additional content defined by implementations Slice: Unordered, Open by value:url
periodOfUse		0..1	Period	投与期間の開始日を明示するための拡張 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_MedicationDosage_PeriodOfUse
usageDuration		0..1	Duration	実投与日数 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_MedicationDosage_UsageDuration
modifierExtension	?!Σ	0..*	Extension	認識されていなくても無視できない拡張機能 / Extensions that cannot be ignored even if unrecognized
sequence	Σ	0..1	integer	服用指示の順番
text	Σ	0..1	string	投与⽅法のテキスト表現
additionalInstruction	Σ	0..*	CodeableConcept	患者に対する補足指示や注意。たとえば、「食事と一緒に」「眠くなることがある」 Binding: JP Core Medication JAMI Additional Usage ValueSet (preferred)
patientInstruction	Σ	0..1	string	患者あるいは消費者向けの指示
timing		0..1	JP_MedicationTiming	投与日時
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
modifierExtension	?!Σ	0..*	Extension	認識されていなくても無視できない拡張機能 / Extensions that cannot be ignored even if unrecognized
event	Σ	0..*	dateTime	服用もしくは注射を行なうタイミングを示す時刻
repeat	ΣC	0..1	Element	イベントが発生する時刻 tim-1: 期間がある場合は、期間単位が必要です / if there's a duration, there needs to be duration units tim-2: 期間がある場合、期間単位が必要です / if there's a period, there needs to be period units tim-4: 期間は非陰性価値です / duration SHALL be a non-negative value tim-5: 期間は非陰性の価値です / period SHALL be a non-negative value tim-6: 期間がある場合、期間がなければなりません / If there's a periodMax, there must be a period tim-7: Hurtermaxがある場合、期間がなければなりません / If there's a durationMax, there must be a duration tim-8: countmaxがある場合、カウントが必要です / If there's a countMax, there must be a count tim-9: オフセットがある場合、c、cm、cd、cvではなく（c、cvではない）存在する必要があります。 / If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: 時間がある場合、いつ、またはその逆もありません / If there's a timeOfDay, there cannot be a when, or vice versa
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
Slices for bounds[x]	Σ	0..1		服用・注射開始日から服用・注射終了日までの全日数 Slice: Unordered, Open by type:$this
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
bounds[x]:boundsDuration	Σ	0..1	Duration	服用・注射開始日から服用・注射終了日までの全日数
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	投薬日数の単位 Fixed Value: 日
system	ΣC	0..1	uri	UCUM Fixed Value: http://unitsofmeasure.org
code	Σ	0..1	code	投与日数の単位 Fixed Value: d
count	Σ	0..1	positiveInt	繰り返し服用もしくは注射回数
countMax	Σ	0..1	positiveInt	繰り返しの最大回数
duration	Σ	0..1	decimal	継続時間
durationMax	Σ	0..1	decimal	継続時間(最大値)
durationUnit	Σ	0..1	code	s \|min \|h \|d \|wk \|mo \|A-時間単位（ucum） / s \| min \| h \| d \| wk \| mo \| a - unit of time (UCUM) Binding: UnitsOfTime (required): 時間単位（UCUMからの単位）。 / A unit of time (units from UCUM).
frequency	Σ	0..1	positiveInt	期間内にイベントが発生する回数、頻度
frequencyMax	Σ	0..1	positiveInt	期間内にイベントが発生する最大回数、最大頻度
period	Σ	0..1	decimal	イベントが発生する頻度に対応する期間
periodMax	Σ	0..1	decimal	期間の上限（3-4時間）
periodUnit	Σ	0..1	code	s \|min \|h \|d \|wk \|mo \|A-時間単位（ucum） / s \| min \| h \| d \| wk \| mo \| a - unit of time (UCUM) Binding: UnitsOfTime (required): 時間単位（UCUMからの単位）。 / A unit of time (units from UCUM).
dayOfWeek	Σ	0..*	code	月\|火\|水\|木\|金\|土\|太陽 / mon \| tue \| wed \| thu \| fri \| sat \| sun Binding: DaysOfWeek (required)
timeOfDay	Σ	0..*	time	一日の間で投与される時刻
when	Σ	0..*	code	投薬期間についてのコード Binding: EventTiming (required): スケジュールに関連する現実世界のイベント。 / Real world event relating to the schedule.
offset	Σ	0..1	unsignedInt	イベントからの時間(分、前後）
code	Σ	0..1	CodeableConcept	入札\|TID \|QID \|AM \|PM \|QD \|qod \|+ / BID \| TID \| QID \| AM \| PM \| QD \| QOD \| + Binding: JP Core Medication JAMI Usage ValueSet (preferred)
asNeeded[x]	Σ	0..1	boolean	「頓用」指示
site	Σ	0..1	CodeableConcept	投与される身体部位 Binding: JP Core Medication JAMI External Body Site ValueSet (preferred)
route	Σ	0..1	CodeableConcept	投与経路 Binding: JP Core Medication HL70162-based Route ValueSet (preferred)
method	Σ	0..1	CodeableConcept	投与方法 Binding: SNOMEDCTAdministrationMethodCodes (example): 薬が投与される手法を説明するコード化された概念。 / A coded concept describing the technique by which the medicine is administered.
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
Slices for coding	Σ	0..*	Coding	用語システムによって定義されたコード / Code defined by a terminology system Slice: Unordered, Open by value:system
coding:unitDigit1	Σ	0..1	Coding	投与⽅法に対応するJAMI 用法コード表基本用法１桁コード Binding: JP Core Medication JAMI Basic Usage Type ValueSet (preferred)
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
system	Σ	1..1	uri	用語システムのアイデンティティ / Identity of the terminology system Fixed Value: urn:oid:1.2.392.200250.2.2.20.30
version	Σ	0..1	string	システムのバージョン - 関連する場合 / Version of the system - if relevant
code	Σ	0..1	code	システムによって定義された構文のシンボル / Symbol in syntax defined by the system
display	Σ	0..1	string	システムによって定義された表現 / Representation defined by the system
userSelected	Σ	0..1	boolean	このコーディングがユーザーによって直接選択された場合 / If this coding was chosen directly by the user
coding:unitDigit2	Σ	0..1	Coding	投与⽅法に対応するJAMI 用法コード表基本用法2桁コード Binding: JP Core Medication JAMI Detail Usage ValueSet (preferred)
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
system	Σ	1..1	uri	用語システムのアイデンティティ / Identity of the terminology system Fixed Value: urn:oid:1.2.392.200250.2.2.20.40
version	Σ	0..1	string	システムのバージョン - 関連する場合 / Version of the system - if relevant
code	Σ	0..1	code	システムによって定義された構文のシンボル / Symbol in syntax defined by the system
display	Σ	0..1	string	システムによって定義された表現 / Representation defined by the system
userSelected	Σ	0..1	boolean	このコーディングがユーザーによって直接選択された場合 / If this coding was chosen directly by the user
text	Σ	0..1	string	投与⽅法のテキスト表現
doseAndRate	Σ	0..*	Element	薬剤の投与量
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
type	Σ	0..1	CodeableConcept	力価区分 Binding: JP Core Medication IngredientStrength StrengthType ValueSet (preferred)
dose[x]	C	0..1	JP_MedicationSimpleQuantity	1回投与量 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
Slices for rate[x]	Σ	0..1		薬剤の投与量速度 Slice: Unordered, Closed by type:$this
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
rate[x]:rateRatio	C	0..1	JP_MedicationRatio_DosePerDay	１日当たりでの薬剤の投入量 rat-1: 分子と分母の両方が存在するか、両方が存在します。両方が欠席している場合、いくつかの拡張が存在するものとします / Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
rate[x]:rateRange	C	0..1	JP_MedicationRange_UnitOfTime	範囲指定された時間の上限下限 rng-2: 存在する場合、低い値は高よりも低い値を持つものとします / If present, low SHALL have a lower value than high
rate[x]:rateQuantity	C	0..1	SimpleQuantity	投与速度(量/時間)を指定する 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
maxDosePerPeriod	C	0..1	JP_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	C	0..1	JP_MedicationSimpleQuantity	1回あたりの投薬量の上限 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	C	0..1	JP_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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Dosage.additionalInstruction	preferred	JP_MedicationUsageJAMIAdditional_VS `http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUsageJAMIAdditional_VS`
Dosage.timing.repeat.bounds[x]:boundsDuration.comparator	required	QuantityComparator `http://hl7.org/fhir/ValueSet/quantity-comparator\|4.0.1` from the FHIR Standard
Dosage.timing.repeat.durationUnit	required	UnitsOfTime `http://hl7.org/fhir/ValueSet/units-of-time\|4.0.1` from the FHIR Standard
Dosage.timing.repeat.periodUnit	required	UnitsOfTime `http://hl7.org/fhir/ValueSet/units-of-time\|4.0.1` from the FHIR Standard
Dosage.timing.repeat.dayOfWeek	required	DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week\|4.0.1` from the FHIR Standard
Dosage.timing.repeat.when	required	EventTiming `http://hl7.org/fhir/ValueSet/event-timing\|4.0.1` from the FHIR Standard
Dosage.timing.code	preferred	JP_MedicationUsageJAMI_VS `http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationUsageJAMI_VS`
Dosage.site	preferred	JP_MedicationBodySiteJAMIExternal_VS `http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationBodySiteJAMIExternal_VS`
Dosage.route	preferred	JP_MedicationRouteHL70162_VS `http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationRouteHL70162_VS`
Dosage.method	example	SNOMEDCTAdministrationMethodCodes `http://hl7.org/fhir/ValueSet/administration-method-codes` from the FHIR Standard
Dosage.method.coding:unitDigit1	preferred	JP_MedicationMethodJAMIBasicUsage_VS `http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationMethodJAMIBasicUsage_VS`
Dosage.method.coding:unitDigit2	preferred	JP_MedicationMethodJAMIDetailUsage_VS `http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationMethodJAMIDetailUsage_VS`
Dosage.doseAndRate.type	preferred	JP_MedicationIngredientStrengthStrengthType_VS `http://jpfhir.jp/fhir/core/ValueSet/JP_MedicationIngredientStrengthStrengthType_VS`

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	すべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	両方ではなく、拡張または値[x]が必要です / Must have either extensions or value[x], not both : extension.exists() != value.exists()
qty-3	error	Dosage.doseAndRate.dose[x], Dosage.doseAndRate.rate[x]:rateQuantity, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime	ユニットのコードが存在する場合、システムも存在するものとします / If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists()
rat-1	error	Dosage.doseAndRate.rate[x]:rateRatio, Dosage.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())
rng-2	error	Dosage.doseAndRate.rate[x]:rateRange	存在する場合、低い値は高よりも低い値を持つものとします / If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high)
sqty-1	error	Dosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime	コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity : comparator.empty()
sqty-1	error	Dosage.doseAndRate.rate[x]:rateQuantity	コンパレータは、単純なQuantityで使用されません / The comparator is not used on a SimpleQuantity : comparator.empty()
tim-1	error	Dosage.timing.repeat	期間がある場合は、期間単位が必要です / if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	Dosage.timing.repeat	期間がある場合、期間単位が必要です / if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	Dosage.timing.repeat	期間は非陰性価値です / duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	Dosage.timing.repeat	期間は非陰性の価値です / period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	Dosage.timing.repeat	期間がある場合、期間がなければなりません / If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	Dosage.timing.repeat	Hurtermaxがある場合、期間がなければなりません / If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	Dosage.timing.repeat	countmaxがある場合、カウントが必要です / If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	Dosage.timing.repeat	オフセットがある場合、c、cm、cd、cvではなく（c、cvではない）存在する必要があります。 / If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' \| 'CM' \| 'CD' \| 'CV')).not()))
tim-10	error	Dosage.timing.repeat	時間がある場合、いつ、またはその逆もありません / If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()