Release
4
5
Clinical
Summary
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Patient Care Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Patient , Practitioner , RelatedPerson |
Raw JSON ( canonical form + also see JSON Format Specification )
A typical Food Allergy
{
"resourceType": "AllergyIntolerance",
"id": "example",
"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 <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code 'active' = 'Active', given as 'Active'})</span></p><p><b>verificationStatus</b>: Confirmed <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code 'confirmed' = 'Confirmed', given as 'Confirmed'})</span></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>recordedDate</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' = 'cashew nut allergenic extract Injectable Product', 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>"
"resourceType" : "AllergyIntolerance",
"id" : "example",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: AllergyIntolerance</b><a name=\"example\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource AllergyIntolerance "example" </p></div><p><b>identifier</b>: <span title=\" an identifier used for this allergic propensity (adverse reaction risk) \">id:\u00a049476534</span></p><p><b>clinicalStatus</b>: <span title=\" this individual has had several reactions \">Active <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-allergyintolerance-clinical.html\">AllergyIntolerance Clinical Status Codes</a>#active)</span></span></p><p><b>verificationStatus</b>: Confirmed <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-allergyintolerance-verification.html\">AllergyIntolerance Verification Status</a>#confirmed)</span></p><p><b>type</b>: <span title=\" note: it's often unknown whether an allergy is mediated by an immune response, and not as significant as once thought \">Allergy <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-allergy-intolerance-type.html\">Allergy Intolerance Type</a>#allergy)</span></span></p><p><b>category</b>: <span title=\" this categorization is implied by "cashew nut" and therefore basically \n redundant, but many systems collect this field anyway, since it's either \n useful when the substance is not coded, or it's quicker to sort/filter on\n than using terminology based reasoning \">food</span></p><p><b>criticality</b>: <span title=\" there is no question that the allergy is real and serious \">high</span></p><p><b>code</b>: <span title=\" Allergy or intolerance code (substance, product, condition or negated/excluded statement) or text. A few times, \n there's a full description of a complex substance/product - in these caes, use the\n extension [url] to refer to a Substance resource. \">Cashew nuts <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#227493005)</span></span></p><p><b>patient</b>: <span title=\" the patient that actually has the risk of adverse reaction \"><a href=\"patient-example.html\">Patient/example</a> "Peter CHALMERS"</span></p><p><b>onset</b>: <span title=\" when the allergy was first noted (in this case the same as reaction.onset of the first occurrence) \">2004</span></p><p><b>recordedDate</b>: <span title=\" the date that this entry was recorded \">2014-10-09T14:58:00+11:00</span></p><blockquote><p><b>participant</b></p><p><b>function</b>: Author <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-provenance-participant-type.html\">Provenance participant type</a>#author)</span></p><p><b>actor</b>: <a href=\"practitioner-example.html\">Practitioner/example</a> "Adam CAREFUL"</p></blockquote><blockquote><p><b>participant</b></p><p><b>function</b>: Informant <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-provenance-participant-type.html\">Provenance participant type</a>#informant)</span></p><p><b>actor</b>: <a href=\"patient-example.html\">Patient/example</a> "Peter CHALMERS"</p></blockquote><p><b>lastOccurrence</b>: <span title=\" last happened June 2012. Typically, systems either track lastOccurrence,\n or a list of events. \">2012-06</span></p><p><b>note</b>: <span title=\" an additional note about the allergy propensity by the recorder \">The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.</span></p><blockquote><p><b>reaction</b></p><p><b>substance</b>: <span title=\" \n It's possible to list specific things to which the patient responded,\n e.g. chocolate (that happened to contain cashew nuts). This event has\n such a specific substance. Note that systems should ensure that what\n goes in here does not conflict with the substance above, and systems\n processing the data can be sure that what is here does not contravene\n the substance above\n \">cashew nut allergenic extract Injectable Product <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-rxNorm.html\">RxNorm</a>#1160593)</span></span></p><h3>Manifestations</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>Anaphylactic reaction <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#39579001)</span></td></tr></table><p><b>description</b>: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered</p><p><b>onset</b>: 2012-06-12</p><p><b>severity</b>: severe</p><p><b>exposureRoute</b>: Subcutaneous route <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#34206005)</span></p></blockquote><blockquote><p><b>reaction</b></p><h3>Manifestations</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>Urticaria <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#64305001)</span></td></tr></table><p><b>onset</b>: 2004</p><p><b>severity</b>: moderate</p><p><b>note</b>: <span title=\" an additional note about the reaction by the recorder \">The patient reports that the onset of urticaria was within 15 minutes of eating cashews.</span></p></blockquote></div>"
},
"identifier": [
{
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
}
],
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active",
"display": "Active"
}
]
"identifier" : [{
"system" : "http://acme.com/ids/patients/risks",
"value" : "49476534"
}],
"clinicalStatus" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code" : "active",
"display" : "Active"
}]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed",
"display": "Confirmed"
}
]
"verificationStatus" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code" : "confirmed",
"display" : "Confirmed"
}]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "high",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "227493005",
"display": "Cashew nuts"
}
]
"type" : {
"coding" : [{
"system" : "http://hl7.org/fhir/allergy-intolerance-type",
"code" : "allergy",
"display" : "Allergy"
}]
},
"patient": {
"reference": "Patient/example"
"category" : ["food"],
"criticality" : "high",
"code" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "227493005",
"display" : "Cashew nuts"
}]
},
"onsetDateTime": "2004",
"recordedDate": "2014-10-09T14:58:00+11:00",
"recorder": {
"reference": "Practitioner/example"
"patient" : {
"reference" : "Patient/example"
},
"asserter": {
"reference": "Patient/example"
"onsetDateTime" : "2004",
"recordedDate" : "2014-10-09T14:58:00+11:00",
"participant" : [{
"function" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code" : "author",
"display" : "Author"
}]
},
"actor" : {
"reference" : "Practitioner/example"
}
},
"lastOccurrence": "2012-06",
"note": [
{
"text": "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract."
{
"function" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code" : "informant",
"display" : "Informant"
}]
},
"actor" : {
"reference" : "Patient/example"
}
],
"reaction": [
{
"substance": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1160593",
"display": "cashew nut allergenic extract Injectable Product"
}
]
},
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39579001",
"display": "Anaphylactic reaction"
}
]
}
],
"description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered",
"onset": "2012-06-12",
"severity": "severe",
"exposureRoute": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "34206005",
"display": "Subcutaneous route"
}
]
}
}],
"lastOccurrence" : "2012-06",
"note" : [{
"text" : "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract."
}],
"reaction" : [{
"substance" : {
"coding" : [{
"system" : "http://www.nlm.nih.gov/research/umls/rxnorm",
"code" : "1160593",
"display" : "cashew nut allergenic extract Injectable Product"
}]
},
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "64305001",
"display": "Urticaria"
}
]
}
],
"onset": "2004",
"severity": "moderate",
"note": [
{
"text": "The patient reports that the onset of urticaria was within 15 minutes of eating cashews."
}
]
"manifestation" : [{
"concept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "39579001",
"display" : "Anaphylactic reaction"
}]
}
}],
"description" : "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered",
"onset" : "2012-06-12",
"severity" : "severe",
"exposureRoute" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "34206005",
"display" : "Subcutaneous route"
}]
}
]
},
{
"manifestation" : [{
"concept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "64305001",
"display" : "Urticaria"
}]
}
}],
"onset" : "2004",
"severity" : "moderate",
"note" : [{
"text" : "The patient reports that the onset of urticaria was within 15 minutes of eating cashews."
}]
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
hl7.fhir.core#5.0.0
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Sun,
Mar
26,
2023
15:24+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change