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_MedicationDosageBase |
| Version | 1.1.0 |
| Name | JP_MedicationDosageBase |
| Title | JP Core MedicationDosage Base DataType |
| Status | Active ( 2022-10-24 ) |
| Copyright | Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG |
このデータタイプは薬剤用法のDosageベースとして基礎となる制約と拡張のうち共通部分を定めている。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Dosage
Summary
Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Dosage | 0..* | Dosage | 薬の服用方法・服用した方法、または服用すべき方法 | |
  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 |
| 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 | 投与日時 | |
| 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) |
| dose[x] | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) |
 rate[x] | Σ | 0..1 | 薬剤の投与量速度 | |
| rateRatio | Ratio | |||
| rateRange | Range | |||
| rateQuantity | Quantity(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.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.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.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()) | |
| sqty-1 | error | Dosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from Dosage
Summary
Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Dosage | 0..* | Dosage | 薬の服用方法・服用した方法、または服用すべき方法 | |
| 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 |
| 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 | 投与日時 | |
| 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) |
| dose[x] | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) |
| rate[x] | Σ | 0..1 | 薬剤の投与量速度 | |
| rateRatio | Ratio | |||
| rateRange | Range | |||
| rateQuantity | Quantity(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.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.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.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()) | |
| sqty-1 | error | Dosage.doseAndRate.dose[x], Dosage.maxDosePerAdministration, Dosage.maxDosePerLifetime | The comparator is not used on a SimpleQuantity : comparator.empty() |
Other representations of profile: CSV, Excel, Schematron