International Patient Access
0.1.0 - STU 1 ballot
International Patient Access
0.1.0 - STU 1 ballot
This page is part of the International Patient Access (v0.1.0: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Defining URL: | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance |
| Version: | 0.1.0 |
| Name: | IPAAllergyIntolerance |
| Title: | IPA-AllergyIntolerance |
| Status: | Draft as of 8/26/19 3:10 PM |
| Definition: | Minimum expectations for an AllergyIntolerance resource when accessed via a International Patient Access API |
| Publisher: | HL7 International - Patient Care Workgroup |
| Copyright: | Creative Commons Public Domain |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
  clinicalStatus | S | 0..1 | CodeableConcept | active | inactive | resolved |
| verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
| category | 0..1 | code | food | medication | environment | biologic | |
| code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
  patient | S | 1..1 | Reference(IPA-Patient) | Who the sensitivity is for |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | 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) Max Binding: AllLanguages: A human language. | |
| 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 | External ids for this item |
| clinicalStatus | ?!SΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus | ?!SΣI | 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..1 | 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 | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
| patient | SΣ | 1..1 | Reference(IPA-Patient) | Who the sensitivity is for |
| encounter | 0..1 | Reference(Encounter) | 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(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | 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 | 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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
| clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus | ?!ΣI | 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. |
| code | Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
| patient | Σ | 1..1 | Reference(IPA-Patient) | Who the sensitivity is for |
| Documentation for this format | ||||
This structure is derived from AllergyIntolerance
Differential View
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
| clinicalStatus | S | 0..1 | CodeableConcept | active | inactive | resolved |
| verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
| category | 0..1 | code | food | medication | environment | biologic | |
| code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
| patient | S | 1..1 | Reference(IPA-Patient) | Who the sensitivity is for |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | 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) Max Binding: AllLanguages: A human language. | |
| 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 | External ids for this item |
| clinicalStatus | ?!SΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus | ?!SΣI | 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..1 | 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 | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
| patient | SΣ | 1..1 | Reference(IPA-Patient) | Who the sensitivity is for |
| encounter | 0..1 | Reference(Encounter) | 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(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | 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 | 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 | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| AllergyIntolerance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes |
| AllergyIntolerance.reaction.substance | example | SubstanceCode |
| AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
IG © 2021+ HL7 International - Patient Care Workgroup. Package hl7.fhir.uv.ipa#0.1.0 based on FHIR 4.0.1. Generated 2021-12-06
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change