Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena AllergyIntolerance

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaAllergy

athena allergy profile

This AllergyIntolerance profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

AllergyIntolerance is a recorded clinical assessment of an allergy or intolerance

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access AllergyIntolerance resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The AllergyIntolerance resource describes a recorded clinical assessment of an allergy or intolerance. It is derived from the Allergy table in athenaPractice and same in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

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

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
... id S 1..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore AllergyIntolerance Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
..... profile:Athena Allergy Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..2 Coding Tags applied to this resource
... Slices for extension Content/Rules for all slices
.... encounter 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter"
..... value[x] 1..1 Reference() Value of extension
.... enddate 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate"
..... value[x] 1..1 dateTime Value of extension
... clinicalStatus S 0..1 CodeableConcept active | inactive | resolved
... verificationStatus S 0..1 CodeableConcept refuted | entered-in-error
... category 0..* code food | medication | environment
... criticality 0..1 code low|high
... code 1..1 CodeableConcept Identification of the allergy or intolearnce
.... Slices for coding 0..5 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LabProd 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code 1..1 code Symbol in syntax defined by the system
..... coding:GPI 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code 1..1 code Symbol in syntax defined by the system
..... coding:DDID 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code 1..1 code Symbol in syntax defined by the system
..... coding:KDC 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code 1..1 code Symbol in syntax defined by the system
..... coding:SNOMED 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
..... coding:RXNORM 0..1 Coding Code defined by a terminology system
.... text 0..1 string Plain text representation of the concept
... patient S 1..1 Reference(Patient) Who the sensitivity is for
... onset[x] 0..1 Date(/time) when manifestations showed
.... onsetDateTime dateTime
.... onsetString string
... recordedDate 0..1 dateTime When recorded
... recorder 0..1 Reference(Practitioner | Patient) Who recorded the sensitivity
... note 0..1 Annotation Additional text not captured in other fields
... Slices for reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
Slice: Unordered, Open by value:system
.... reaction:SHOCK 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:RESP 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:GI 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:HEME 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:RASH 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:OTHER 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore AllergyIntolerance Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... encounter 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter"
..... value[x] 1..1 Reference() Value of extension
.... enddate 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate"
..... value[x] 1..1 dateTime Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC 0..1 CodeableConcept refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... category Σ 0..* code food | medication | environment
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ 0..1 code low|high
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ 1..1 CodeableConcept Identification of the allergy or intolearnce
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

.... Slices for coding Σ 0..5 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LabProd Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:GPI Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:DDID Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:KDC Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:SNOMED Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... onset[x] 0..1 Date(/time) when manifestations showed
.... onsetDateTime dateTime
.... onsetString string
... recordedDate 0..1 dateTime When recorded
... recorder 0..1 Reference(Practitioner | Patient) Who recorded the sensitivity
... note 0..1 Annotation Additional text not captured in other fields
... Slices for reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
Slice: Unordered, Open by value:system
.... reaction:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


.... reaction:SHOCK 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:RESP 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:GI 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:HEME 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:RASH 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:OTHER 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleAllergyIntoleranceSubstance/Product,ConditionAndNegationCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-code
from the FHIR Standard
AllergyIntolerance.reaction.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RESP.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:GI.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:HEME.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RASH.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore AllergyIntolerance Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... encounter 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter"
..... value[x] 1..1 Reference() Value of extension
.... enddate 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate"
..... value[x] 1..1 dateTime Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC 0..1 CodeableConcept 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
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ 0..1 code low|high
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ 1..1 CodeableConcept Identification of the allergy or intolearnce
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..5 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LabProd Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:GPI Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:DDID Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:KDC Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:SNOMED Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 0..1 Date(/time) when manifestations showed
.... onsetDateTime dateTime
.... onsetString string
... recordedDate 0..1 dateTime When recorded
... recorder 0..1 Reference(Practitioner | Patient) 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..1 Annotation Additional text not captured in other fields
... Slices for reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
Slice: Unordered, Open by value:system
.... reaction:All Slices Content/Rules for all slices
..... 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
.... reaction:SHOCK 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:RESP 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:GI 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:HEME 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:RASH 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:OTHER 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.typerequiredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleAllergyIntoleranceSubstance/Product,ConditionAndNegationCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-code
from the FHIR Standard
AllergyIntolerance.reaction.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:RESP.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:RESP.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RESP.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:RESP.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:GI.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:GI.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:GI.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:GI.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:HEME.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:HEME.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:HEME.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:HEME.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:RASH.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:RASH.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RASH.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:RASH.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements(25 nested mandatory elements)
Must-Support: 6 elements
Fixed: 9 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.meta.profile
  • The element 1 is sliced based on the value of AllergyIntolerance.meta.security
  • The element 1 is sliced based on the value of AllergyIntolerance.code.coding
  • The element 1 is sliced based on the value of AllergyIntolerance.reaction

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
... id S 1..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore AllergyIntolerance Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
..... profile:Athena Allergy Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..2 Coding Tags applied to this resource
... Slices for extension Content/Rules for all slices
.... encounter 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter"
..... value[x] 1..1 Reference() Value of extension
.... enddate 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate"
..... value[x] 1..1 dateTime Value of extension
... clinicalStatus S 0..1 CodeableConcept active | inactive | resolved
... verificationStatus S 0..1 CodeableConcept refuted | entered-in-error
... category 0..* code food | medication | environment
... criticality 0..1 code low|high
... code 1..1 CodeableConcept Identification of the allergy or intolearnce
.... Slices for coding 0..5 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LabProd 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code 1..1 code Symbol in syntax defined by the system
..... coding:GPI 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code 1..1 code Symbol in syntax defined by the system
..... coding:DDID 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code 1..1 code Symbol in syntax defined by the system
..... coding:KDC 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code 1..1 code Symbol in syntax defined by the system
..... coding:SNOMED 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
..... coding:RXNORM 0..1 Coding Code defined by a terminology system
.... text 0..1 string Plain text representation of the concept
... patient S 1..1 Reference(Patient) Who the sensitivity is for
... onset[x] 0..1 Date(/time) when manifestations showed
.... onsetDateTime dateTime
.... onsetString string
... recordedDate 0..1 dateTime When recorded
... recorder 0..1 Reference(Practitioner | Patient) Who recorded the sensitivity
... note 0..1 Annotation Additional text not captured in other fields
... Slices for reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
Slice: Unordered, Open by value:system
.... reaction:SHOCK 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:RESP 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:GI 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:HEME 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:RASH 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system
.... reaction:OTHER 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
...... coding 0..1 Coding Code defined by a terminology system

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore AllergyIntolerance Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... encounter 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter"
..... value[x] 1..1 Reference() Value of extension
.... enddate 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate"
..... value[x] 1..1 dateTime Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC 0..1 CodeableConcept refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... category Σ 0..* code food | medication | environment
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ 0..1 code low|high
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ 1..1 CodeableConcept Identification of the allergy or intolearnce
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

.... Slices for coding Σ 0..5 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LabProd Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:GPI Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:DDID Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:KDC Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:SNOMED Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... onset[x] 0..1 Date(/time) when manifestations showed
.... onsetDateTime dateTime
.... onsetString string
... recordedDate 0..1 dateTime When recorded
... recorder 0..1 Reference(Practitioner | Patient) Who recorded the sensitivity
... note 0..1 Annotation Additional text not captured in other fields
... Slices for reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
Slice: Unordered, Open by value:system
.... reaction:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


.... reaction:SHOCK 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:RESP 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:GI 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:HEME 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:RASH 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system
.... reaction:OTHER 0..1 BackboneElement Adverse Reaction Events linked to exposure to substance
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.


...... coding Σ 0..1 Coding Code defined by a terminology system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleAllergyIntoleranceSubstance/Product,ConditionAndNegationCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-code
from the FHIR Standard
AllergyIntolerance.reaction.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RESP.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:GI.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:HEME.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RASH.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore AllergyIntolerance Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... encounter 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-encounter"
..... value[x] 1..1 Reference() Value of extension
.... enddate 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-enddate"
..... value[x] 1..1 dateTime Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC 0..1 CodeableConcept 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
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ 0..1 code low|high
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ 1..1 CodeableConcept Identification of the allergy or intolearnce
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..5 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LabProd Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:GPI Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:DDID Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:KDC Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:SNOMED Σ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 0..1 Date(/time) when manifestations showed
.... onsetDateTime dateTime
.... onsetString string
... recordedDate 0..1 dateTime When recorded
... recorder 0..1 Reference(Practitioner | Patient) 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..1 Annotation Additional text not captured in other fields
... Slices for reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
Slice: Unordered, Open by value:system
.... reaction:All Slices Content/Rules for all slices
..... 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
.... reaction:SHOCK 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:RESP 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:GI 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:HEME 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:RASH 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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
.... reaction:OTHER 0..1 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.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AllergyIntolerance.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.typerequiredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleAllergyIntoleranceSubstance/Product,ConditionAndNegationCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-code
from the FHIR Standard
AllergyIntolerance.reaction.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:SHOCK.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:RESP.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:RESP.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RESP.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:RESP.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:GI.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:GI.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:GI.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:GI.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:HEME.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:HEME.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:HEME.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:HEME.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:RASH.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:RASH.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:RASH.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:RASH.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.manifestationexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction:OTHER.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements(25 nested mandatory elements)
Must-Support: 6 elements
Fixed: 9 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.meta.profile
  • The element 1 is sliced based on the value of AllergyIntolerance.meta.security
  • The element 1 is sliced based on the value of AllergyIntolerance.code.coding
  • The element 1 is sliced based on the value of AllergyIntolerance.reaction

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for AllergyIntolerance resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/AllergyIntolerance?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results AllergyIntolerance resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
patient (reference) Who the sensitivity is for
identifier (token) A practitioner's Identifier
_lastUpdated (date)
_lastUpdated-fromnow (quantity) Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
_security (token)
_tag (token)
category (token) food | medication | environment | biologic
clinical-status (token) active | inactive | resolved
code (token) Code that identifies the allergy or intolerance
criticality (token) low | high | unable-to-assess
date (date) Date first version of the resource instance was recorded
date-fromnow (quantity) Like date except expressed as a positive or negative offset from the current time in units of time, e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
encounter (reference) Encounter created as part of
encounter-hostorical (reference) Encounter or historical encounter created as part of
enddate (date) Date first version of the resource instance was recorded
enddate-fromnow (quantity) Like enddate except expressed as a positive or negative offset from the current time in units of time, e.g. enddate-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
manifestation (token) Clinical symptoms/signs associated with the Event
recorder (reference) Who recorded the sensitivity
start (date) Date first version of the resource instance was recorded
start-fromnow (quantity) Like start except expressed as a positive or negative offset from the current time in units of time, e.g. start-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
verification-status (token) refuted | entered-in-error
onset-or-approximate (string) Onset as string when manifestations showed
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.