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

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

Data Type Profile: JP Core Medication Timing DataType

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

JP_MedicationTiming

Title

JP Core Medication Timing DataType

Status Active ( 2023-10-31 )
Copyright

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

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

Usage:

プロファイル詳細

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

This structure is derived from Timing

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 | +

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing 0..* Timing 投与日時
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... event Σ 0..* dateTime 服用もしくは注射を行なうタイミングを示す時刻
ele-1: All FHIR elements must have a @value or children
... repeat ΣC 0..1 Element イベントが発生する時刻
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
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: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: 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
.... bounds[x] Σ 0..1 服用・注射開始日から服用・注射終了日までの全日数
ele-1: All FHIR elements must have a @value or children
..... boundsDuration Duration
..... boundsRange Range
..... boundsPeriod Period
.... count Σ 0..1 positiveInt 繰り返し服用もしくは注射回数
ele-1: All FHIR elements must have a @value or children
.... countMax Σ 0..1 positiveInt 繰り返しの最大回数
ele-1: All FHIR elements must have a @value or children
.... duration Σ 0..1 decimal 継続時間
ele-1: All FHIR elements must have a @value or children
.... durationMax Σ 0..1 decimal 継続時間(最大値)
ele-1: All FHIR elements must have a @value or children
.... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
ele-1: All FHIR elements must have a @value or children
.... frequency Σ 0..1 positiveInt 期間内にイベントが発生する回数、頻度
ele-1: All FHIR elements must have a @value or children
.... frequencyMax Σ 0..1 positiveInt 期間内にイベントが発生する最大回数、最大頻度
ele-1: All FHIR elements must have a @value or children
.... period Σ 0..1 decimal イベントが発生する頻度に対応する期間
ele-1: All FHIR elements must have a @value or children
.... periodMax Σ 0..1 decimal 期間の上限(3-4時間)
ele-1: All FHIR elements must have a @value or children
.... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
ele-1: All FHIR elements must have a @value or children
.... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
ele-1: All FHIR elements must have a @value or children
.... timeOfDay Σ 0..* time 一日の間で投与される時刻
ele-1: All FHIR elements must have a @value or children
.... when Σ 0..* code 投薬期間についてのコード
Binding: EventTiming (required)
ele-1: All FHIR elements must have a @value or children
.... offset Σ 0..1 unsignedInt イベントからの時間(分、前後)
ele-1: All FHIR elements must have a @value or children
... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing 0..* Timing 投与日時
... id 0..1 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: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: 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 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)
.... 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)
.... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... timeOfDay Σ 0..* time 一日の間で投与される時刻
.... when Σ 0..* code 投薬期間についてのコード
Binding: EventTiming (required)
.... offset Σ 0..1 unsignedInt イベントからの時間(分、前後)
... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.3.0
from the FHIR Standard
Timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.3.0
from the FHIR Standard
Timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.3.0
from the FHIR Standard
Timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.3.0
from the FHIR Standard
Timing.codepreferredTimingAbbreviation
http://hl7.org/fhir/ValueSet/timing-abbreviation
from the FHIR Standard

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()
tim-1errorTiming.repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorTiming.repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorTiming.repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorTiming.repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorTiming.repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorTiming.repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorTiming.repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorTiming.repeatIf 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-10errorTiming.repeatIf 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

This structure is derived from Timing

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 | +

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing 0..* Timing 投与日時
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... event Σ 0..* dateTime 服用もしくは注射を行なうタイミングを示す時刻
ele-1: All FHIR elements must have a @value or children
... repeat ΣC 0..1 Element イベントが発生する時刻
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
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: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: 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
.... bounds[x] Σ 0..1 服用・注射開始日から服用・注射終了日までの全日数
ele-1: All FHIR elements must have a @value or children
..... boundsDuration Duration
..... boundsRange Range
..... boundsPeriod Period
.... count Σ 0..1 positiveInt 繰り返し服用もしくは注射回数
ele-1: All FHIR elements must have a @value or children
.... countMax Σ 0..1 positiveInt 繰り返しの最大回数
ele-1: All FHIR elements must have a @value or children
.... duration Σ 0..1 decimal 継続時間
ele-1: All FHIR elements must have a @value or children
.... durationMax Σ 0..1 decimal 継続時間(最大値)
ele-1: All FHIR elements must have a @value or children
.... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
ele-1: All FHIR elements must have a @value or children
.... frequency Σ 0..1 positiveInt 期間内にイベントが発生する回数、頻度
ele-1: All FHIR elements must have a @value or children
.... frequencyMax Σ 0..1 positiveInt 期間内にイベントが発生する最大回数、最大頻度
ele-1: All FHIR elements must have a @value or children
.... period Σ 0..1 decimal イベントが発生する頻度に対応する期間
ele-1: All FHIR elements must have a @value or children
.... periodMax Σ 0..1 decimal 期間の上限(3-4時間)
ele-1: All FHIR elements must have a @value or children
.... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
ele-1: All FHIR elements must have a @value or children
.... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
ele-1: All FHIR elements must have a @value or children
.... timeOfDay Σ 0..* time 一日の間で投与される時刻
ele-1: All FHIR elements must have a @value or children
.... when Σ 0..* code 投薬期間についてのコード
Binding: EventTiming (required)
ele-1: All FHIR elements must have a @value or children
.... offset Σ 0..1 unsignedInt イベントからの時間(分、前後)
ele-1: All FHIR elements must have a @value or children
... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing 0..* Timing 投与日時
... id 0..1 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: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: 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 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)
.... 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)
.... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... timeOfDay Σ 0..* time 一日の間で投与される時刻
.... when Σ 0..* code 投薬期間についてのコード
Binding: EventTiming (required)
.... offset Σ 0..1 unsignedInt イベントからの時間(分、前後)
... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.3.0
from the FHIR Standard
Timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.3.0
from the FHIR Standard
Timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.3.0
from the FHIR Standard
Timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.3.0
from the FHIR Standard
Timing.codepreferredTimingAbbreviation
http://hl7.org/fhir/ValueSet/timing-abbreviation
from the FHIR Standard

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()
tim-1errorTiming.repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorTiming.repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorTiming.repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorTiming.repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorTiming.repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorTiming.repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorTiming.repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorTiming.repeatIf 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-10errorTiming.repeatIf there's a timeOfDay, there cannot be a when, or vice versa
: timeOfDay.empty() or when.empty()

This structure is derived from Timing

Summary

 

Other representations of profile: CSV, Excel, Schematron

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