Argonaut Data Query Implementation Guide Version 1.0.0

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

D.4.1 StructureDefinition-argo-allergyintolerance

U.S. Argonaut AllergyIntolerance Profile

Scope and Usage

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:

  • Query for Allergies belonging to a Patient
  • Record a Patient Allergy
Mandatory Data Elements and Terminology

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:

  1. a status of the allergy
  2. a code which indicates the substance responsible for an adverse reaction
  3. a patient

Profile specific implementation guidance:

  • Representing No Known Allergies: No Known Allergies will be represented using the Argonaut AllergyIntolerance profile with appropriate negation code in AllergyIntolerence.code.
Examples

D.4.1.1 Formal Views of Profile Content

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.

Summary of the Mandatory Requirements

  1. One patient reference in AllergyIntolerance.patient
  2. One Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk in AllergyIntolerance.code which has an extensible binding to:
  3. One status in AllergyIntolerance.status which has a required binding to: - AllergyIntoleranceStatus value set
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*Argonaut AllergyIntolerance Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... onset Σ0..1dateTimeDate(/time) when manifestations showed
... recordedDate Σ0..1dateTimeWhen recorded
... recorder Σ0..1Reference(Practitioner), Reference(Patient)Who recorded the sensitivity
... patient S1..1Reference(Argonaut Patient Profile)Who the sensitivity is for
... reporter Σ0..1Reference(Patient), Reference(RelatedPerson), Reference(Practitioner)Source of the information about the allergy
... substance S1..1CodeableConceptSubstance, (or class) considered to be responsible for risk
Binding: Argonaut Substance-Reactant for Intolerance and Negation Codes (extensible)
... status ?!S1..1codeactive | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
Binding: AllergyIntoleranceStatus (required)
... criticality Σ0..1codeCRITL | CRITH | CRITU
Binding: AllergyIntoleranceCriticality (required)
... type Σ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category Σ0..1codefood | medication | environment | other - Category of Substance
Binding: AllergyIntoleranceCategory (required)
... lastOccurence Σ0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..1AnnotationAdditional text not captured in other fields
... reaction 0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... substance Σ0..1CodeableConceptSpecific substance considered to be responsible for event
Binding: Substance Code (example)
.... certainty Σ0..1codeunlikely | likely | confirmed - clinical certainty about the specific substance
Binding: AllergyIntoleranceCertainty (required)
.... manifestation Σ1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (example)
.... description 0..1stringDescription of the event as a whole
.... onset Σ0..1dateTimeDate(/time) when manifestations showed
.... severity Σ0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute Σ0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..1AnnotationText about event not captured in other fields

doco Documentation for this format

Summary of the Mandatory Requirements

  1. One patient reference in AllergyIntolerance.patient
  2. One Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk in AllergyIntolerance.code which has an extensible binding to:
  3. One status in AllergyIntolerance.status which has a required binding to: - AllergyIntoleranceStatus value set

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*Argonaut AllergyIntolerance Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... onset Σ0..1dateTimeDate(/time) when manifestations showed
... recordedDate Σ0..1dateTimeWhen recorded
... recorder Σ0..1Reference(Practitioner), Reference(Patient)Who recorded the sensitivity
... patient S1..1Reference(Argonaut Patient Profile)Who the sensitivity is for
... reporter Σ0..1Reference(Patient), Reference(RelatedPerson), Reference(Practitioner)Source of the information about the allergy
... substance S1..1CodeableConceptSubstance, (or class) considered to be responsible for risk
Binding: Argonaut Substance-Reactant for Intolerance and Negation Codes (extensible)
... status ?!S1..1codeactive | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
Binding: AllergyIntoleranceStatus (required)
... criticality Σ0..1codeCRITL | CRITH | CRITU
Binding: AllergyIntoleranceCriticality (required)
... type Σ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category Σ0..1codefood | medication | environment | other - Category of Substance
Binding: AllergyIntoleranceCategory (required)
... lastOccurence Σ0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..1AnnotationAdditional text not captured in other fields
... reaction 0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... substance Σ0..1CodeableConceptSpecific substance considered to be responsible for event
Binding: Substance Code (example)
.... certainty Σ0..1codeunlikely | likely | confirmed - clinical certainty about the specific substance
Binding: AllergyIntoleranceCertainty (required)
.... manifestation Σ1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (example)
.... description 0..1stringDescription of the event as a whole
.... onset Σ0..1dateTimeDate(/time) when manifestations showed
.... severity Σ0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute Σ0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..1AnnotationText about event not captured in other fields

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

D.4.1.2 Quick Start

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:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope