This page is part of the FHIR Specification (v3.3.0: R4 Ballot 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, Practitioner |
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 with Details</b></p><p><b>id</b>: subpotent</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>: Hepatitis B <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code 'GNHEP' = 'Hepatitis B)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>date</b>: 15/01/2015</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>: AAJN11K</p><p><b>expirationDate</b>: 28/02/2015</p><p><b>site</b>: left thigh <span>(Details : {http://hl7.org/fhir/v3/ActSite code 'LT' = 'left thigh', given as 'left thigh'})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://hl7.org/fhir/v3/RouteOfAdministration code 'IM' = 'Injection, intramuscular', given as 'Injection, intramuscular'})</span></p><p><b>doseQuantity</b>: 0.5 ml<span> (Details: UCUM code ml = 'ml')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://hl7.org/fhir/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://hl7.org/fhir/v2/0443 code 'AP' = 'Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>isPotent</b>: false</p><p><b>subpotentReason</b>: Partial Dose <span>(Details : {http://hl7.org/fhir/immunization-subpotent-reason code 'partial' = 'Partial Dose)</span></p><h3>Educations</h3><table><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>02/07/2012</td><td>10/01/2013</td></tr></table><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://hl7.org/fhir/immunization-program-eligibility code 'ineligible' = 'Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://hl7.org/fhir/immunization-funding-source code 'private' = '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.date [ 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://hl7.org/fhir/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://hl7.org/fhir/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://hl7.org/fhir/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://hl7.org/fhir/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.note [
fhir:index 0;
fhir:Annotation.text [ fhir:value "Notes on adminstration of vaccine" ]
];
fhir:Immunization.isPotent [ fhir:value "false"^^xsd:boolean];
fhir:Immunization.subpotentReason [
fhir:index 0;
fhir:CodeableConcept.coding [
fhir:index 0;
fhir:Coding.system [ fhir:value "http://hl7.org/fhir/immunization-subpotent-reason" ];
fhir:Coding.code [ fhir:value "partial" ]
]
];
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://hl7.org/fhir/immunization-program-eligibility" ];
fhir:Coding.code [ fhir:value "ineligible" ]
]
];
fhir:Immunization.fundingSource [
fhir:CodeableConcept.coding [
fhir:index 0;
fhir:Coding.system [ fhir:value "http://hl7.org/fhir/immunization-funding-source" ];
fhir:Coding.code [ fhir:value "private" ]
]
] .
<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> .
# -------------------------------------------------------------------------------------
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.