Medications
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
| Public Health and Emergency Response Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Patient |
Raw JSON ( canonical form + also see JSON Format Specification )
Example of an invalid dose
{
"resourceType": "ImmunizationEvaluation",
"id": "notValid",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: notValid</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>patient</b>: <a>Patient/example</a></p><p><b>date</b>: 10/01/2013</p><p><b>authority</b>: <a>Organization/hl7</a></p><p><b>targetDisease</b>: Gestational rubella syndrome <span>(Details : {SNOMED CT code '1857005' = 'Gestational rubella syndrome)</span></p><p><b>immunizationEvent</b>: <a>Immunization/example</a></p><p><b>doseStatus</b>: Not Valid <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status code 'notvalid' = 'Not valid', given as 'Not Valid'})</span></p><p><b>doseStatusReason</b>: Administered outside recommended schedule <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status-reason code 'outsidesched' = 'Administered outside recommended schedule', given as 'Administered outside recommended schedule'})</span></p><p><b>series</b>: Vaccination Series 1</p><p><b>doseNumber</b>: 2</p><p><b>seriesDoses</b>: 3</p></div>"
"resourceType" : "ImmunizationEvaluation",
"id" : "notValid",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: ImmunizationEvaluation</b><a name=\"notValid\"> </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 ImmunizationEvaluation "notValid" </p></div><p><b>identifier</b>: id:\u00a0urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>patient</b>: <a href=\"patient-example.html\">Patient/example</a> "Peter CHALMERS"</p><p><b>date</b>: 2013-01-10</p><p><b>authority</b>: <a href=\"organization-example.html\">Organization/hl7</a> "Health Level Seven International"</p><p><b>targetDisease</b>: Gestational rubella syndrome <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#1857005)</span></p><p><b>immunizationEvent</b>: <a href=\"immunization-example.html\">Immunization/example</a></p><p><b>doseStatus</b>: Not Valid <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-immunization-evaluation-dose-status.html\">Immunization Evaluation Dose Status codes</a>#notvalid)</span></p><p><b>doseStatusReason</b>: Outside Schedule <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-immunization-evaluation-dose-status-reason.html\">Immunization Evaluation Dose Status Reason codes</a>#outsideschedule)</span></p><p><b>series</b>: Vaccination Series 1</p></div>"
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
],
"status": "completed",
"patient": {
"reference": "Patient/example"
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}],
"status" : "completed",
"patient" : {
"reference" : "Patient/example"
},
"date": "2013-01-10",
"authority": {
"reference": "Organization/hl7"
"date" : "2013-01-10",
"authority" : {
"reference" : "Organization/hl7"
},
"targetDisease": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1857005"
}
]
"targetDisease" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "1857005"
}]
},
"immunizationEvent": {
"reference": "Immunization/example"
"immunizationEvent" : {
"reference" : "Immunization/example"
},
"doseStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status",
"code": "notvalid",
"display": "Not Valid"
}
]
"doseStatus" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status",
"code" : "notvalid",
"display" : "Not Valid"
}]
},
"doseStatusReason": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status-reason",
"code": "outsidesched",
"display": "Administered outside recommended schedule"
}
]
}
],
"series": "Vaccination Series 1",
"doseNumberPositiveInt": 2,
"seriesDosesPositiveInt": 3
"doseStatusReason" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status-reason",
"code" : "outsideschedule",
"display" : "Outside Schedule"
}]
}],
"series" : "Vaccination Series 1"
}
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:35+1100.
QA
Page
Sun,
Mar
26,
2023
15:25+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change