Medication Timing DataType

HL7 FHIR JP Core ImplementationGuide
1.1.1 - release Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). See the Directory of published versions

Data Type Profile: JP Core Medication Timing DataType

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

このデータタイプはTiming DataTypeに対して、薬剤に関するタイミング定義を行なったものである

Usage:

Use this DataType Constraint: JP Core MedicationDosage Injection DataType, JP Core MedicationDosage DataType, JP Core MedicationDosage Base DataType

プロファイル詳細

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

Name	Card.	Type	Description & Constraints
Timing	0..*	Timing	投与日時
event	0..*	dateTime	服用もしくは注射を行なうタイミングを示す時刻
repeat	0..1	Element	イベントが発生する時刻
bounds[x]	0..1	Duration, Range, Period	服用・注射開始日から服用・注射終了日までの全日数
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 - unit of time (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 - unit of time (UCUM)
dayOfWeek	0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun
timeOfDay	0..*	time	一日の間で投与される時刻
when	0..*	code	投薬期間についてのコード
offset	0..1	unsignedInt	イベントからの時間(分、前後）
code	0..1	CodeableConcept	BID \| TID \| QID \| AM \| PM \| QD \| QOD \| +
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Timing		0..*	Timing	投与日時
id		0..1	string	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	イベントが発生する時刻
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
bounds[x]	Σ	0..1		服用・注射開始日から服用・注射終了日までの全日数
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
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 - unit of time (UCUM) Binding: UnitsOfTime (required): 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 - unit of time (UCUM) Binding: UnitsOfTime (required): 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	BID \| TID \| QID \| AM \| PM \| QD \| QOD \| + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
tim-1	error	Timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	Timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	Timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	Timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	Timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	Timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	Timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	Timing.repeat	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	Timing.repeat	If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()

This structure is derived from Timing

Summary

Differential View

Name	Card.	Type	Description & Constraints
Timing	0..*	Timing	投与日時
event	0..*	dateTime	服用もしくは注射を行なうタイミングを示す時刻
repeat	0..1	Element	イベントが発生する時刻
bounds[x]	0..1	Duration, Range, Period	服用・注射開始日から服用・注射終了日までの全日数
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 - unit of time (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 - unit of time (UCUM)
dayOfWeek	0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun
timeOfDay	0..*	time	一日の間で投与される時刻
when	0..*	code	投薬期間についてのコード
offset	0..1	unsignedInt	イベントからの時間(分、前後）
code	0..1	CodeableConcept	BID \| TID \| QID \| AM \| PM \| QD \| QOD \| +
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Timing		0..*	Timing	投与日時
id		0..1	string	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	イベントが発生する時刻
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
bounds[x]	Σ	0..1		服用・注射開始日から服用・注射終了日までの全日数
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
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 - unit of time (UCUM) Binding: UnitsOfTime (required): 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 - unit of time (UCUM) Binding: UnitsOfTime (required): 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	BID \| TID \| QID \| AM \| PM \| QD \| QOD \| + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Timing.repeat.durationUnit	required	UnitsOfTime
Timing.repeat.periodUnit	required	UnitsOfTime
Timing.repeat.dayOfWeek	required	DaysOfWeek
Timing.repeat.when	required	EventTiming
Timing.code	preferred	TimingAbbreviation

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
tim-1	error	Timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	Timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	Timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	Timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	Timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	Timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	Timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	Timing.repeat	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	Timing.repeat	If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()

Other representations of profile: CSV, Excel, Schematron

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