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

Resource Profile: JP Core Medication Profile

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_Medication
Version 1.1.1
Name

JP_Medication
Title

JP Core Medication Profile
Status Active ( 2022-10-24 )
Copyright

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

このプロファイルはMedicationリソースに対して、主に薬剤データを送受信するための基礎となる制約と拡張を定めたものである。


本プロファイルは薬剤のリストを表現する。注射ではしばしば複数の薬剤が混注して用いられ、不可分であることからMedicationリソースを利用して処方を表現することとした。

主に注射薬剤処方の一部としてMedicationRequest, MedicationDispense, MedicationAdministrationリソースと組み合わせて利用する。薬剤リストに使用する用語集は諸外国と日本では異なっており、日本国内で規格を運用するためにExtensionの追加や用語集の追加・変更を行った。現在、日本での注射関連規格として利用されているJAHIS 注射データ交換規約 Ver 2.1CおよびSS-MIX2 Ver.1.2hを参考にした。

背景および想定シナリオ

本プロファイルは、以下のようなユースケースを想定している。

  • 電子カルテから特定の患者で使用された注射オーダに含まれる薬剤情報を構成する
  • 退院時サマリや診療情報提供書において注射の投薬情報の一部として記述する
  • 各種検査レポートや診断レポートにおいて注射の投薬情報の一部として記述する
  • SS-MIX2のOMP-02(注射オーダ)メッセージやJAHIS注射データ交換規約に準拠した注射オーダメッセージの一部としてJSONに変換する

スコープ

対象

本プロファイルの対象は注射、注入で使われる薬剤リストを電子的に連携するためのメッセージを記述することである。

対象としないこと

本プロファイルは注射、注入の薬剤で使用される薬剤リストに関するものであり、内服、外用の薬剤については対象としない。

また、このリソースは単独で用いられることはない。

プロファイル定義

Usage:

プロファイル詳細

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationMedication Resourceの定義
... id 0..1idこのアーチファクトに対する論理ID
... identifier 0..*Identifierこの薬剤に関する業務用のID
... code 0..1CodeableConceptこの薬剤を特定するコード
Binding: JP Core MedicationCode ValueSet (preferred): 薬品の種類を規定するコード化された概念

... status 1..1codeactive | inactive | entered-in-error
... manufacturer 0..1Reference(JP Core Organization Profile)製品の製造者
... form 0..1CodeableConceptTAB | CAP | PWD | SYR | SUP | LQD | OIT | CRM | TPE | INJ +
Binding: JP Core Medication MERIT9 Form ValueSet (preferred)
... amount 0..1JP_MedicationRatio_Amountパッケージ中の薬剤の量
... ingredient 0..*BackboneElement薬効がある、あるいは薬効を伴わない成分
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... drugNo 0..*integerRP内の薬剤の連番
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_Ingredient_DrugNo
.... item[x] 1..1CodeableConcept有効な成分あるいは含有物
.... isActive 0..1boolean有効成分の指標
.... strength 1..1JP_MedicationRatio_Amount成分の活性量
..... strengthType 0..*CodeableConcept力価区分
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_IngredientStrength_StrengthType
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (example)
... batch 0..1BackboneElement分包された薬剤についての詳細な解説
.... lotNumber 0..1stringバッチのID
.... expirationDate 0..1dateTimeこのバッチの期限が切れるとき

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationMedication Resourceの定義
... id Σ0..1idこのアーチファクトに対する論理ID
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*Identifierこの薬剤に関する業務用のID
... code Σ0..1CodeableConceptこの薬剤を特定するコード
Binding: JP Core MedicationCode ValueSet (preferred): 薬品の種類を規定するコード化された概念

... status ?!Σ1..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(JP Core Organization Profile)製品の製造者
... form 0..1CodeableConceptTAB | CAP | PWD | SYR | SUP | LQD | OIT | CRM | TPE | INJ +
Binding: JP Core Medication MERIT9 Form ValueSet (preferred)
... amount C0..1JP_MedicationRatio_Amountパッケージ中の薬剤の量
... ingredient 0..*BackboneElement薬効がある、あるいは薬効を伴わない成分
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... drugNo 0..*integerRP内の薬剤の連番
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_Ingredient_DrugNo
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1CodeableConcept有効な成分あるいは含有物
.... isActive 0..1boolean有効成分の指標
.... strength C1..1JP_MedicationRatio_Amount成分の活性量
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... strengthType 0..*CodeableConcept力価区分
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_IngredientStrength_StrengthType
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (example)
..... numerator C0..1JP_MedicationQuantity投与量
..... denominator C0..1JP_MedicationQuantityパッケージ量
... batch 0..1BackboneElement分包された薬剤についての詳細な解説
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringバッチのID
.... expirationDate 0..1dateTimeこのバッチの期限が切れるとき

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codepreferredJP_MedicationCode_VS
Medication.statusrequiredMedication Status Codes
Medication.formpreferredJP_MedicationFormMERIT9_VS (a valid code from http://jpfhir.jp/fhir/core/CodeSystem/JP_MedicationFormMERIT9_CS)

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()
qty-3errorMedication.ingredient.strength.numerator, Medication.ingredient.strength.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator 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())

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationMedication Resourceの定義
... id 0..1idこのアーチファクトに対する論理ID
... identifier 0..*Identifierこの薬剤に関する業務用のID
... code 0..1CodeableConceptこの薬剤を特定するコード
Binding: JP Core MedicationCode ValueSet (preferred): 薬品の種類を規定するコード化された概念

... status 1..1codeactive | inactive | entered-in-error
... manufacturer 0..1Reference(JP Core Organization Profile)製品の製造者
... form 0..1CodeableConceptTAB | CAP | PWD | SYR | SUP | LQD | OIT | CRM | TPE | INJ +
Binding: JP Core Medication MERIT9 Form ValueSet (preferred)
... amount 0..1JP_MedicationRatio_Amountパッケージ中の薬剤の量
... ingredient 0..*BackboneElement薬効がある、あるいは薬効を伴わない成分
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... drugNo 0..*integerRP内の薬剤の連番
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_Ingredient_DrugNo
.... item[x] 1..1CodeableConcept有効な成分あるいは含有物
.... isActive 0..1boolean有効成分の指標
.... strength 1..1JP_MedicationRatio_Amount成分の活性量
..... strengthType 0..*CodeableConcept力価区分
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_IngredientStrength_StrengthType
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (example)
... batch 0..1BackboneElement分包された薬剤についての詳細な解説
.... lotNumber 0..1stringバッチのID
.... expirationDate 0..1dateTimeこのバッチの期限が切れるとき

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationMedication Resourceの定義
... id Σ0..1idこのアーチファクトに対する論理ID
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*Identifierこの薬剤に関する業務用のID
... code Σ0..1CodeableConceptこの薬剤を特定するコード
Binding: JP Core MedicationCode ValueSet (preferred): 薬品の種類を規定するコード化された概念

... status ?!Σ1..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(JP Core Organization Profile)製品の製造者
... form 0..1CodeableConceptTAB | CAP | PWD | SYR | SUP | LQD | OIT | CRM | TPE | INJ +
Binding: JP Core Medication MERIT9 Form ValueSet (preferred)
... amount C0..1JP_MedicationRatio_Amountパッケージ中の薬剤の量
... ingredient 0..*BackboneElement薬効がある、あるいは薬効を伴わない成分
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... drugNo 0..*integerRP内の薬剤の連番
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_Ingredient_DrugNo
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1CodeableConcept有効な成分あるいは含有物
.... isActive 0..1boolean有効成分の指標
.... strength C1..1JP_MedicationRatio_Amount成分の活性量
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... strengthType 0..*CodeableConcept力価区分
URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Medication_IngredientStrength_StrengthType
Binding: JP Core Medication IngredientStrength StrengthType ValueSet (example)
..... numerator C0..1JP_MedicationQuantity投与量
..... denominator C0..1JP_MedicationQuantityパッケージ量
... batch 0..1BackboneElement分包された薬剤についての詳細な解説
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringバッチのID
.... expirationDate 0..1dateTimeこのバッチの期限が切れるとき

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codepreferredJP_MedicationCode_VS
Medication.statusrequiredMedication Status Codes
Medication.formpreferredJP_MedicationFormMERIT9_VS (a valid code from http://jpfhir.jp/fhir/core/CodeSystem/JP_MedicationFormMERIT9_CS)

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()
qty-3errorMedication.ingredient.strength.numerator, Medication.ingredient.strength.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator 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())

 

Other representations of profile: CSV, Excel, Schematron

必須要素

次のデータ項目は必須である。

Medication リソースは、次の要素を持たなければならない。

  • status : ステータスは必須である
  • ingredient.itemCodeableConcept : 医薬品の識別情報であり、JP Coreでは必須である
  • ingredient.strength : 医薬品の投与量であり、JP Coreでは必須である

Medicationリソースでは、次の要素をサポートしなければならない。

  • ingredient.itemCodeableConcept : 医薬品の識別情報
  • ingredient.strength : 医薬品の投与量

Extensions定義

Medication リソースで使用される拡張は次の通りである。

拡張 説明 定義 値型
RP内薬剤番号 RP内の薬剤の連番を格納する拡張 JP_Medication_Ingredient_DrugNo integer
力価区分 投与量が製剤単位か成分単位かを格納する拡張 JP_Medication_IngredientStrength_StrengthType CodeableConcept

用語定義

HL7 FHIRの基底規格では、薬剤コードをはじめとして、剤形などでSNOMED CTが使われているが、日本ではライセンスの問題もあり普及していない。代替としてJAHIS注射データ交換規約やSS-MIX2で使われている用語集を採用した。

HL7 ver 2系では用語集を識別するコーディングシステム名(以下、「CS名」）は文字列であったが、FHIRではURIを指定する必要があるため、それぞれにURIを割り当てた。以下に使用する用語集のCS名とURI表記を列記する。

分類 CS名 URI
医薬品 HOT7 urn:oid:1.2.392.200119.4.403.2
医薬品 HOT9 urn:oid:1.2.392.200119.4.403.1
医薬品 HOT13 urn:oid:1.2.392.200119.4.402.1
医薬品 YJコード urn:oid:1.2.392.100495.20.1.73
剤形 MERIT-9(剤形) http://jpfhir.jp/fhir/core/CodeSystem/JP_MedicationFormMERIT9_CS
薬品単位 MERIT-9(単位） urn:oid:1.2.392.100495.20.2.101
力価区分 処方情報 HL7FHIR 記述仕様(力価区分) urn:oid:1.2.392.100495.20.2.22

項目の追加

日本国内の電子カルテシステムでの注射オーダの運用に合わせ、以下の項目を追加した。

  • 薬剤番号（拡張「JP_MedicationDrugNo」を使用）
  • ⼒価区分の追加（拡張「JP_MedicationStrengthType」を使用）

利用方法

Medication リソースは単体として用いられないため、検索などはMedicationRequest_Injectionなどの一部として行われる。

サンプル

注射関係のMedicationRequest_Injection、MedicationDispense_Injection、MedicationAdministration_Injectionリソースから参照されるサンプルを示す。

各種コメントの記述方法

Medicationリソースを参照する上位のリソースに記述される。

その他、参考文献・リンク等

  1. HL7, FHIR MedicationRequest Resource, https://hl7.org/fhir/R4/medicationrequest.html
  2. HL7, FHIR Medication Resource, https://hl7.org/fhir/R4/medication.html
  3. HL7, FHIR BodyStructure Resource, https://hl7.org/fhir/R4/bodystructure.html
  4. 保健医療福祉情報システム工業会, JAHIS 注射データ交換規約 Ver.2.1C, https://www.jahis.jp/standard/detail/id=590
  5. 日本医療情報学会MERIT-9研究会, 医療情報交換規約運用指針、MERIT-9 処方オーダver 1.0, http://merit-9.mi.hama-med.ac.jp/jahis/SHOHOU.pdf
  6. 保健医療福祉情報システム工業会, JAHISデータ交換規約（共通編）Ver.1.2, https://www.jahis.jp/standard/detail/id=725
  7. 保健医療福祉情報システム工業会, JAHIS注射データ交換規約Ver.2.1C, https://www.jahis.jp/standard/detail/id=590
  8. Mike Henderson, 日本HL7協会監修、「HL7メッセージ交換」、第2版、インナービジョン社、2013年
  9. 一般社団法人医療情報システム開発センター, 医薬品HOT コードマスター, http://www2.medis.or.jp/hcode/
  10. 日本医療情報学会、SS-MIX2仕様書・ガイドライン, http://www.jami.jp/jamistd/ssmix2.php