Medications
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0:
R5
-
STU
).
The
This
is
the
current
published
version
which
supercedes
in
it's
permanent
home
(it
will
always
be
available
at
this
version
is
5.0.0
.
URL).
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R5
R4B
R4
| Public Health and Emergency Response Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Patient , Practitioner |
Raw Turtle (+ also see Turtle/RDF Format Specification )
Example of a Subpotent Dose
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource -------------------------------------------------------------------<http://hl7.org/fhir/Immunization/subpotent> a fhir:Immunization; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "subpotent"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></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 "subpotent" </p></div><p><b>identifier</b>: id: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Hepatitis B <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (unknown#GNHEP)</span></p><p><b>patient</b>: <a href=\"patient-example.html\">Patient/example</a> "Peter CHALMERS"</p><p><b>encounter</b>: <a href=\"encounter-example.html\">Encounter/example</a></p><p><b>occurrence</b>: 2015-01-15</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a href=\"location-1.html\">Location/1</a> "South Wing, second floor"</p><p><b>manufacturer</b>: <a href=\"organization-hl7.html\">Organization/hl7</a> "Health Level Seven International"</p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 2015-02-28</p><p><b>site</b>: left thigh <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-ActSite.html\">ActSite</a>#LT)</span></p><p><b>route</b>: Injection, intramuscular <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-RouteOfAdministration.html\">RouteOfAdministration</a>#IM)</span></p><p><b>doseQuantity</b>: 0.5 ml<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code ml = 'ml')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v2-0443.html\">providerRole</a>#OP)</span></p><p><b>actor</b>: <a href=\"practitioner-example.html\">Practitioner/example</a> "Adam CAREFUL"</p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v2-0443.html\">providerRole</a>#AP)</span></p><p><b>actor</b>: <a href=\"practitioner-example.html\">Practitioner/example</a> "Adam CAREFUL"</p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>isSubpotent</b>: false</p><p><b>subpotentReason</b>: Partial Dose <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-immunization-subpotent-reason.html\">Immunization Event Subpotent Reason</a>#partial)</span></p><h3>Educations</h3><table class=\"grid\"><tr><td>-</td><td><b>DocumentType</b></td><td><b>PublicationDate</b></td><td><b>PresentationDate</b></td></tr><tr><td>*</td><td>253088698300010311120702</td><td>2012-07-02</td><td>2013-01-10</td></tr></table><p><b>programEligibility</b>: Not Eligible <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-immunization-program-eligibility.html\">Immunization Event Program Eligibility</a>#ineligible)</span></p><p><b>fundingSource</b>: Private <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-immunization-funding-source.html\">Immunization Event Funding Source</a>#private)</span></p></div>" ]; fhir:Immunization.identifier [ fhir:index 0; fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234" ] ]; fhir:Immunization.status [ fhir:value "completed"]; fhir:Immunization.vaccineCode [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "urn:oid:1.2.36.1.2001.1005.17" ]; fhir:Coding.code [ fhir:value "GNHEP" ] ]; fhir:CodeableConcept.text [ fhir:value "Hepatitis B" ] ]; fhir:Immunization.patient [ fhir:link <http://hl7.org/fhir/Patient/example>; fhir:Reference.reference [ fhir:value "Patient/example" ] ]; fhir:Immunization.encounter [ fhir:link <http://hl7.org/fhir/Encounter/example>; fhir:Reference.reference [ fhir:value "Encounter/example" ] ]; fhir:Immunization.occurrenceDateTime [ fhir:value "2015-01-15"^^xsd:date]; fhir:Immunization.primarySource [ fhir:value "true"^^xsd:boolean]; fhir:Immunization.location [ fhir:link <http://hl7.org/fhir/Location/1>; fhir:Reference.reference [ fhir:value "Location/1" ] ]; fhir:Immunization.manufacturer [ fhir:link <http://hl7.org/fhir/Organization/hl7>; fhir:Reference.reference [ fhir:value "Organization/hl7" ] ]; fhir:Immunization.lotNumber [ fhir:value "AAJN11K"]; fhir:Immunization.expirationDate [ fhir:value "2015-02-28"^^xsd:date]; fhir:Immunization.site [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v3-ActSite" ]; fhir:Coding.code [ fhir:value "LT" ]; fhir:Coding.display [ fhir:value "left thigh" ] ] ]; fhir:Immunization.route [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration" ]; fhir:Coding.code [ fhir:value "IM" ]; fhir:Coding.display [ fhir:value "Injection, intramuscular" ] ] ]; fhir:Immunization.doseQuantity [ fhir:Quantity.value [ fhir:value "0.5"^^xsd:decimal ]; fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ]; fhir:Quantity.code [ fhir:value "ml" ] ]; fhir:Immunization.performer [ fhir:index 0; fhir:Immunization.performer.function [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v2-0443" ]; fhir:Coding.code [ fhir:value "OP" ] ] ]; fhir:Immunization.performer.actor [ fhir:link <http://hl7.org/fhir/Practitioner/example>; fhir:Reference.reference [ fhir:value "Practitioner/example" ] ] ], [ fhir:index 1; fhir:Immunization.performer.function [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v2-0443" ]; fhir:Coding.code [ fhir:value "AP" ] ] ]; fhir:Immunization.performer.actor [ fhir:link <http://hl7.org/fhir/Practitioner/example>; fhir:Reference.reference [ fhir:value "Practitioner/example" ][a fhir:Immunization ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "subpotent"] ; # fhir:text [ fhir:status [ fhir:v "generated" ] ; fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: Immunization</b><a name=\"subpotent\"> </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 Immunization "subpotent" </p></div><p><b>identifier</b>: id: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Hepatitis B <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (unknown#GNHEP)</span></p><h3>Manufacturers</h3><table class=\"grid\"><tr><td>-</td><td><b>Reference</b></td></tr><tr><td>*</td><td><a href=\"organization-example.html\">Organization/hl7</a> "Health Level Seven International"</td></tr></table><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 2015-02-28</p><p><b>patient</b>: <a href=\"patient-example.html\">Patient/example</a> "Peter CHALMERS"</p><p><b>encounter</b>: <a href=\"encounter-example.html\">Encounter/example</a></p><p><b>occurrence</b>: 2015-01-15</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a href=\"location-example.html\">Location/1</a> "South Wing, second floor"</p><p><b>site</b>: left thigh <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActSite.html\">ActSite</a>#LT)</span></p><p><b>route</b>: Injection, intramuscular <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-RouteOfAdministration.html\">RouteOfAdministration</a>#IM)</span></p><p><b>doseQuantity</b>: 0.5 ml<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code ml = 'ml')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v2-0443.html\">providerRole</a>#OP)</span></p><p><b>actor</b>: <a href=\"practitioner-example.html\">Practitioner/example</a> "Adam CAREFUL"</p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v2-0443.html\">providerRole</a>#AP)</span></p><p><b>actor</b>: <a href=\"practitioner-example.html\">Practitioner/example</a> "Adam CAREFUL"</p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>isSubpotent</b>: true</p><p><b>subpotentReason</b>: Partial Dose <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-immunization-subpotent-reason.html\">Immunization Subpotent Reason</a>#partialdose)</span></p><h3>ProgramEligibilities</h3><table class=\"grid\"><tr><td>-</td><td><b>Program</b></td><td><b>ProgramStatus</b></td></tr><tr><td>*</td><td>VFC <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></td><td>Uninsured <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-immunization-program-eligibility.html\">Immunization Program Eligibility</a>#uninsured)</span></td></tr></table><p><b>fundingSource</b>: Private <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-immunization-funding-source.html\">Immunization Funding Source</a>#private)</span></p></div>" ] ; # fhir:identifier ( [ fhir:system [ fhir:v "urn:ietf:rfc:3986"^^xsd:anyURI ] ; fhir:value [ fhir:v "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234" ] ] ) ; # fhir:status [ fhir:v "completed"] ; # fhir:vaccineCode [ fhir:coding ( [ fhir:system [ fhir:v "urn:oid:1.2.36.1.2001.1005.17"^^xsd:anyURI ] ; fhir:code [ fhir:v "GNHEP" ] ] ) ; fhir:text [ fhir:v "Hepatitis B" ] ] ; # fhir:manufacturer [ fhir:reference [ fhir:reference [ fhir:v "Organization/hl7" ] ]]; fhir:Immunization.note [ fhir:index 0; fhir:Annotation.text [ fhir:value "Notes on adminstration of vaccine" ] ]; fhir:Immunization.isSubpotent [ fhir:value "false"^^xsd:boolean]; fhir:Immunization.subpotentReason [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/immunization-subpotent-reason" ]; fhir:Coding.code [ fhir:value "partial" ]] ; # fhir:lotNumber [ fhir:v "AAJN11K"] ; # fhir:expirationDate [ fhir:v "2015-02-28"^^xsd:date] ; # fhir:patient [ fhir:reference [ fhir:v "Patient/example" ] ] ; # fhir:encounter [ fhir:reference [ fhir:v "Encounter/example" ] ] ; # fhir:occurrence [ fhir:v "2015-01-15"^^xsd:date] ; # fhir:primarySource [ fhir:v "true"^^xsd:boolean] ; # fhir:location [ fhir:reference [ fhir:v "Location/1" ] ] ; # fhir:site [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v3-ActSite"^^xsd:anyURI ] ; fhir:code [ fhir:v "LT" ] ; fhir:display [ fhir:v "left thigh" ] ] ) ] ; # fhir:route [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"^^xsd:anyURI ] ; fhir:code [ fhir:v "IM" ] ; fhir:display [ fhir:v "Injection, intramuscular" ] ] ) ] ; # fhir:doseQuantity [ fhir:value [ fhir:v "0.5"^^xsd:decimal ] ; fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ; fhir:code [ fhir:v "ml" ] ] ; # fhir:performer ( [ fhir:function [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v2-0443"^^xsd:anyURI ] ; fhir:code [ fhir:v "OP" ] ] ) ] ; fhir:actor [ fhir:reference [ fhir:v "Practitioner/example" ] ]]; fhir:Immunization.education [ fhir:index 0; fhir:Immunization.education.documentType [ fhir:value "253088698300010311120702" ]; fhir:Immunization.education.publicationDate [ fhir:value "2012-07-02"^^xsd:date ]; fhir:Immunization.education.presentationDate [ fhir:value "2013-01-10"^^xsd:date ] ]; fhir:Immunization.programEligibility [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility" ]; fhir:Coding.code [ fhir:value "ineligible" ]] [ fhir:function [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v2-0443"^^xsd:anyURI ] ; fhir:code [ fhir:v "AP" ] ] ) ] ; fhir:actor [ fhir:reference [ fhir:v "Practitioner/example" ] ]]; fhir:Immunization.fundingSource [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/immunization-funding-source" ]; fhir:Coding.code [ fhir:value "private" ]] ) ; # fhir:note ( [ fhir:text [ fhir:v "Notes on adminstration of vaccine" ] ] ) ; # fhir:isSubpotent [ fhir:v "true"^^xsd:boolean] ; # fhir:subpotentReason ( [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/immunization-subpotent-reason"^^xsd:anyURI ] ; fhir:code [ fhir:v "partialdose" ] ] ) ] ) ; # fhir:programEligibility ( [ fhir:program [ fhir:text [ fhir:v "VFC" ] ] ; fhir:programStatus [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility"^^xsd:anyURI ] ; fhir:code [ fhir:v "uninsured" ] ] ) ]] . <http://hl7.org/fhir/Patient/example> a fhir:Patient . <http://hl7.org/fhir/Encounter/example> a fhir:Encounter . <http://hl7.org/fhir/Location/1> a fhir:Location . <http://hl7.org/fhir/Organization/hl7> a fhir:Organization . <http://hl7.org/fhir/Practitioner/example> a fhir:Practitioner . # - ontology header ------------------------------------------------------------ <http://hl7.org/fhir/Immunization/subpotent.ttl> a owl:Ontology; owl:imports fhir:fhir.ttl; owl:versionIRI <http://build.fhir.org/Immunization/subpotent.ttl> .] ) ; # fhir:fundingSource [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/immunization-funding-source"^^xsd:anyURI ] ; fhir:code [ fhir:v "private" ] ] ) ]] . # # -------------------------------------------------------------------------------------
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
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
hl7.fhir.core#5.0.0
generated
on
Sat,
May
28,
2022
12:55+1000.
Sun,
Mar
26,
2023
15:25+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
|
Compare
to
R4B
|
|
Propose
a
change