HL7 FHIR JP Core ImplementationGuide
1.1.0 - release
HL7 FHIR JP Core ImplementationGuide
1.1.0 - release
HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.0). See the Directory of published versions
| 項目 | 内容 |
| 定義URL | http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationDosage |
| Version | 1.1.0 |
| Name | JP_MedicationDosage |
| Title | JP Core MedicationDosage DataType |
| Status | Active ( 2022-10-24 ) |
| Copyright | Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG |
このデータタイプは内服用法の制約と拡張のうち共通部分を定めている。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Dosage | 0..* | 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 | ||||
  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 | BID | TID | QID | AM | PM | QD | QOD | + Binding: JP Core Medication JAMI Usage ValueSet (preferred) | |
| doseAndRate | ||||
| doseQuantity | 0..1 | JP_MedicationSimpleQuantity | 1回投与量 | |
| rateRatio | 0..1 | JP_MedicationRatio_DosePerDay | １日当たりでの薬剤の投入量 | |
| rateRange | 0..1 | JP_MedicationRange_UnitOfTime | 範囲指定された時間の上限下限 | |
| rateQuantity | 0..1 | SimpleQuantity | 投与速度(量/時間)を指定する | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | JP_MedicationDosageBase | 薬の服用方法・服用した方法、または服用すべき方法 | |
 id | 0..1 | string | 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 | 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 | |
 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 | 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 - 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: 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 | 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 | 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 | 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 | 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) |
| Slices for dose[x] | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Slice: Unordered, Closed by type:$this |
| dose[x]:doseQuantity | C | 0..1 | JP_MedicationSimpleQuantity | 1回投与量 |
| 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 | １日当たりでの薬剤の投入量 |
| rate[x]:rateRange | C | 0..1 | JP_MedicationRange_UnitOfTime | 範囲指定された時間の上限下限 |
| rate[x]:rateQuantity | C | 0..1 | SimpleQuantity | 投与速度(量/時間)を指定する |
| maxDosePerPeriod | C | 0..1 | JP_MedicationRatio_DosePerPeriod | 単位時間当たりの投薬量の上限 |
| maxDosePerAdministration | C | 0..1 | JP_MedicationSimpleQuantity | 1回あたりの投薬量の上限 |
| maxDosePerLifetime | C | 0..1 | JP_MedicationSimpleQuantity | 生涯の投薬量の上限 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Dosage.additionalInstruction | preferred | JP_MedicationUsageJAMIAdditional_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.22) |
| Dosage.timing.repeat.bounds[x]:boundsDuration.comparator | required | QuantityComparator |
| Dosage.timing.repeat.durationUnit | required | UnitsOfTime |
| Dosage.timing.repeat.periodUnit | required | UnitsOfTime |
| Dosage.timing.repeat.dayOfWeek | required | DaysOfWeek |
| Dosage.timing.repeat.when | required | EventTiming |
| Dosage.timing.code | preferred | JP_MedicationUsageJAMI_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.20) |
| Dosage.site | preferred | JP_MedicationBodySiteJAMIExternal_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.32) |
| Dosage.route | preferred | JP_MedicationRouteHL70162_VS (a valid code from http://jpfhir.jp/fhir/core/CodeSystem/route-codes) |
| Dosage.method | example | SNOMEDCTAdministrationMethodCodes |
| Dosage.method.coding:unitDigit1 | preferred | JP_MedicationMethodJAMIBasicUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.30) |
| Dosage.method.coding:unitDigit2 | preferred | JP_MedicationMethodJAMIDetailUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.40) |
| Dosage.doseAndRate.type | preferred | JP_MedicationIngredientStrengthStrengthType_VS (a valid code from urn:oid:1.2.392.100495.20.2.22) |
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() | |
| qty-3 | error | Dosage.doseAndRate.dose[x], Dosage.doseAndRate.dose[x]:doseQuantity, 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.doseAndRate.dose[x]:doseQuantity, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| sqty-1 | error | Dosage.doseAndRate.rate[x]:rateQuantity | 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 | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | Dosage.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 | Dosage.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 JP_MedicationDosageBase
Summary
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | 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 | ||||
| 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 | BID | TID | QID | AM | PM | QD | QOD | + Binding: JP Core Medication JAMI Usage ValueSet (preferred) | |
| doseAndRate | ||||
| doseQuantity | 0..1 | JP_MedicationSimpleQuantity | 1回投与量 | |
| rateRatio | 0..1 | JP_MedicationRatio_DosePerDay | １日当たりでの薬剤の投入量 | |
| rateRange | 0..1 | JP_MedicationRange_UnitOfTime | 範囲指定された時間の上限下限 | |
| rateQuantity | 0..1 | SimpleQuantity | 投与速度(量/時間)を指定する | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | JP_MedicationDosageBase | 薬の服用方法・服用した方法、または服用すべき方法 | |
| id | 0..1 | string | 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 | 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 | |
| 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 | 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 - 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: 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 | 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 | 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 | 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 | 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) |
| Slices for dose[x] | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Slice: Unordered, Closed by type:$this |
| dose[x]:doseQuantity | C | 0..1 | JP_MedicationSimpleQuantity | 1回投与量 |
| 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 | １日当たりでの薬剤の投入量 |
| rate[x]:rateRange | C | 0..1 | JP_MedicationRange_UnitOfTime | 範囲指定された時間の上限下限 |
| rate[x]:rateQuantity | C | 0..1 | SimpleQuantity | 投与速度(量/時間)を指定する |
| maxDosePerPeriod | C | 0..1 | JP_MedicationRatio_DosePerPeriod | 単位時間当たりの投薬量の上限 |
| maxDosePerAdministration | C | 0..1 | JP_MedicationSimpleQuantity | 1回あたりの投薬量の上限 |
| maxDosePerLifetime | C | 0..1 | JP_MedicationSimpleQuantity | 生涯の投薬量の上限 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Dosage.additionalInstruction | preferred | JP_MedicationUsageJAMIAdditional_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.22) |
| Dosage.timing.repeat.bounds[x]:boundsDuration.comparator | required | QuantityComparator |
| Dosage.timing.repeat.durationUnit | required | UnitsOfTime |
| Dosage.timing.repeat.periodUnit | required | UnitsOfTime |
| Dosage.timing.repeat.dayOfWeek | required | DaysOfWeek |
| Dosage.timing.repeat.when | required | EventTiming |
| Dosage.timing.code | preferred | JP_MedicationUsageJAMI_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.20) |
| Dosage.site | preferred | JP_MedicationBodySiteJAMIExternal_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.32) |
| Dosage.route | preferred | JP_MedicationRouteHL70162_VS (a valid code from http://jpfhir.jp/fhir/core/CodeSystem/route-codes) |
| Dosage.method | example | SNOMEDCTAdministrationMethodCodes |
| Dosage.method.coding:unitDigit1 | preferred | JP_MedicationMethodJAMIBasicUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.30) |
| Dosage.method.coding:unitDigit2 | preferred | JP_MedicationMethodJAMIDetailUsage_VS (a valid code from urn:oid:1.2.392.200250.2.2.20.40) |
| Dosage.doseAndRate.type | preferred | JP_MedicationIngredientStrengthStrengthType_VS (a valid code from urn:oid:1.2.392.100495.20.2.22) |
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() | |
| qty-3 | error | Dosage.doseAndRate.dose[x], Dosage.doseAndRate.dose[x]:doseQuantity, 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.doseAndRate.dose[x]:doseQuantity, Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| sqty-1 | error | Dosage.doseAndRate.rate[x]:rateQuantity | 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 | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | Dosage.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | Dosage.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 | Dosage.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