This
page
is
part
of
the
FHIR
Specification
(v3.3.0:
(v3.5.0:
R4
Ballot
2).
#2).
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 | Ballot 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://hl7.org/fhir/vaccination-protocol-dose-status code 'notvalid' = 'notvalid', given as 'Not Valid'})</span></p><p><b>doseStatusReason</b>: Administered outside recommended schedule <span>(Details : {http://hl7.org/fhir/vaccination-protocol-dose-status-reason code 'outsidesched' = 'outsidesched', 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>"
"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>"
},
"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"
},
"targetDisease": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1857005"
}
]
}
],
"targetDisease": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1857005"
}
]
},
"immunizationEvent": {
"reference": "Immunization/example"
},
"doseStatus": {
"coding": [
{
"system": "http://hl7.org/fhir/vaccination-protocol-dose-status",
"system": "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status",
"code": "notvalid",
"display": "Not Valid"
}
]
},
"doseStatusReason": [
{
"coding": [
{
"system": "http://hl7.org/fhir/vaccination-protocol-dose-status-reason",
"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
}
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.