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_MedicationTiming - Detailed Descriptions

Active as of 2022-10-24

Definitions for the jp-medicationtiming data type profile.

1. Timing
Definition

投与日時

Control0..*
Comments

Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events.

A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.

2. Timing.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Timing.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Timing.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Timing.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser contentmodifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Timing.event
Definition

服用タイミングを具体的な日時で指定する場合に使用する

Control0..*
TypedateTime
Requirements

In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Timing.repeat
Definition

イベントがスケジュールされたルールについての記述。

Control0..1
TypeElement
Requirements

スケジュールされたタイミングの多くは規則的な繰り返しで決定されている。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
tim-1: if there's a duration, there needs to be duration units (: duration.empty() or durationUnit.exists())
tim-2: if there's a period, there needs to be period units (: period.empty() or periodUnit.exists())
tim-4: duration SHALL be a non-negative value (: duration.exists() implies duration >= 0)
tim-5: period SHALL be a non-negative value (: period.exists() implies period >= 0)
tim-6: If there's a periodMax, there must be a period (: periodMax.empty() or period.exists())
tim-7: If there's a durationMax, there must be a duration (: durationMax.empty() or duration.exists())
tim-8: If there's a countMax, there must be a count (: countMax.empty() or count.exists())
tim-9: 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: If there's a timeOfDay, there cannot be a when, or vice versa (: timeOfDay.empty() or when.empty())
7. Timing.repeat.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
8. Timing.repeat.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Timing.repeat.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Timing.repeat.bounds[x]
Definition

服用・注射開始日から服用・注射終了日までの全日数。実投与日数ではないことに注意する。

Control0..1
TypeChoice of: Duration, Range, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Timing.repeat.count
Definition

Timing仕様の全てにおいて、特定の期間に繰り返されるように指定された総回数。もし、countMaxが設定されていれば、このエレメントは許容される最低限度の回数を示す。

Control0..1
TypepositiveInt
Requirements

Repetitions may be limited by end time or total occurrences.

Comments

回数に上限、下限の範囲がある場合は、このcountで示される回数が起きるまでは、エレメントは範囲の中にあると解釈されるべきである。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Timing.repeat.countMax
Definition

このエレメントが設定されている場合は、回数に範囲があることを示している。したがって、[count]から[countmax]までの回数で繰り返される。

Control0..1
TypepositiveInt
Comments

32bit整数。もし、値がこれを超える場合はdecimalで記録される。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Timing.repeat.duration
Definition

投与されるタイミングが発生している時間。もし、durationMaxが設定されていれば、このエレメントは許容される継続時間の下限を示す。

Control0..1
Typedecimal
Requirements

アクティビティによっては即時的なものではなく、その期間において維持される必要がある。

Comments

継続時間はイベントの定義の一部(たとえば、静脈注射(IV)では特定の量と速度が明示される)として示されることがある。その他、Timing仕様の一部(たとえば、運動)として示されることもある。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Timing.repeat.durationMax
Definition

もし、このエレメントに値が設定されていれば、durationには範囲があることを示している。したがって、[duration]から[durationMax]までの継続時間の範囲で投与される。

Control0..1
Typedecimal
Requirements

アクティビティによっては即時的なものではなく、その期間において維持される必要がある。

Comments

継続時間はイベントの定義の一部(たとえば、静脈注射(IV)では特定の量と速度が明示される)として示されることがある。その他、Timing仕様の一部(たとえば、運動)として示されることもある。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Timing.repeat.durationUnit
Definition

UCUM単位で表される継続時間についての単位。

Control0..1
BindingThe codes SHALL be taken from UnitsOfTime A unit of time (units from UCUM)
Typecode
Comments

FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Timing.repeat.frequency
Definition

特定の期間に繰り返して発生した行為の回数。もし、frequencyMaxが設定されていれば、このエレメントはfrequencyとして認められた下限を示す。

Control0..1
TypepositiveInt
Comments

32ビットの数値。もし、値がそれを上回るようであればdecimalを使用する。

Meaning if MissingIf no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Timing.repeat.frequencyMax
Definition

このエレメントに値が設定されていれば、frequencyには範囲が指定されている。つまり、期間あるいは期間の範囲内に[frequency]から[frequencyMax]回繰り返されることを示している。

Control0..1
TypepositiveInt
Comments

32ビットの数値。もし、値がそれを上回るようであればdecimalを使用する。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Timing.repeat.period
Definition

繰り返し投与が行われる期間を示す。たとえば、「1日3回」であれば、3は繰り返しの頻度(frequency)であり、「1日」が期間(period)である。もし、periodMaxに値が設定されていれば、このエレメントは期間として認められた範囲の下限を示す。

Control0..1
Typedecimal
Comments

IEEEの浮動小数点型を使わずに、小数点も含むdecimal型のようなものを利用すること(たとえばJavaのBigInteger)。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Timing.repeat.periodMax
Definition

もし、この値が設定されていれば、期間は[period]から[periodMax]までであることを示し、「3-5日に1回投与」のような表現が認められる。

Control0..1
Typedecimal
Comments

IEEEの浮動小数点型を使わずに、小数点の制度も示すdecimal型のようなものを利用すること(たとえばJavaのBigInteger)。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Timing.repeat.periodUnit
Definition

期間を表すUCUM単位。

Control0..1
BindingThe codes SHALL be taken from UnitsOfTime A unit of time (units from UCUM)
Typecode
Comments

FHIRの文字列は1MB以上の大きさとなってなはらない(SHALL NOT)。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Timing.repeat.dayOfWeek
Definition

期間として1週間以上が指定されていれば、指定された曜日のみで投与が行われる。

Control0..*
BindingThe codes SHALL be taken from DaysOfWeek
Typecode
Comments

曜日が指定されていなければ、他に指定された日には毎日投与されると想定される。frequencyとperiodエレメントはdayOfWeekと同じように使うことはできない。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Timing.repeat.timeOfDay
Definition

一日の間で指定された投与される時刻。

Control0..*
Typetime
Comments

もし、このtimeOfDayに値が指定されていれば、毎日(daysOfWeekでフィルタされた曜日の)指定された時刻に投与されると推定される。whenやfrequency, periodエレメントはtimeOfDayとは同様に使うことはできない。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Timing.repeat.when
Definition

一日の間のおおよその時間帯で投与すべきタイミングを示す。日常のイベントに関連付けられていることもある。

Control0..*
BindingThe codes SHALL be taken from EventTiming Real world event relating to the schedule
Typecode
Requirements

タイミングはしばしば起床や食事、睡眠などのできごとによってしばしば決定されている。

Comments

一つ以上のイベントが記載されている場合、そのイベントは特定のイベントの組み合わせと結びついている。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Timing.repeat.offset
Definition

イベントからの時間(分)。もし、分で示される時間がイベントのコードが前か後かを示していない場合、offsetはイベントの後であることが想定される。

Control0..1
TypeunsignedInt
Comments

32ビットの数値。もし、値がそれを上回るようであればdecimalを使用する。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Timing.code
Definition

スケジュール上のタイミングを表すコード(あるいはcode.text内のテキスト)。BID(1日2回)のようなコードはどこにでもあるが、多くの医療機関は付加的なコードを定義している。もし、コードが示されていれば、構造化されたタイミングで完全に示されたデータであると解釈され、コードまたはTimingを解釈するためのデータであると解釈される。しかし、例外的に.repeat.bounds(コードは含まれない)はコードを上書きして適用される。

Control0..1
BindingThe codes SHOULD be taken from TimingAbbreviation Code for a known / defined timing pattern
TypeCodeableConcept
Comments

BIDなどは「施設特有の時間」として定義される。たとえば、施設がBIDを「つねに朝7時と夕方6時」であると指定することがある。この指定が不適切であれば、BIDというコードは使うべきではない。その代わり、HL7が定義したBIDのコードではなく、その施設特有のコードで明示的に示すべきであり、構造化された表現を使うべきである(この場合、2回のイベントの時刻を指定する必要がある)。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))