Release 4B
MedicationsThis page is part of the FHIR Specification (v4.3.0: R4B - STU). 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, Practitioner |
Raw Turtle (+ also see Turtle/RDF Format Specification)
Example where the provider indicates the protocol being followed
@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 sct: <http://snomed.info/id/> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/Immunization/protocol> a fhir:Immunization;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "protocol"];
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 "protocol" </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>: Twinrix (HepA/HepB) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v2-0292.html\">PH_VaccinesAdministeredCVX_CDC_NIP</a>#104)</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>: 2018-06-18</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>: PT123F</p><p><b>expirationDate</b>: 2018-12-15</p><p><b>site</b>: left arm <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>#LA)</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>: 5 mg<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code mg = 'mg')</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>isSubpotent</b>: false</p><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><blockquote><p><b>protocolApplied</b></p><p><b>series</b>: 2-dose</p><p><b>targetDisease</b>: Viral hepatitis, type A <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#40468003)</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 style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#66071002)</span></p><p><b>doseNumber</b>: 2</p></blockquote></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 "http://hl7.org/fhir/sid/cvx" ];
fhir:Coding.code [ fhir:value "104" ]
];
fhir:CodeableConcept.text [ fhir:value "Twinrix (HepA/HepB)" ]
];
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 "2018-06-18"^^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 "PT123F"];
fhir:Immunization.expirationDate [ fhir:value "2018-12-15"^^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 "LA" ];
fhir:Coding.display [ fhir:value "left arm" ]
]
];
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 "5"^^xsd:decimal ];
fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ];
fhir:Quantity.code [ fhir:value "mg" ]
];
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" ]
]
];
fhir:Immunization.isSubpotent [ fhir:value "false"^^xsd:boolean];
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: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:Immunization.protocolApplied [
fhir:index 0;
fhir:Immunization.protocolApplied.series [ fhir:value "2-dose" ];
fhir:Immunization.protocolApplied.targetDisease [
fhir:index 0;
fhir:CodeableConcept.coding [
fhir:index 0;
a sct:40468003;
fhir:Coding.system [ fhir:value "http://snomed.info/sct" ];
fhir:Coding.code [ fhir:value "40468003" ]
]
];
fhir:Immunization.protocolApplied.doseNumberPositiveInt [ fhir:value "1"^^xsd:positiveInteger ]
], [
fhir:index 1;
fhir:Immunization.protocolApplied.series [ fhir:value "3-dose" ];
fhir:Immunization.protocolApplied.targetDisease [
fhir:index 0;
fhir:CodeableConcept.coding [
fhir:index 0;
a sct:66071002;
fhir:Coding.system [ fhir:value "http://snomed.info/sct" ];
fhir:Coding.code [ fhir:value "66071002" ]
]
];
fhir:Immunization.protocolApplied.doseNumberPositiveInt [ fhir:value "2"^^xsd:positiveInteger ]
] .
<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/protocol.ttl> a owl:Ontology;
owl:imports fhir:fhir.ttl;
owl:versionIRI <http://build.fhir.org/Immunization/protocol.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 4B (v4.3.0) hl7.fhir.r4b.core#4.3.0 generated on Sat, May 28, 2022 12:55+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change