HL7 FHIR JP Core ImplementationGuide
1.1.2-url - ci-build
Japan
HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.2-url) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/core/StructureDefinition/JP_Immunization |
Version | 1.1.2-url |
Name | JP_Immunization |
Title | JP Core Immunization Profile |
Status | Active ( 2023-06-26 ) |
Copyright | Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG |
このプロファイルはImmunizationリソースに対して日本での予防接種データを送受信するための制約を加えたものである。
このV1.1.2-url 版は、CodeSystemのシステムURIをOID形式からhttp:で始まるURL形式に変更したバージョンです。
例)OID形式:urn:oid:1.2.392.10495.x.y.z
→ http:で始まるURL形式: http://jpfhir/fhire/core/CodeSystem/…..
電子カルテ情報共有サービスの実装ガイドではこのJP-Core v1.1.2-url版を参照しています。
通常版はこちらを参照ください。
本プロファイルはワクチン接種情報をImmunizationリソースを使用して表現する。 以下、本プロファイルのImmunizationリソースを「JP Core Immunizationリソース」と呼ぶ。
ワクチン接種のFHIR仕様に関しては、先行事例としてはデジタル庁が公開している新型コロナワクチン接種証明書アプリがあるが、スマートフォンでQRコードとして表示できるデータサイズに納めるため、記述されている情報は極めて限定的である。そこで、国内で利用されているそれ以外のワクチン接種関係の文書やAPIなども参考にして記述すべき項目の洗い出しや記述方法の検討を行った。具体的には、母子手帳、Yellow Card、 市町村長が有する接種記録(予防接種台帳)、ワクチン接種記録システム(VRS)、マイナポータル自己情報取得APIを参考にした。既存のImmunizationの要素で記述できない項目については、新たに拡張を定義した。
本プロファイルは、以下のようなユースケースを想定している。
本プロファイルの対象は各種ワクチンの接種情報を電子的に連携するためのメッセージを記述することである。
本プロファイルはワクチン以外の一般的な注射薬剤については対象としない。一般的な注射薬剤は、JP Core MedicationRequest Injectionプロファイルで記述することとする。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
JP Core Immunization リソースは、次の要素を持たなければならない。
JP Core Immunization リソースで使用される拡張は次の通りである。
拡張 | 説明 | 定義 | 値型 |
---|---|---|---|
DueDateOfNextDose | 次回接種予定日 | JP_Immunization_DueDateOfNextDose | dateTime |
ManufacturedDate | 製造年月日 | JP_Immunization_ManufacturedDate | dateTime |
CertificatedDate | 検定年月日 | JP_Immunization_CertificatedDate | dateTime |
既存のExtensionの利用はない。
HL7 FHIRの基底規格では、ワクチンコードとして CVX コードが使われているが、日本ではHOTコードやYJコードで一通り使用されているワクチンが定義されているため、国内で利用する際の用語集としては HOTコードとYJコードを採用した。それ以外の用語集の利用を妨げるものではない。
分類 | 名称 | URI |
---|---|---|
ワクチン | HOT9 | http://medis.or.jp/CodeSystem/master-HOT9 |
ワクチン | HOT13 | http://medis.or.jp/CodeSystem/master-HOT13 |
ワクチン | YJコード | http://capstandard.jp/CodeSystem/YJ-code |
対象疾患 | MEDIS標準病名マスター病名交換用コード | http://medis.or.jp/CodeSystem/master-disease-exCode |
参考にしたワクチン関係の文書やAPIで扱われている項目に合わせ、以下の項目を追加した。
コンフォーマンス | パラメータ | 型 | 例 |
---|---|---|---|
SHALL | identifier | token | GET [base]/Immunization?identifier=http://myhospital.com/fhir/immunization|1234567890 |
SHOULD | patient | reference | GET [base]/Immunization?patient=123456 |
SHOULD | patient,date | reference,date | GET [base]/Immunization?patient=123456&date=eq2013-01-14 |
MAY | date,lot-number | date,string | GET [base]/Immunization?date=eq2013-01-14 |
次の検索パラメータは必須でサポートされなければならない。
identifier 検索パラメータを使用して、オーダIDなどの識別子によるMedicationRequestの検索をサポートしなければならない(SHALL)
GET [base]/Immunization?identifier={system|}[code]
例:
GET [base]/Immunization?identifier=http://myhospital.com/fhir/medication|1234567890
指定された識別子に一致するImmunizationリソースを含むBundleを検索する。
次の検索パラメータをサポートすることが望ましい。
patient 検索パラメータを使用して、患者のリファレンス情報によるImmunizationの検索をサポートすることが望ましい(SHOULD)
GET [base]/Immunization?patient=[id]
GET [base]/Immunization?patient=[url]
例:
GET [base]/Immunization?patient=123456
リソースIDが123456の患者のImmunizationリソースを含むBundleを検索する。
patient,date 検索パラメータを使用して、患者のリファレンス情報と接種日によるImmunizationの検索をサポートすることが望ましい(SHOULD)
GET [base]/Immunization?patient=[id]&date=[date]
GET [base]/Immunization?patient=[url]&date=[date]
例:
GET [base]/Immunization?patient=123456&date=eq2013-01-14
リソースIDが123456の患者の2013-01-14に服用するImmunizationリソースを含むBundleを検索する。
JP Immunization リソースに対して使用される操作は次の通りである。
$everything:[base]/Immunization/[id]/$everything
この操作は、この操作が呼び出された特定のImmunizationリソースに関連する全ての情報を返す。応答は "searchset" タイプのBundleリソースである。サーバは、少なくとも、識別されたImmunizationコンパートメントに含まれる全てのリソースと、それらから参照されるすべてのリソースを返すことが望ましい。
この操作の公式なURLは以下である。
http://hl7.jp/fhir/OperationDefinition/Immunization-everything
URL: [base]/Immunization/[id]/$everything
本操作は、べき等な操作である。
名前 | 多重度 | 型 | 説明 |
---|---|---|---|
start | 0..1 | date | 特定の日付範囲で提供されたケアに関連する全ての記録を意味する。開始日が指定されていない場合、終了日以前のすべてのレコードが対象に含まれる。 |
end | 0..1 | date | 特定の日付範囲で提供されたケアに関連する全ての記録を意味する。終了日が指定されていない場合、開始日以降のすべてのレコードが対象に含まれる。 |
_since | 0..1 | instant | 指定された日時以降に更新されたリソースのみが応答に含まれる。 |
_type | 0..* | code | 応答に含むFHIRリソース型を、カンマ区切りで指定する。指定されない場合は、サーバは全てのリソース型を対象とする。 |
_count | 0..1 | integer | Bundleの1ページに含まれるリソース件数を指定。 |
名前 | 多重度 | 型 | 説明 |
---|---|---|---|
return | 1..1 | Bundle | バンドルのタイプは"searchset"である。この操作の結果は、リソースとして直接返される。 |
リクエスト:単一のImmunizationに関連する全てのリソースを取得する。
GET [base]/Immunization/1234567890/$everything
[some headers]
レスポンス:指定されたImmunizationに関連する全てのリソースを返す。
HTTP/1.1 200 OK
[other headers]
{
"resourceType": "Bundle",
"id": "example",
"meta": {
"lastUpdated": "2014-08-18T01:43:33Z"
},
"type": "searchset",
"entry": [
{
"fullUrl": "http://example.org/fhir/Immunization/1234567890",
"resource": {
"resourceType": "Immunization",
・・・
},
}
]
}
このワクチン接種例では下記の内容をFHIRで表現する場合について解説する。
項目名 | 項目値 | 備考 |
---|---|---|
接種ワクチン | コミナティ筋注 (182110901) | |
対象疾患 | COVID-19 (S9VN) | |
接種量 | 0.45mL | |
接種部位 | Left arm (LA) | |
接種実施者 | 大阪 一郎 | |
接種日時 | 2021/07/01 10:30 | |
ロット番号 | 12345678 |
Immunizationはワクチンを vaccineCodeとして1つまでしか持つことしかできないので、ワクチン単位でImmunizationリソースを作成する。
ワクチンの種類や製剤名は Immunization.vaccineCode要素にCodeableConcept型で記述する。ワクチンを識別するコードは、HOTコード(HOT13を推奨)ないしYJコードを使用する。
"vaccineCode": {
"coding": [
{
"system": "http://medis.or.jp/CodeSystem/master-HOT13",
"code": "1820201040101",
"display": "インフルエンザHAワクチン「第一三共」1mL"
}
]
}
ワクチンを接種した日は Immunization.occurrenceDateTime要素にdateTime型で記述する。日付での記述が難しい場合は、Immunization.occurrenceString要素にテキストで記述してもよい。
Immunization.occurrenceDateTime要素を使用した例:
"occurrenceDateTime": "2022-03-02"
Immunization.occurrenceString要素を使用した例:
"occurrenceString": "6才頃"
ワクチン接種の情報を記録した日時は Immunization.recorded要素にdateTime型で記述する。
"recorded": "2022-03-02T10:45:23+09:00"
ワクチンの接種場所は Immunization.location要素にReference型でLocationリソースの参照情報を記述する。
"location" : {
"reference" : "Location/1234"
}
ワクチンの製造会社は Immunization.manufacturer要素にReference型でOrganizationリソースの参照情報を記述する。
"manufacturer" : {
"reference" : "Organization/1234"
}
ワクチンのロット番号は Immunization.lotNumber要素にstring型で記述する。
"lotNumber" : "FF3620"
ワクチンの接種部位は Immunization.site要素に CodeableConcept型で記述する。部位を識別するコードにはJAMI処方・注射オーダ標準用法規格(外用部位コード) を推奨する
"site": {
"coding": [
{
"system": "http://jami.jp/CodeSystem/MedicationBodySiteExternal"
"code": "74L",
"display": "左上腕"
}
]
}
ワクチンの接種量は Immunization.doseQuantity要素にSimpleQuantity型で記述する。全体の容量をUCUM("http://unitsofmeasure.org")を使用してmL単位で指定する。
"doseQuantity": {
"value": 1,
"unit": "mL",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
ワクチンの接種実施者 Immunization.performer.actor要素にReference型でPractitionerリソースの参照情報を記述する。Immunization.performer.functionにはValueSet "http://hl7.org/fhir/ValueSet/immunization-function"から"AP" (Administering Provider)を指定する。
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP",
"display": "Administering Provider"
}
]
},
"actor": {
"reference": "Practitioner/1234"
}
}
]
ワクチン接種を行わなかった理由を記述したい場合は、Immunization.reasonCode要素にCodeableConcept型で記述する。適当な標準コードが整備されていないため、ローカルコードを定義するか、CodeableConcept.text要素にテキストとして記述する。
"reasonCode": [
{
"text": "37.5℃以上の発熱があったため。"
}
]
ワクチン接種により感染や重症化を予防できる疾患(記録によっては「予防接種の種類」と呼ばれることもある)は、Immunization.protocolApplied.targetDisease要素にCodeableConcept型で記述する。使用する用語集としては、「診療情報提供書HL7FHIR記述仕様 第1版」などでも採用されている MEDIS標準病名マスターの病名交換用コード("http://medis.or.jp/CodeSystem/master-disease-exCode")を推奨する。
"protocolApplied": [
{
"targetDisease": [
{
"coding": [
{
"system": "http://medis.or.jp/CodeSystem/master-disease-exCode",
"code": "ES0L",
"display": "インフルエンザ"
}
]
}
]
}
]
ワクチン接種の回数はImmunization.protocolApplied.doseNumberPositiveInt要素にpositiveInt型で記述する。
"protocolApplied": [
{
"doseNumberPositiveInt": 2
}
]
次回のワクチン接種予定日は既存のImmunization要素では記述ができないため、Immunizationリソースに対する拡張「DueDateOfNextDose」を使用してdate型で記述する。extension.urlには"http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_DueDateOfNextDose"を指定する。
"extension": [
{
"url": "http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_DueDateOfNextDose",
"valueDate": "2022-04-02"
}
]
ワクチンの製造年月日、検定年月日はいずれも既存のImmunization要素では記述ができないため、Immunizationリソースに対する拡張「ManufacturedDate」「CertificatedDate」をそれぞれ使用してdate型で記述する。extension.urlにはそれぞれ"http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_ManufacturedDate"、"http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_CertificatedDate"を指定する。
"extension": [
{
"url": "http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_ManufacturedDate",
"valueDate": "2021-10-14"
},
{
"url": "http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_CertificatedDate",
"valueDate": "2021-10-18"
}
]