This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
This profile sets minimum expectations for the AllergyIntolerance resource to record, search and fetch allergies/adverse events associated with a patient. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the AllergyIntolerance resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the Argonaut AllergyIntolerance profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each AllergyIntolerance must have:
Profile specific implementation guidance:
The official URL for this profile is:
http://fhir.org/guides/argonaut/StructureDefinition/argo-allergyintolerance
This profile builds on AllergyIntolerance.
This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
AllergyIntolerance.patient
AllergyIntolerance.code
which has an extensible binding to:
AllergyIntolerance.status
which has a required binding to:
- AllergyIntoleranceStatus value setName | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | Argonaut AllergyIntolerance Profile | ||
patient | S | 1..1 | Reference(Argonaut Patient Profile) | |
substance | S | 1..1 | CodeableConcept | Binding: Argonaut Substance-Reactant for Intolerance and Negation Codes (extensible) |
status | S | 1..1 | code | Binding: AllergyIntoleranceStatus (required) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | Argonaut AllergyIntolerance Profile | ||
id | Σ | 0..1 | id | 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: IETF BCP-47 (required) | |
text | I | 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 |
onset | Σ | 0..1 | dateTime | Date(/time) when manifestations showed |
recordedDate | Σ | 0..1 | dateTime | When recorded |
recorder | Σ | 0..1 | Reference(Practitioner), Reference(Patient) | Who recorded the sensitivity |
patient | S | 1..1 | Reference(Argonaut Patient Profile) | Who the sensitivity is for |
reporter | Σ | 0..1 | Reference(Patient), Reference(RelatedPerson), Reference(Practitioner) | Source of the information about the allergy |
substance | S | 1..1 | CodeableConcept | Substance, (or class) considered to be responsible for risk Binding: Argonaut Substance-Reactant for Intolerance and Negation Codes (extensible) |
status | ?!S | 1..1 | code | active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error Binding: AllergyIntoleranceStatus (required) |
criticality | Σ | 0..1 | code | CRITL | CRITH | CRITU Binding: AllergyIntoleranceCriticality (required) |
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
category | Σ | 0..1 | code | food | medication | environment | other - Category of Substance Binding: AllergyIntoleranceCategory (required) |
lastOccurence | Σ | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
note | 0..1 | Annotation | Additional text not captured in other fields | |
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
substance | Σ | 0..1 | CodeableConcept | Specific substance considered to be responsible for event Binding: Substance Code (example) |
certainty | Σ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance Binding: AllergyIntoleranceCertainty (required) |
manifestation | Σ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (example) |
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) |
exposureRoute | Σ | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) |
note | 0..1 | Annotation | Text about event not captured in other fields | |
Documentation for this format |
AllergyIntolerance.patient
AllergyIntolerance.code
which has an extensible binding to:
AllergyIntolerance.status
which has a required binding to:
- AllergyIntoleranceStatus value setDifferential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | Argonaut AllergyIntolerance Profile | ||
patient | S | 1..1 | Reference(Argonaut Patient Profile) | |
substance | S | 1..1 | CodeableConcept | Binding: Argonaut Substance-Reactant for Intolerance and Negation Codes (extensible) |
status | S | 1..1 | code | Binding: AllergyIntoleranceStatus (required) |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | Argonaut AllergyIntolerance Profile | ||
id | Σ | 0..1 | id | 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: IETF BCP-47 (required) | |
text | I | 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 |
onset | Σ | 0..1 | dateTime | Date(/time) when manifestations showed |
recordedDate | Σ | 0..1 | dateTime | When recorded |
recorder | Σ | 0..1 | Reference(Practitioner), Reference(Patient) | Who recorded the sensitivity |
patient | S | 1..1 | Reference(Argonaut Patient Profile) | Who the sensitivity is for |
reporter | Σ | 0..1 | Reference(Patient), Reference(RelatedPerson), Reference(Practitioner) | Source of the information about the allergy |
substance | S | 1..1 | CodeableConcept | Substance, (or class) considered to be responsible for risk Binding: Argonaut Substance-Reactant for Intolerance and Negation Codes (extensible) |
status | ?!S | 1..1 | code | active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error Binding: AllergyIntoleranceStatus (required) |
criticality | Σ | 0..1 | code | CRITL | CRITH | CRITU Binding: AllergyIntoleranceCriticality (required) |
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
category | Σ | 0..1 | code | food | medication | environment | other - Category of Substance Binding: AllergyIntoleranceCategory (required) |
lastOccurence | Σ | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
note | 0..1 | Annotation | Additional text not captured in other fields | |
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
substance | Σ | 0..1 | CodeableConcept | Specific substance considered to be responsible for event Binding: Substance Code (example) |
certainty | Σ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance Binding: AllergyIntoleranceCertainty (required) |
manifestation | Σ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (example) |
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) |
exposureRoute | Σ | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) |
note | 0..1 | Annotation | Text about event not captured in other fields | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.
GET /AllergyIntolerance?patient=[id]
Example:
GET https://fhir-open-api-dstu2.smarthealthit.org/AllergyIntolerance?patient=1137192
Support: Mandatory to support search by patient.
Implementation Notes: Search for all allergies for a patient. Fetches a bundle of all AllergyIntolerance resources for the specified patient (how to search by reference).
Response Class: