JPCoreAllergyIntolerance プロファイル

このドキュメントはHL7 FHIR JPワーキンググループで作業中の実装ガイドです。

概略

項目 内容
定義URL http://hl7fhir.jp/fhir/xxxxxxx/xxxxxxx
バージョン 0.0.1
名前 JPCoreAllergyIntolerance
タイトル JPCoreAllergyIntolerance プロファイル
ステータス アクティブ(2021-08-25)
定義 JP_AllergyIntoleranceの制約と拡張を定義し、アレルギー情報を照会・検索するための最小限のデータセットを提供。
公開者 HL7 FHIR JP WG・・・
Copyright xxxxxxx
ソースリソース XML / JSON / Turtle (リンク未)

本プロファイルは、患者のアレルギーに関する情報の登録や検索、取得のために 、FHIR AllergyIntolerance リソースを使用するにあたっての、最低限の制約を記述したものである。AllergyIntolerance リソースに対して本プロファイルに準拠する場合に必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。

想定シナリオ

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

  • 患者のアレルギーまたは不耐症に関する記録と検索
  • 他のリソースからの患者のアレルギーまたは不耐症情報の参照(例:AdverseEvent(リンク未))

スコープ

患者のアレルギーまたは不耐症を記録する。具体的には、特定の物質または物質群への将来の暴露に対して有害反応を起こす傾向、または患者に対する潜在的なリスクを記載する

アレルギー又は不耐症の対象物質は、医薬品(適切な用量で正しく投与された場合)、化学物質、食べ物、植物や動物に由来する物質、または昆虫刺傷からの毒などを記載する。

関連するプロファイル

JP AllergyIntolerance リソースは、以下のリソースから直接参照される。
(暫定。FHIR v4.0.1を参照した。)

  • AdverseEvent
  • ClinicalImpression
  • FamilyMemberHistory
  • NutritionOrder

リソース定義

https://simplifier.net/fhirjpigwg/jpallergyintolerancev400

identifier
clinicalStatus
verificationStatus
type
category
code1..
patient
manifestation

必須要素

必須要素はない。

Extensions定義

Extension定義はない。

Terminology Bindings

Path 定義 バインディング強度 バリューセット
AllergyIntolerance.clinicalStatus このアレルギー・不耐性の臨床的なステータス。 Required active, inactive, resolved
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
AllergyIntolerance.verificationStatus 特定された物質(医薬品を含む)に対する反応の傾向や潜在的なリスクに関連する確実性。 Required unconfirmed, confirmed, refuted, entered-in-error
http://hl7.org/fhir/ValueSet/allergyintolerance-verification
AllergyIntolerance.type 副作用リスクの原因にある生理学的メカニズムの種類 Required allergy, intolerance
http://hl7.org/fhir/ValueSet/allergy-intolerance-type
AllergyIntolerance.category 特定された原因物質のカテゴリ Required JP_food, JP_medication, JP_environment_others
http://..JP用語集
AllergyIntolerance.criticality 特定されたアレルギー物質に対する反応の、潜在的な臨床的危害または深刻さの推定 Required low, high, unable-to-assess
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality
AllergyIntolerance.code アレルゲンのコード Example JFAGY
http://..JP用語集
AllergyIntolerance.affirmation アレルギーの有無 Example affirmation, negation
http://..JP用語集
AllergyIntolerance.reaction.substance アレルギー不耐症の原因と考えられた特定の物質(医薬品を含む)の識別情報 Example 未定
AllergyIntolerance.reaction.manifestation 有害事象イベントにおいて観測される、または関連する臨床症状および/または兆候 Example 未定
AllergyIntolerance.reaction.severity 有害事象イベントの重症度の臨床評価 Required mild, moderate, seevere
http://hl7.org/fhir/ValueSet/reaction-event-severity
AllergyIntolerance.reaction.exposureRoute 被験者が物質にさらされた経路の説明 Example sct:6064005 Topical route, sct:10547007 Auricular use, sct:12130007 Intra-articular route など (150個程度)
http://hl7.org/fhir/ValueSet/route-codes

JP AllergyIntolerance リソースでは、JPFHIRアレルギー用語集の用語及びJFAGYコードを利用する。

利用方法

(OperationやSearch Parameter中心に記載を行います。)未着手

Interaction一覧

Conformance Interactions
SHALL search-type, read
SHOULD vread, history-instance
MAY create, update, patch, delete, history-type
必須検索パラメータ

(★ 以下未検討) 次の検索パラメータは必須でサポートされなければならない。

  1. identifier 検索パラメータを使用して、医籍登録番号などの識別子によるPractitionerの検索をサポートしなければならない(SHALL)。

    GET [base]/Practitioner?identifier={system|}[code]

    例:

    GET [base]/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|123456

    指定された識別子に一致するPractitionerリソースを含むBundleを検索する。

  2. name 検索パラメータを使用して、任意の名前パートによる文字列検索をサポートしなければならない(SHALL)。

    GET [base]/Practitioner?name=[string]

    例:

    GET [base]/Practitioner?name=山田

    名前(姓、名、またはテキスト)が一致するPractitionerリソースを含むBundleを検索する。

推奨検索パラメータ

(★ 以下未検討) 次の検索パラメータをサポートすることが望ましい。

  1. communication 検索パラメータを使用して、医療従事者が使用する言語コードによるPractitionerの検索をサポートすることが望ましい(SHOULD)。

    GET [base]/Practitioner?communication={system|}[code]

    例:

    GET [base]/Practitioner?communication=urn:ietf:bcp:47|jp

    使用言語が指定された言語コードと一致するPractitionerリソースを含むBundleを検索する。

追加検索パラメータ

(★ 以下未検討) ★★コメント: US-Coreでは 基底以外の追加検索パラメータ(基底プロパティまたは拡張(Extension)に対する検索パラメータの両方を含む)についての記載がありませんが、必要と思われたので追加しました。内容は例示です。★★

  1. qualification-identifier検索パラメータを使用して、資格識別子によるPractitionerの検索をサポートしなければならない(SHALL)。

    GET [base]/Practitioner?qualification-identifier={system|}{value}

    例:

    GET [base]/Practitioner?qualification-identifier=http://example.org/UniversityIdentifier|12345

    指定された識別子と資格識別子が一致するPractitionerリソースを含むBundleを検索する。

  2. jp-core-ethnicity検索パラメータを使用して、民族性によるPractitionerの検索をサポートすることが望ましい(SHOULD)。

    GET [base]/Practitioner?jp-core-ethnicity={system|}{code}

    例:

    GET [base]/Practitioner/?jp-core-ethnicity=http:example.org/ethnicity|abc

    指定された民族コードと民族性が一致するPractitionerリソースを含むBundleを検索する。

Operation一覧

(★ 以下未検討)

★★コメント: Practitionerに対するOperationは定義されていないため、例示します。内容の妥当性は考慮していません。★★

JP Practitioner リソースに対して使用される操作は次の通りである。

  • $everything:[base]/Practitioner/[id]/$everything

    • この操作が呼び出された特定のPractitionerに関連する全ての情報を返す。

Operation 詳細

★★コメント:内容は、例示であり、妥当性は考慮していません。★★

$everything 操作

この操作は、この操作が呼び出された特定のPractitionerリソースに関連する全ての情報を返す。応答は "searchset" タイプのBundleリソースである。サーバは、少なくとも、識別された医療従事者のPractitionerコンパートメントに含まれる全てのリソースと、それらから参照されるすべてのリソースを返すことが望ましい。

この操作の公式なURLは以下である。

http://hl7.jp/fhir/OperationDefinition/Practitioner-everything

URL: [base]/Practitioner/[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"である。この操作の結果は、リソースとして直接返される。

リクエスト:単一のPractitionerに関連する全てのリソースを取得する。

GET [base]/Practitioner/p001/$everything [some headers]

レスポンス:指定されたPractitionerに関連する全てのリソースを返す。

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/Practitioner/p001", "resource": { "resourceType": "Practitioner",      ・・・     }, } ] }

サンプル

★★コメント:例示します。★★未着手

{
  "resourceType": "Practitioner",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>神奈川 花子</li><li>カナガワ ハナコ</li><li>麻薬施用者免許番号:4-321</li></ul></div>"
  },
  "name": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
          "valueCode": "IDE"
        }
      ],
      "text": "神奈川花子",
      "family": "神奈川",
      "given": [
        "花子"
      ]
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
          "valueCode": "SYL"
        }
      ],
      "text": "カナガワハナコ",
      "family": "カナガワ",
      "given": [
        "ハナコ"
      ]
    }
  ],
  "qualification": [
    {
      "identifier": [
        {
          "system": "urn:oid:1.2.392.100495.20.3.32.13",
          "value": "4-321"
        }
      ],
      "code": {
        "Coding": [
          {
            "system": "http://hl7.jp/fhir/ePrescription/certificate",
            "code": "NarcoticsPractitioner"
          }
        ]
      }
    }
  ]
}

サンプル

JSONサンプル その2

注意事項

(全体に対する注意事項等、その他の部分について記載します。)

医療従事者の資格は、組織や役割に関係なく医療従事者によって取得されたものであり、特定の組織(Organization)または場所(Location)で、資格に関連する役割を実行することが許可または認可されていることを意味するものではないことに注意する。

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

構造定義

(リソース定義全般の概略記載します)
ほほいほ

想定シナリオ

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

  • 患者ののアレルギー情報の登録

  • 他のリソース

スコープ

(対象としているスコープ/対象としないスコープについて記載します)

リソース定義

identifier
clinicalStatus
verificationStatus
type
category
code1..
patient
manifestation

関連するプロファイル

JP Practitioner リソースは、以下のリソースから直接参照される。

AdverseEvent, ClinicalImpression, FamilyMemberHistory and NutritionOrder

必須要素

(必須要素についての説明を行います)

Extensions定義

(拡張を行った場合、ここに説明を記載します)

利用方法

(Search Parameter中心に記載を行います。)

注意事項

(全体に対する注意事項等、その他の部分について記載します。)##