AllergyIntolerance - FHIR Resource (stu3)
This AllergyIntolerance Resource uses the FHIR API standard for access and structure.
Validate an AllergyIntolerance FHIR Resource (stu3)
AllergyIntolerance Attributes
AttributeField is listTypeDescription
Description: food | medication | environment | biologic
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
"food"
]Learn more about the (AllergyIntolerance) category FHIR attribute
Description: Date record was believed accurate
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"assertedDate": "2014-10-09T14:58:00+11:00"Learn more about the (AllergyIntolerance) assertedDate FHIR attribute
Description: C? unconfirmed | confirmed | refuted | entered-in-error
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"verificationStatus": "confirmed"Learn more about the (AllergyIntolerance) verificationStatus FHIR attribute
Description: Code that identifies the allergy or intolerance
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"code": "227493005",
"system": "http://snomed.info/sct",
"display": "Cashew nuts"
}
]
}Learn more about the (AllergyIntolerance) code FHIR attribute
Description: Who the sensitivity is for
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"reference": "Patient/example"
}Learn more about the (AllergyIntolerance) patient FHIR attribute
Description: "onsetString" : "<string>",
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"onsetString": Learn more about the (AllergyIntolerance) onsetString FHIR attribute
Description: low | high | unable-to-assess
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"criticality": "high"Learn more about the (AllergyIntolerance) criticality FHIR attribute
Description: Adverse Reaction Events linked to exposure to substance
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reaction": [
{
"substance": {
"coding": [
{
"code": "1160593",
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"display": "cashew nut allergenic extract Injectable Product"
}
]
},
"severity": "severe",
"manifestation": [
{
"coding": [
{
"code": "39579001",
"system": "http://snomed.info/sct",
"display": "Anaphylactic reaction"
}
]
}
],
"onset": "2012-06-12",
"exposureRoute": {
"coding": [
{
"code": "34206005",
"system": "http://snomed.info/sct",
"display": "Subcutaneous route"
}
]
},
"description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered"
},
{
"onset": "2004",
"note": [
{
"text": "The patient reports that the onset of urticaria was within 15 minutes of eating cashews."
}
],
"severity": "moderate",
"manifestation": [
{
"coding": [
{
"code": "64305001",
"system": "http://snomed.info/sct",
"display": "Urticaria"
}
]
}
]
}
]Learn more about the (AllergyIntolerance) reaction FHIR attribute
Description: Date(/time) of last known occurrence of a reaction
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lastOccurrence": "2012-06"Learn more about the (AllergyIntolerance) lastOccurrence FHIR attribute
Description: "onsetDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"onsetDateTime": "2004"Learn more about the (AllergyIntolerance) onsetDateTime FHIR attribute
Description: C? active | inactive | resolved
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"clinicalStatus": "active"Learn more about the (AllergyIntolerance) clinicalStatus FHIR attribute
Description: Additional text not captured in other fields
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": [
{
"text": "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract."
}
]Learn more about the (AllergyIntolerance) note FHIR attribute
Description: "onsetPeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"onsetPeriod": Learn more about the (AllergyIntolerance) onsetPeriod FHIR attribute
Description: External ids for this item
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
}
]Learn more about the (AllergyIntolerance) identifier FHIR attribute
Description: "onsetRange" : { Range },
FHIR Version: stu3
Attribute Type : Range
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"onsetRange": Learn more about the (AllergyIntolerance) onsetRange FHIR attribute
Description: Who recorded the sensitivity
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recorder": {
"reference": "Practitioner/example"
}Learn more about the (AllergyIntolerance) recorder FHIR attribute
Description: Source of the information about the allergy
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"asserter": {
"reference": "Patient/example"
}Learn more about the (AllergyIntolerance) asserter FHIR attribute
Description: allergy | intolerance - Underlying mechanism (if known)
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": "allergy"Learn more about the (AllergyIntolerance) type FHIR attribute
Description: "onsetAge" : { Age },
FHIR Version: stu3
Attribute Type : Age
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"onsetAge": Learn more about the (AllergyIntolerance) onsetAge FHIR attribute
AllergyIntolerance Example
{
"category": [
"food"
],
"assertedDate": "2014-10-09T14:58:00+11:00",
"code": {
"coding": [
{
"code": "227493005",
"system": "http://snomed.info/sct",
"display": "Cashew nuts"
}
]
},
"patient": {
"reference": "Patient/example"
},
"criticality": "high",
"lastOccurrence": "2012-06",
"resourceType": "AllergyIntolerance",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 49476534</p><p><b>clinicalStatus</b>: active</p><p><b>verificationStatus</b>: confirmed</p><p><b>type</b>: allergy</p><p><b>category</b>: food</p><p><b>criticality</b>: high</p><p><b>code</b>: Cashew nuts <span>(Details : {SNOMED CT code '227493005' = 'Cashew nuts', given as 'Cashew nuts'})</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>onset</b>: 01/01/2004</p><p><b>assertedDate</b>: 09/10/2014 2:58:00 PM</p><p><b>recorder</b>: <a>Practitioner/example</a></p><p><b>asserter</b>: <a>Patient/example</a></p><p><b>lastOccurrence</b>: 01/06/2012</p><p><b>note</b>: The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.</p><blockquote><p><b>reaction</b></p><p><b>substance</b>: cashew nut allergenic extract Injectable Product <span>(Details : {RxNorm code '1160593' = '1160593', given as 'cashew nut allergenic extract Injectable Product'})</span></p><p><b>manifestation</b>: Anaphylactic reaction <span>(Details : {SNOMED CT code '39579001' = 'Anaphylaxis', given as 'Anaphylactic reaction'})</span></p><p><b>description</b>: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered</p><p><b>onset</b>: 12/06/2012</p><p><b>severity</b>: severe</p><p><b>exposureRoute</b>: Subcutaneous route <span>(Details : {SNOMED CT code '34206005' = 'Subcutaneous route', given as 'Subcutaneous route'})</span></p></blockquote><blockquote><p><b>reaction</b></p><p><b>manifestation</b>: Urticaria <span>(Details : {SNOMED CT code '64305001' = 'Urticaria', given as 'Urticaria'})</span></p><p><b>onset</b>: 01/01/2004</p><p><b>severity</b>: moderate</p><p><b>note</b>: The patient reports that the onset of urticaria was within 15 minutes of eating cashews.</p></blockquote></div>"
},
"onsetDateTime": "2004",
"id": "example",
"asserter": {
"reference": "Patient/example"
},
"note": [
{
"text": "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract."
}
],
"reaction": [
{
"substance": {
"coding": [
{
"code": "1160593",
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"display": "cashew nut allergenic extract Injectable Product"
}
]
},
"severity": "severe",
"manifestation": [
{
"coding": [
{
"code": "39579001",
"system": "http://snomed.info/sct",
"display": "Anaphylactic reaction"
}
]
}
],
"onset": "2012-06-12",
"exposureRoute": {
"coding": [
{
"code": "34206005",
"system": "http://snomed.info/sct",
"display": "Subcutaneous route"
}
]
},
"description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered"
},
{
"onset": "2004",
"note": [
{
"text": "The patient reports that the onset of urticaria was within 15 minutes of eating cashews."
}
],
"severity": "moderate",
"manifestation": [
{
"coding": [
{
"code": "64305001",
"system": "http://snomed.info/sct",
"display": "Urticaria"
}
]
}
]
}
],
"clinicalStatus": "active",
"recorder": {
"reference": "Practitioner/example"
},
"identifier": [
{
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
}
],
"type": "allergy",
"verificationStatus": "confirmed"
}AllergyIntolerance Structure
{
"resourceType" : "AllergyIntolerance",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External ids for this item
"clinicalStatus" : "<code>", // C? active | inactive | resolved
"verificationStatus" : "<code>", // C? R! unconfirmed | confirmed | refuted | entered-in-error
"type" : "<code>", // allergy | intolerance - Underlying mechanism (if known)
"category" : ["<code>"], // food | medication | environment | biologic
"criticality" : "<code>", // low | high | unable-to-assess
"code" : { CodeableConcept }, // Code that identifies the allergy or intolerance
"patient" : { Reference(Patient) }, // R! Who the sensitivity is for
// onset[x]: When allergy or intolerance was identified. One of these 5:
"onsetDateTime" : "<dateTime>",
"onsetAge" : { Age },
"onsetPeriod" : { Period },
"onsetRange" : { Range },
"onsetString" : "<string>",
"assertedDate" : "<dateTime>", // Date record was believed accurate
"recorder" : { Reference(Practitioner|Patient) }, // Who recorded the sensitivity
"asserter" : { Reference(Patient|RelatedPerson|Practitioner) }, // Source of the information about the allergy
"lastOccurrence" : "<dateTime>", // Date(/time) of last known occurrence of a reaction
"note" : [{ Annotation }], // Additional text not captured in other fields
"reaction" : [{ // Adverse Reaction Events linked to exposure to substance
"substance" : { CodeableConcept }, // Specific substance or pharmaceutical product considered to be responsible for event
"manifestation" : [{ CodeableConcept }], // R! Clinical symptoms/signs associated with the Event
"description" : "<string>", // Description of the event as a whole
"onset" : "<dateTime>", // Date(/time) when manifestations showed
"severity" : "<code>", // mild | moderate | severe (of event as a whole)
"exposureRoute" : { CodeableConcept }, // How the subject was exposed to the substance
"note" : [{ Annotation }] // Text about event not captured in other fields
}]
}
AllergyIntolerance Search Parameters
The following search parameters can be used to query AllergyIntolerance resources. Just submit them like so:
https://api.1up.health/fhir/stu3/AllergyIntolerance?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
asserter | reference | asserter |
category | text | category |
clinical-status | text | clinicalStatus |
code | text | code, reaction.substance |
criticality | text | criticality |
date | date | assertedDate |
identifier | text | identifier |
last-date | date | lastOccurrence |
manifestation | text | reaction.manifestation |
onset | date | reaction.onset |
patient | reference | patient |
recorder | reference | recorder |
route | text | reaction.exposureRoute |
severity | text | reaction.severity |
type | text | type |
verification-status | text | verificationStatus |
