Medications
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
|
Responsible
Owner:
Public
Health
|
Standards Status : Informative | Compartments : Patient , Practitioner |
Raw JSON ( canonical form + also see JSON Format Specification )
Example where the provider indicates the protocol being followed
{
"resourceType": "Immunization",
"id": "protocol",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: protocol</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>vaccineCode</b>: Twinrix (HepA/HepB) <span>(Details : {http://hl7.org/fhir/sid/cvx code '104' = 'Hep A-Hep B)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 18/06/2018</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>lotNumber</b>: PT123F</p><p><b>expirationDate</b>: 15/12/2018</p><p><b>site</b>: left arm <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code 'LA' = 'left arm', given as 'left arm'})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code 'IM' = 'Injection, intramuscular', given as 'Injection, intramuscular'})</span></p><p><b>doseQuantity</b>: 5 mg<span> (Details: UCUM code mg = 'mg')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'OP' = 'Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'AP' = 'Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>isSubpotent</b>: false</p><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code 'ineligible' = 'Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code 'private' = 'Private)</span></p><blockquote><p><b>protocolApplied</b></p><p><b>series</b>: 2-dose</p><p><b>targetDisease</b>: Viral hepatitis, type A <span>(Details : {SNOMED CT code '40468003' = 'Viral hepatitis, type A)</span></p><p><b>doseNumber</b>: 1</p></blockquote><blockquote><p><b>protocolApplied</b></p><p><b>series</b>: 3-dose</p><p><b>targetDisease</b>: Type B viral hepatitis <span>(Details : {SNOMED CT code '66071002' = 'Type B viral hepatitis)</span></p><p><b>doseNumber</b>: 2</p></blockquote></div>"
"resourceType" : "Immunization",
"id" : "protocol",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}],
"status" : "completed",
"vaccineCode" : {
"coding" : [{
"system" : "http://hl7.org/fhir/sid/cvx",
"code" : "104"
}],
"text" : "Twinrix (HepA/HepB)"
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
"manufacturer" : {
"reference" : {
"reference" : "Organization/hl7"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "104"
}
],
"text": "Twinrix (HepA/HepB)"
},
"patient": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
"lotNumber" : "PT123F",
"expirationDate" : "2018-12-15",
"patient" : {
"reference" : "Patient/example"
},
"occurrenceDateTime": "2018-06-18",
"primarySource": true,
"location": {
"reference": "Location/1"
"encounter" : {
"reference" : "Encounter/example"
},
"manufacturer": {
"reference": "Organization/hl7"
"occurrenceDateTime" : "2018-06-18",
"primarySource" : true,
"location" : {
"reference" : "Location/1"
},
"lotNumber": "PT123F",
"expirationDate": "2018-12-15",
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
"code": "LA",
"display": "left arm"
}
]
"site" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActSite",
"code" : "LA",
"display" : "left arm"
}]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
"code": "IM",
"display": "Injection, intramuscular"
}
]
"route" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
"code" : "IM",
"display" : "Injection, intramuscular"
}]
},
"doseQuantity": {
"value": 5,
"system": "http://unitsofmeasure.org",
"code": "mg"
"doseQuantity" : {
"value" : 5,
"system" : "http://unitsofmeasure.org",
"code" : "mg"
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "OP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
"performer" : [{
"function" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0443",
"code" : "OP"
}]
},
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
],
"isSubpotent": false,
"programEligibility": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
"code": "ineligible"
}
]
"actor" : {
"reference" : "Practitioner/example"
}
],
"fundingSource": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
"code": "private"
}
]
},
"protocolApplied": [
{
"series": "2-dose",
"targetDisease": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "40468003"
}
]
}
],
"doseNumberPositiveInt": 1
{
"function" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0443",
"code" : "AP"
}]
},
{
"series": "3-dose",
"targetDisease": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "66071002"
}
]
}
],
"doseNumberPositiveInt": 2
"actor" : {
"reference" : "Practitioner/example"
}
]
}],
"isSubpotent" : false,
"programEligibility" : [{
"program" : {
"text" : "VFC"
},
"programStatus" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
"code" : "ineligible"
}]
}
}],
"fundingSource" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
"code" : "private"
}]
},
"protocolApplied" : [{
"series" : "2-dose",
"targetDisease" : [{
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "40468003"
}]
}]
},
{
"series" : "3-dose",
"targetDisease" : [{
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "66071002"
}]
}]
}]
}
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,
Nov
1,
2019
09:35+1100.
QA
Page
7,
2025
18:58+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