HL7 FHIR JP Core ImplementationGuide
1.3.0-dev - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.3.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: JP Core AllergyIntolerance Profile

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_AllergyIntolerance
Version 1.3.0-dev
Name

JP_AllergyIntolerance
Title

JP Core AllergyIntolerance Profile
Status Active ( 2024-12-30 )
Copyright

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

このプロファイルはAllergyIntoleranceリソースに対して、患者のアレルギー不耐症に関するデータを送受信するための制約と拡張を定めるものである。

本プロファイルは、患者のアレルギー不耐症とその臨床的な評価を表現するJP_AllergyIntoleranceリソースの記録・更新・検索を行う上で、準拠するべき必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。

スコープ

  • JP_AllergyIntoleranceリソースは患者のアレルギー不耐症を表現する。具体的には、特定の物質または物質群への将来の暴露に対して有害反応を起こす傾向、または患者に対する潜在的なリスクを表現する
  • アレルギー不耐症の対象物質は、医薬品（適切な用量で正しく投与された場合）、化学物質、食べ物、植物や動物に由来する物質、または昆虫刺傷からの毒などである

想定シナリオ

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

  • JP_AllergyIntoleranceリソースの記録・更新・検索

プロファイル定義

Usage:

プロファイル詳細

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance). アレルギー不耐症 (特定の物質への暴露で生じた有害反応)
ait-1: AllergyIntolerance.verificationStatusに'entered-in-error'が入力されていない場合には、AllergyIntolerance.ClinicalStatusは、存在しなければならない。/ AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.verificationStatusに'entered-in-error'が入力されている場合、AllergyIntolerance.ClinicalStatusは、存在してはならない。 / AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... id Σ 0..1 id このアーティファクトの論理ID / Logical id of this artifact
... meta Σ 0..1 Meta リソースに関するMetadata / Metadata about the resource
... implicitRules ?!Σ 0..1 uri このコンテンツが作成されたルールのセット / A set of rules under which this content was created
... language 0..1 code リソースコンテンツの言語 / Language of the resource content
Binding: CommonLanguages (preferred): 人間の言語。 / A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation. このリソースを人間が解釈するためのテキスト要約
... contained 0..* Resource インラインリソースが含まれています / Contained, inline Resources
... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
... modifierExtension ?! 0..* Extension 無視できない拡張機能 / Extensions that cannot be ignored
... identifier Σ 0..* Identifier このアイテムの外部ID / External ids for this item
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved (アクティブ | 非アクティブ | 解決済み)
Binding: AllergyIntoleranceClinicalStatusCodes (required): アレルギーまたは不耐性の臨床状態。 / The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error (未確認 | 確認済み | 否定された | 入力エラー)
Binding: AllergyIntoleranceVerificationStatusCodes (required): 特定された物質に対する反応の傾向または潜在的なリスクに関連する確実性に関する主張。 / Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known) （アレルギー | 不耐症）
Binding: AllergyIntoleranceType (required): 反応リスクの基礎となる生理学的メカニズムの特定。 / Identification of the underlying physiological mechanism for a Reaction Risk.

... category Σ 0..* code food | medication | environment | biologic (食品 | 薬品 | 環境 | 生体)
Binding: AllergyIntoleranceCategory (required): アレルギーまたは不耐性に関連する同定された物質のカテゴリ。 / Category of an identified substance associated with allergies or intolerances.


... criticality Σ 0..1 code low | high | unable-to-assess (低い | 高い | 評価できない)
Binding: AllergyIntoleranceCriticality (required): 特定された物質に対する反応の潜在的な臨床的危害または深刻さの推定。 / Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ 0..1 CodeableConcept Code that identifies the allergy or intolerance. このアレルギー不耐症の識別コード
Binding: JP Core AllergyIntolerance ValueSet (example)
... patient Σ 1..1 Reference(JP Core Patient Profile) Who the sensitivity is for. このアレルギー不耐症を有する患者
... encounter 0..1 Reference(JP Core Encounter Profile) Encounter when the allergy or intolerance was asserted. このアレルギー不耐症が判明した受療の状況（外来、入院、救急、在宅など）
... onset[x] 0..1 When allergy or intolerance was identified. このアレルギー不耐症のオンセット
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate 0..1 dateTime Date first version of the resource instance was recorded. このアレルギー不耐症が初めて記録された日時
... recorder 0..1 Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Patient Profile | RelatedPerson) Who recorded the sensitivity. 誰がこのアレルギー不耐症を記録したか
... asserter Σ 0..1 Reference(JP Core Patient Profile | RelatedPerson | JP Core Practitioner Profile | JP Core PractitionerRole Profile) Source of the information about the allergy. このアレルギー不耐症の情報源
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction. このアレルギー不耐症が最も直近に発生した日時
... note 0..* Annotation Additional text not captured in other fields. 他のフィールド要素では記述できない追加テキスト
... reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance. このアレルゲンへの暴露に関連する有害反応
.... id 0..1 string 要素間参照のための一意のID / Unique id for inter-element referencing
.... extension 0..* Extension 実装で定義された追加のコンテンツ / Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension 認識されていなくても無視できない拡張機能 / Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event. 有害反応の原因と考えられる特定の物質または医薬品
Binding: SubstanceCode (example): 物質のタイプを定義するコード（医薬品を含む）。 / Codes defining the type of the substance (including pharmaceutical products).

.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event. この有害反応に関連する症状や兆候
Binding: SNOMEDCTClinicalFindings (example): 有害反応イベントに観察または関連する臨床症状および/または徴候。 / Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.


.... description 0..1 string Description of the event as a whole. この有害反応に関する全般的な記述
.... onset 0..1 dateTime Date(/time) when manifestations showed. この有害反応がみられた日時
.... severity 0..1 code mild | moderate | severe (of event as a whole) （軽度 | 中度 | 重度）
Binding: AllergyIntoleranceSeverity (required): 反応イベント全体の重症度の臨床評価は、潜在的に複数の異なる症状を考慮しています。 / Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance. 患者がこの物質にどのように暴露したか
Binding: SNOMEDCTRouteCodes (example): 被験者の体への、またはそれへの治療剤の投与の経路または生理学的経路を説明するコード化された概念。 / A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... note 0..* Annotation Text about event not captured in other fields. 他のフィールド要素では記述できない追加テキスト

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

必須要素

本プロファイルに準拠するためには、次の項目の値が存在しなければならない。

  • patient: 本リソースを所有する患者

Extensions定義

本プロファイルで追加定義された拡張はない。

利用方法

OperationおよびSearch Parameter 一覧

Search Parameter一覧

コンフォーマンス パラメータ 型 例
SHALL identifier token GET [base]/AllergyIntolerance?identifier=http://myhospital.com/fhir/allergyintolerance|123
SHOULD patient reference GET [base]/AllergyIntolerance?patient=Patient/123
MAY patient,date reference,date GET [base]/AllergyIntolerance?patient=Patient/123&date=ge2021-08-24
MAY patient,clinical-status reference,token GET [base]/AllergyIntolerance?patient=Patient/123&clinical-status=active
MAY patient,verification-status reference,token GET [base]/AllergyIntolerance?patient=Patient/123&verification-status=confirmed
MAY patient,type reference,token GET [base]/AllergyIntolerance?patient=Patient/123&type=allergy
MAY patient,category reference,token GET [base]/AllergyIntolerance?patient=Patient/123&category=food
MAY patient,criticality reference,token GET [base]/AllergyIntolerance?patient=Patient/123&criticality=high
必須検索パラメータ

本プロファイルに準拠するためには、以下の検索パラメータをサポートしなければならない（SHALL）

  1. 検索パラメータidentifierを指定し、レコードIDなどの識別子によりAllergyIntoleranceを検索

    GET [base]/AllergyIntolerance?identifier={system|}[token]

    例：

    GET [base]/AllergyIntolerance?identifier=http://myhospital.com/fhir/allergyintolerance|123

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

推奨検索パラメータ

本プロファイルに準拠するためには、以下の検索パラメータをサポートすることが推奨される（SHOULD）

  1. 検索パラメータpatientを指定し、該当するすべてのAllergyIntoleranceを検索

    GET [base]/AllergyIntolerance?patient={reference}

    例：

    GET [base]/AllergyIntolerance?patient=Patient/123

    指定された患者のすべてのAllergyIntoleranceを含むBundleを返却する。

追加検索パラメータ

オプションとして次の検索パラメータをサポートすることができる（MAY）

  1. 検索パラメータpatientとdateの組みを指定し、該当するすべてのAllergyIntoleranceを検索

    • dateに対する次の比較演算子のサポートを含む: gt,lt,ge,le
    • AND検索のオプションのサポートを含む (例えば.date=[date]&date=[date]]&…)
     GET [base]/AllergyIntolerance?patient={reference}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    例：

     GET [base]/AllergyIntolerance?patient=Patient/123&date=ge2021-08-24

    指定された患者および日付のすべてのAllergyIntoleranceを含むBundleを返却する。

  2. 検索パラメータpatientとclinical-statusの組みを指定し、該当するすべてのAllergyIntoleranceを検索

    • OR検索のサポートを含む(例えば clinical-status={system|}[token],{system|}[token],…)
     GET [base]/AllergyIntolerance?patient={reference}&clinical-status={system|}[token]{,{system|}[token],...}

    例：

     GET [base]/AllergyIntolerance?patient=Patient/123&clinical-status=active

     GET [base]/AllergyIntolerance?patient=Patient/123&clinical-status=http://hl7.org/fhir/ValueSet/allergyintoleranceclinical|active

    指定された患者およびステータスのすべてのAllergyIntoleranceを含むBundleを返却する。

  3. 検索パラメータpatientとverification-status組みを指定し、該当するすべてのAllergyIntoleranceを検索

    • OR検索のサポートを含む(例えば verification-status={system|}[token],{system|}[token],…)
     GET [base]/AllergyIntolerance?patient={reference}&verification-status={system|}[token]{,{system|}[token],...}

    例：

     GET [base]/AllergyIntolerance?patient=Patient/123&verification-status=confirmed

     GET [base]/AllergyIntolerance?patient=Patient/123&verification-status=http://hl7.org/fhir/ValueSet/allergyintoleranceverification|confirmed

    指定された患者およびステータスのすべてのAllergyIntoleranceを含むBundleを返却する。

  4. 検索パラメータpatientとtype組みを指定し、該当するすべてのAllergyIntoleranceを検索

    • OR検索のサポートを含む(例えば type=[token],{[token],…)
     GET [base]/AllergyIntolerance?patient={reference}&type=[token]{,[token],...}

    例：

     GET [base]/AllergyIntolerance?patient=Patient/123&type=allergy

     GET [base]/AllergyIntolerance?patient=Patient/123&category=http://hl7.org/fhir/ValueSet/allergy-intolerance-type|allergy

    指定された患者およびステータスのすべてのAllergyIntoleranceを含むBundleを返却する。

  5. 検索パラメータpatientとcategory組みを指定し、該当するすべてのAllergyIntoleranceを検索

    • OR検索のサポートを含む(例えば category=[token],[token],…)
     GET [base]/AllergyIntolerance?patient={reference}&category=[token]{,[token],...}

    例：

     GET [base]/AllergyIntolerance?patient=Patient/123&category=food

     GET [base]/AllergyIntolerance?patient=Patient/123&category=http://hl7.org/fhir/ValueSet/condition-category|food

指定された患者およびステータスのすべてのAllergyIntoleranceを含むBundleを返却する。

  1. 検索パラメータpatientとcriticality組みを指定し、該当するすべてのAllergyIntoleranceを検索

    • OR検索のサポートを含む(例えば criticality=[token],[token],…)

      GET [base]/AllergyIntolerance?patient={reference}&criticality=[token]{,[token],...}

      例：

      GET [base]/AllergyIntolerance?patient=Patient/123&&criticality=high

      GET [base]/AllergyIntolerance?patient=Patient/123&criticality=http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|high

      指定された患者およびステータスのすべてのAllergyIntoleranceを含むBundleを返却する。

オプション検索パラメータ

本プロファイルで追加定義されたオプション検索パラメータはない。

サンプル

注意事項

  • 例えば、患者に「既知のアレルギー・なし」が記録されている状態で、新規に「カニアレルギー・あり」の記録を追加する際には「既知のアレルギー・なし」の記録を削除すべきである。同様に、患者に「カニアレルギー・あり」が記録されている状態で「既知のアレルギー・なし」を記録しようとした際には、システムはこの矛盾を検出するべきである。
  • アレルギーの否定を表現する方法について。本プロファイルが継承するプロファイル（AllergyIntolerance R4.0.1）では「既知のアレルギー・なし」を表現するために、No known allergy（SNOMED-CT:716186003）等を用いることが例示されている。一方で、本プロファイルの要素であるcodeのバインド先として例示するJP Core AllergyIntolerance Value Setには「既知のアレルギー・なし」等に相当する表現がない。そのため、本プロファイルを継承するプロファイルが、JP Core AllergyIntolerance Value Setを利用する場合には、否定されたアレルギーを表現するために、アレルギーの有無を区別する要素を追加するなどの措置を取ることを想定している。なお、本プロファイルはこのValue Setの利用を要求・推奨するものではないため、他のValue Setを使う選択肢もある。
  • いずれについても詳細は、Negated Allergies and Intolerancesを参照のこと。
本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けている。