Clinical
Summary
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
v6.0.0-ballot4:
Release
6
Ballot
(1st
Full
Ballot)
(see
Ballot
Notes
)
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
for
published
versions
| Responsible Owner: Patient Care Work Group | Standards Status : Informative | Compartments : Patient , Practitioner , RelatedPerson |
Raw Turtle (+ also see Turtle/RDF Format Specification )
A typical Food Allergy
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix sct: <http://snomed.info/id/> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource -------------------------------------------------------------------<http://hl7.org/fhir/AllergyIntolerance/example> a fhir:AllergyIntolerance; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "example"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.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>" ]; fhir:AllergyIntolerance.identifier [ fhir:index 0; fhir:Identifier.system [ fhir:value "http://acme.com/ids/patients/risks" ]; fhir:Identifier.value [ fhir:value "49476534" ] ]; fhir:AllergyIntolerance.clinicalStatus [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" ]; fhir:Coding.code [ fhir:value "active" ]; fhir:Coding.display [ fhir:value "Active" ] ] ]; fhir:AllergyIntolerance.verificationStatus [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" ]; fhir:Coding.code [ fhir:value "confirmed" ]; fhir:Coding.display [ fhir:value "Confirmed" ] ] ]; fhir:AllergyIntolerance.type [ fhir:value "allergy"]; fhir:AllergyIntolerance.category [ fhir:value "food"; fhir:index 0 ]; fhir:AllergyIntolerance.criticality [ fhir:value "high"]; fhir:AllergyIntolerance.code [ fhir:CodeableConcept.coding [ fhir:index 0; a sct:227493005; fhir:Coding.system [ fhir:value "http://snomed.info/sct" ]; fhir:Coding.code [ fhir:value "227493005" ]; fhir:Coding.display [ fhir:value "Cashew nuts" ] ] ]; fhir:AllergyIntolerance.patient [ fhir:link <http://hl7.org/fhir/Patient/example>; fhir:Reference.reference [ fhir:value "Patient/example" ] ]; fhir:AllergyIntolerance.onsetDateTime [ fhir:value "2004"^^xsd:gYear]; fhir:AllergyIntolerance.recordedDate [ fhir:value "2014-10-09T14:58:00+11:00"^^xsd:dateTime]; fhir:AllergyIntolerance.recorder [ fhir:link <http://hl7.org/fhir/Practitioner/example>; fhir:Reference.reference [ fhir:value "Practitioner/example" ] ]; fhir:AllergyIntolerance.asserter [ fhir:link <http://hl7.org/fhir/Patient/example>; fhir:Reference.reference [ fhir:value "Patient/example" ] ]; fhir:AllergyIntolerance.lastOccurrence [ fhir:value "2012-06"^^xsd:gYearMonth]; fhir:AllergyIntolerance.note [ fhir:index 0; fhir:Annotation.text [ fhir:value "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract." ] ]; fhir:AllergyIntolerance.reaction [ fhir:index 0; fhir:AllergyIntolerance.reaction.substance [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://www.nlm.nih.gov/research/umls/rxnorm" ]; fhir:Coding.code [ fhir:value "1160593" ]; fhir:Coding.display [ fhir:value "cashew nut allergenic extract Injectable Product" ] ] ]; fhir:AllergyIntolerance.reaction.manifestation [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; a sct:39579001; fhir:Coding.system [ fhir:value "http://snomed.info/sct" ]; fhir:Coding.code [ fhir:value "39579001" ]; fhir:Coding.display [ fhir:value "Anaphylactic reaction" ] ] ]; fhir:AllergyIntolerance.reaction.description [ fhir:value "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered" ]; fhir:AllergyIntolerance.reaction.onset [ fhir:value "2012-06-12"^^xsd:date ]; fhir:AllergyIntolerance.reaction.severity [ fhir:value "severe" ]; fhir:AllergyIntolerance.reaction.exposureRoute [ fhir:CodeableConcept.coding [ fhir:index 0; a sct:34206005; fhir:Coding.system [ fhir:value "http://snomed.info/sct" ]; fhir:Coding.code [ fhir:value "34206005" ]; fhir:Coding.display [ fhir:value "Subcutaneous route" ]<http://hl7.org/fhir/AllergyIntolerance/example> a fhir:AllergyIntolerance ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "example"] ; # fhir:identifier ( [ fhir:system [ fhir:v "http://acme.com/ids/patients/risks"^^xsd:anyURI ; fhir:l <http://acme.com/ids/patients/risks> ] ; fhir:value [ fhir:v "49476534" ] ] ) ; # an identifier used for this allergic propensity (adverse reaction risk) fhir:clinicalStatus [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical"^^xsd:anyURI ; fhir:l <http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical> ] ; fhir:code [ fhir:v "active" ] ; fhir:display [ fhir:v "Active" ] ] ) ] ; # this individual has had several reactions fhir:verificationStatus [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification"^^xsd:anyURI ; fhir:l <http://terminology.hl7.org/CodeSystem/allergyintolerance-verification> ] ; fhir:code [ fhir:v "confirmed" ] ; fhir:display [ fhir:v "Confirmed" ] ] ) ] ; # fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/allergy-intolerance-type"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/allergy-intolerance-type> ] ; fhir:code [ fhir:v "allergy" ] ; fhir:display [ fhir:v "Allergy" ] ] ) ] ; # note: it's often unknown whether an allergy is mediated by an immune response, and not as significant as once thought fhir:category ( [ fhir:v "food"] ) ; # 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 fhir:criticality [ fhir:v "high"] ; # there is no question that the allergy is real and serious fhir:code [ fhir:coding ( [ a sct:227493005 ; fhir:system [ fhir:v "http://snomed.info/sct"^^xsd:anyURI ; fhir:l <http://snomed.info/sct> ] ; fhir:code [ fhir:v "227493005" ] ; fhir:display [ fhir:v "Cashew nuts" ] ] ) ] ; # 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. fhir:patient [ fhir:l <http://hl7.org/fhir/Patient/example> ; fhir:reference [ fhir:v "Patient/example" ] ] ; # the patient that actually has the risk of adverse reaction fhir:onset [ a fhir:DateTime ; fhir:v "2004"^^xsd:gYear ] ; # when the allergy was first noted (in this case the same as reaction.onset of the first occurrence) fhir:recordedDate [ fhir:v "2014-10-09T14:58:00+11:00"^^xsd:dateTime] ; # the date that this entry was recorded fhir:recorder [ fhir:l <http://hl7.org/fhir/Practitioner/example> ; fhir:reference [ fhir:v "Practitioner/example" ] ] ; # who made the record / last updated it fhir:asserter [ fhir:l <http://hl7.org/fhir/Patient/example> ; fhir:reference [ fhir:v "Patient/example" ] ] ; # the patient is the reporter in this case fhir:note ( [ fhir:text [ fhir:v "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract." ] ] ) ; # an additional note about the allergy propensity by the recorder fhir:reaction ( [ fhir:substance [ fhir:coding ( [ fhir:system [ fhir:v "http://www.nlm.nih.gov/research/umls/rxnorm"^^xsd:anyURI ; fhir:l <http://www.nlm.nih.gov/research/umls/rxnorm> ] ; fhir:code [ fhir:v "1160593" ] ; fhir:display [ fhir:v "cashew nut allergenic extract Injectable Product" ] ] ) ] ; # \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 fhir:manifestation ( [ fhir:concept [ fhir:coding ( [ a sct:39579001 ; fhir:system [ fhir:v "http://snomed.info/sct"^^xsd:anyURI ; fhir:l <http://snomed.info/sct> ] ; fhir:code [ fhir:v "39579001" ] ; fhir:display [ fhir:v "Anaphylactic reaction" ] ] ) ] ] ) ; fhir:description [ fhir:v "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered" ] ; fhir:onset [ fhir:v "2012-06-12"^^xsd:date ] ; fhir:severity [ fhir:v "severe" ] ; fhir:exposureRoute [ fhir:coding ( [ a sct:34206005 ; fhir:system [ fhir:v "http://snomed.info/sct"^^xsd:anyURI ; fhir:l <http://snomed.info/sct> ] ; fhir:code [ fhir:v "34206005" ] ; fhir:display [ fhir:v "Subcutaneous route" ] ] ) ]], [ fhir:index 1; fhir:AllergyIntolerance.reaction.manifestation [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; a sct:64305001; fhir:Coding.system [ fhir:value "http://snomed.info/sct" ]; fhir:Coding.code [ fhir:value "64305001" ]; fhir:Coding.display [ fhir:value "Urticaria" ]] [ fhir:manifestation ( [ fhir:concept [ fhir:coding ( [ a sct:64305001 ; fhir:system [ fhir:v "http://snomed.info/sct"^^xsd:anyURI ; fhir:l <http://snomed.info/sct> ] ; fhir:code [ fhir:v "64305001" ] ; fhir:display [ fhir:v "Urticaria" ] ] ) ]]; fhir:AllergyIntolerance.reaction.onset [ fhir:value "2004"^^xsd:gYear ]; fhir:AllergyIntolerance.reaction.severity [ fhir:value "moderate" ]; fhir:AllergyIntolerance.reaction.note [ fhir:index 0; fhir:Annotation.text [ fhir:value "The patient reports that the onset of urticaria was within 15 minutes of eating cashews." ] ] ] .] ) ; fhir:onset [ fhir:v "2004"^^xsd:gYear ] ; fhir:severity [ fhir:v "moderate" ] ; fhir:note ( [ fhir:text [ fhir:v "The patient reports that the onset of urticaria was within 15 minutes of eating cashews." ] ] ) # an additional note about the reaction by the recorder ] ) . # past events. There's no claim that this is all the events, and # that should not be assumed <http://hl7.org/fhir/Patient/example> a fhir:Patient . <http://hl7.org/fhir/Practitioner/example> a fhir:Practitioner .# - ontology header ------------------------------------------------------------ <http://hl7.org/fhir/AllergyIntolerance/example.ttl> a owl:Ontology; owl:imports fhir:fhir.ttl; owl:versionIRI <http://build.fhir.org/AllergyIntolerance/example.ttl> .# -------------------------------------------------------------------------------------
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-ballot4
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Thu,
Dec
18,
2025
07:11+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change