Clinical
Summary
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Responsible Owner: Patient Care Work Group | Standards Status : Informative | Compartments : Patient , Practitioner , RelatedPerson |
Raw XML ( canonical form + also see XML Format Specification )
A typical Food Allergy (id = "example")
<?xml version="1.0" encoding="UTF-8"?>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code 'active' = 'Active', given as 'Active'})(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code 'confirmed' = 'Confirmed', given as 'Confirmed'}): The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.(Details : {RxNorm code '1160593' = 'cashew nut allergenic extract Injectable Product', given as 'cashew nut allergenic extract Injectable Product'}) <!-- note: it's often unknown whether an allergy is mediated by an immune response, and not as significant as once thought --> <!-- this categorization is implied by "cashew nut" and therefore basically redundant, but many systems collect this field anyway, since it's either useful when the substance is not coded, or it's quicker to sort/filter on than using terminology based reasoning --> <!-- Allergy or intolerance code (substance, product, condition or negated/excluded statement) or text. A few times, there's a full description of a complex substance/product - in these caes, use the extension [url] to refer to a Substance resource. --> <!-- when the allergy was first noted (in this case the same as reaction.onset of the first occurrence) --> <!-- last happened June 2012. Typically, systems either track lastOccurrence, or a list of events. --><AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="example"/> <!-- an identifier used for this allergic propensity (adverse reaction risk) --> <identifier> <system value="http://acme.com/ids/patients/risks"/> <value value="49476534"/> </identifier> <!-- this individual has had several reactions --> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical"/> <code value="active"/> <display value="Active"/> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification"/> <code value="confirmed"/> <display value="Confirmed"/> </coding> </verificationStatus> <!-- note: it's often unknown whether an allergy is mediated by an immune response, and not as significant as once thought --> <type> <coding> <system value="http://hl7.org/fhir/allergy-intolerance-type"/> <code value="allergy"/> <display value="Allergy"/> </coding> </type> <!-- this categorization is implied by "cashew nut" and therefore basically redundant, but many systems collect this field anyway, since it's either useful when the substance is not coded, or it's quicker to sort/filter on than using terminology based reasoning --> <category value="food"/> <!-- there is no question that the allergy is real and serious --> <criticality value="high"/> <!-- Allergy or intolerance code (substance, product, condition or negated/excluded statement) or text. A few times, there's a full description of a complex substance/product - in these caes, use the extension [url] to refer to a Substance resource. --> <code> <coding> <system value="http://snomed.info/sct"/> <code value="227493005"/> <display value="Cashew nuts"/> </coding> </code> <!-- the patient that actually has the risk of adverse reaction --> <patient> <reference value="Patient/example"/> </patient> <!-- when the allergy was first noted (in this case the same as reaction.onset of the first occurrence) --> <onsetDateTime value="2004"/> <!-- the date that this entry was recorded --> <recordedDate value="2014-10-09T14:58:00+11:00"/> <!-- who made the record / last updated it --> <recorder> <reference value="Practitioner/example"/> </recorder> <!-- the patient is the reporter in this case --> <asserter> <reference value="Patient/example"/> </asserter> <!-- an additional note about the allergy propensity by the recorder --> <note> <text value="The criticality is high becasue of the observed anaphylactic reaction when challengedwith cashew extract. <!-- past events. There's no claim that this is all the events, and that should not be assumed --> <!-- It's possible to list specific things to which the patient responded, e.g. chocolate (that happened to contain cashew nuts). This event has such a specific substance. Note that systems should ensure that what goes in here does not conflict with the substance above, and systems processing the data can be sure that what is here does not contravene the substance above -->with cashew extract."/> </note> <!-- past events. There's no claim that this is all the events, and that should not be assumed --> <reaction> <!-- It's possible to list specific things to which the patient responded, e.g. chocolate (that happened to contain cashew nuts). This event has such a specific substance. Note that systems should ensure that what goes in here does not conflict with the substance above, and systems processing the data can be sure that what is here does not contravene the substance above --> <substance> <coding> <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/> <code value="1160593"/> <display value="cashew nut allergenic extract Injectable Product"/> </coding> </substance> <manifestation> <concept> <coding> <system value="http://snomed.info/sct"/> <code value="39579001"/> <display value="Anaphylactic reaction"/> </coding> </concept> </manifestation> <description value="Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered"/> <onset value="2012-06-12"/> <severity value="severe"/> <exposureRoute> <coding> <system value="http://snomed.info/sct"/> <code value="34206005"/> <display value="Subcutaneous route"/> </coding> </exposureRoute> </reaction> <!-- this was the first occurrence --> <reaction> <manifestation> <concept> <coding> <system value="http://snomed.info/sct"/> <code value="64305001"/> <display value="Urticaria"/> </coding> </concept> </manifestation> <onset value="2004"/> <severity value="moderate"/> <!-- an additional note about the reaction by the recorder --> <note> <text value="The patient reports that the onset of urticaria was within 15 minutes of eating cashews."/> </note> </reaction> </ AllergyIntolerance >
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)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Sat,
Nov
1,
2019
09:34+1100.
QA
Page
8,
2025
17:18+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change