FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions . Page versions: R5 R4B R4 R3

Immunization-example.ttl

Example Immunization/example (Turtle)

Maturity Level : N/A
Responsible Owner: Public Health and Emergency Response Work Group Ballot Standards Status : Informative Compartments : Patient , Practitioner

Raw Turtle , JSON-LD (+ also see Turtle/RDF Format Specification )

Example of Immunization 

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .

@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/example> a fhir:Immunization;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example"];
  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>: example</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>notGiven</b>: false</p><p><b>vaccineCode</b>: Fluvax (Influenza) <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code 'FLUVAX' = 'Fluvax)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>date</b>: 10/01/2013</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>: 15/02/2015</p><p><b>site</b>: left arm <span>(Details : {http://hl7.org/fhir/v3/ActSite code 'LA' = 'left arm', given as 'left arm'})</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>: 5 mg<span> (Details: UCUM code mg = 'mg')</span></p><blockquote><p><b>practitioner</b></p><p><b>role</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>practitioner</b></p><p><b>role</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><h3>Explanations</h3><table><tr><td>-</td><td><b>Reason</b></td></tr><tr><td>*</td><td>Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement)</span></td></tr></table><h3>Reactions</h3><table><tr><td>-</td><td><b>Date</b></td><td><b>Detail</b></td><td><b>Reported</b></td></tr><tr><td>*</td><td>10/01/2013</td><td><a>Observation/example</a></td><td>true</td></tr></table><h3>VaccinationProtocols</h3><table><tr><td>-</td><td><b>DoseSequence</b></td><td><b>Description</b></td><td><b>Authority</b></td><td><b>Series</b></td><td><b>SeriesDoses</b></td><td><b>TargetDisease</b></td><td><b>DoseStatus</b></td><td><b>DoseStatusReason</b></td></tr><tr><td>*</td><td>1</td><td>Vaccination Protocol Sequence 1</td><td><a>Organization/hl7</a></td><td>Vaccination Series 1</td><td>2</td><td>Gestational rubella syndrome <span>(Details : {SNOMED CT code '1857005' = 'Gestational rubella syndrome)</span></td><td>Counts <span>(Details : {http://hl7.org/fhir/vaccination-protocol-dose-status code 'count' = 'Counts', given as 'Counts'})</span></td><td>Cold chain break <span>(Details : {http://hl7.org/fhir/vaccination-protocol-dose-status-reason code 'coldchbrk' = 'Cold chain break', given as 'Cold chain break'})</span></td></tr></table></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.notGiven [ fhir:value "false"^^xsd:boolean];
  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 "FLUVAX" ]
     ];
     fhir:CodeableConcept.text [ fhir:value "Fluvax (Influenza)" ]
  ];
  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 "2013-01-10"^^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-15"^^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 "LA" ];
       fhir:Coding.display [ fhir:value "left arm" ]

#  Authored by Joginder Madra 

<http://hl7.org/fhir/Immunization/example> a fhir:Immunization ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "example"] ; # 
  fhir:identifier ( [
     fhir:system [
       fhir:v "urn:ietf:rfc:3986"^^xsd:anyURI ;
       fhir:l <urn:ietf:rfc:3986>
     ] ;
     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:l <urn:oid:1.2.36.1.2001.1005.17>
       ] ;
       fhir:code [ fhir:v "FLUVAX" ]
     ] ) ;
     fhir:text [ fhir:v "Fluvax" ]
  ] ; # 
  fhir:administeredProduct [
     fhir:concept [
       fhir:coding ( [
         fhir:system [
           fhir:v "urn:oid:2.16.840.1.113883.6.69"^^xsd:anyURI ;
           fhir:l <urn:oid:2.16.840.1.113883.6.69>
         ] ;
         fhir:code [ fhir:v "70461-0321-03" ]
       ] ) ;
       fhir:text [ fhir:v "Flucelvax (Influenza, injectable, MDCK, preservative free, quadrivalent)" ]

     ]
  ];
  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:manufacturer [
     fhir:reference [
       fhir:l <http://hl7.org/fhir/Organization/hl7> ;
       fhir:reference [ fhir:v "Organization/hl7" ]

     ]
  ];
  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.practitioner [
     fhir:index 0;
     fhir:Immunization.practitioner.role [
       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.practitioner.actor [
       fhir:link <http://hl7.org/fhir/Practitioner/example>;
       fhir:Reference.reference [ fhir:value "Practitioner/example" ]

  ] ; # 
  fhir:lotNumber [ fhir:v "AAJN11K"] ; # 
  fhir:expirationDate [ fhir:v "2015-02-15"^^xsd:date] ; # 
  fhir:patient [
     fhir:l <http://hl7.org/fhir/Patient/example> ;
     fhir:reference [ fhir:v "Patient/example" ]
  ] ; # 
  fhir:encounter [
     fhir:l <http://hl7.org/fhir/Encounter/example> ;
     fhir:reference [ fhir:v "Encounter/example" ]
  ] ; # 
  fhir:occurrence [
     a fhir:DateTime ;
     fhir:v "2013-01-10"^^xsd:date
  ] ; # 
  fhir:primarySource [ fhir:v true] ; # 
  fhir:location [
     fhir:l <http://hl7.org/fhir/Location/1> ;
     fhir:reference [ fhir:v "Location/1" ]
  ] ; # 
  fhir:site [
     fhir:coding ( [
       fhir:system [
         fhir:v "http://terminology.hl7.org/CodeSystem/v3-ActSite"^^xsd:anyURI ;
         fhir:l <http://terminology.hl7.org/CodeSystem/v3-ActSite>
       ] ;
       fhir:code [ fhir:v "LA" ] ;
       fhir:display [ fhir:v "left arm" ]
     ] )
  ] ; # 
  fhir:route [
     fhir:coding ( [
       fhir:system [
         fhir:v "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"^^xsd:anyURI ;
         fhir:l <http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration>
       ] ;
       fhir:code [ fhir:v "IM" ] ;
       fhir:display [ fhir:v "Injection, intramuscular" ]
     ] )
  ] ; # 
  fhir:doseQuantity [
     fhir:value [ fhir:v "5"^^xsd:decimal ] ;
     fhir:system [
       fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ;
       fhir:l <http://unitsofmeasure.org>
     ] ;
     fhir:code [ fhir:v "mg" ]
  ] ; # 
  fhir:performer ( [
     fhir:function [
       fhir:coding ( [
         fhir:system [
           fhir:v "http://terminology.hl7.org/CodeSystem/v2-0443"^^xsd:anyURI ;
           fhir:l <http://terminology.hl7.org/CodeSystem/v2-0443>
         ] ;
         fhir:code [ fhir:v "OP" ]
       ] )
     ] ;
     fhir:actor [
       fhir:l <http://hl7.org/fhir/Practitioner/example> ;
       fhir:reference [ fhir:v "Practitioner/example" ]

     ]
  ], [
     fhir:index 1;
     fhir:Immunization.practitioner.role [
       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.practitioner.actor [
       fhir:link <http://hl7.org/fhir/Practitioner/example>;
       fhir:Reference.reference [ fhir:value "Practitioner/example" ]

  ] [
     fhir:function [
       fhir:coding ( [
         fhir:system [
           fhir:v "http://terminology.hl7.org/CodeSystem/v2-0443"^^xsd:anyURI ;
           fhir:l <http://terminology.hl7.org/CodeSystem/v2-0443>
         ] ;
         fhir:code [ fhir:v "AP" ]
       ] )
     ] ;
     fhir:actor [
       fhir:l <http://hl7.org/fhir/Practitioner/example> ;
       fhir:reference [ fhir:v "Practitioner/example" ]

     ]
  ];
  fhir:Immunization.note [
     fhir:index 0;
     fhir:Annotation.text [ fhir:value "Notes on adminstration of vaccine" ]
  ];
  fhir:Immunization.explanation [
     fhir:Immunization.explanation.reason [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         a sct:429060002;
         fhir:Coding.system [ fhir:value "http://snomed.info/sct" ];
         fhir:Coding.code [ fhir:value "429060002" ]
       ]

  ] ) ; # 
  fhir:note ( [
     fhir:text [ fhir:v "Notes on adminstration of vaccine" ]
  ] ) ; # 
  fhir:reason ( [
     fhir:concept [
       fhir:coding ( [
         a sct:429060002 ;
         fhir:system [
           fhir:v "http://snomed.info/sct"^^xsd:anyURI ;
           fhir:l <http://snomed.info/sct>
         ] ;
         fhir:code [ fhir:v "429060002" ]
       ] )

     ]
  ];
  fhir:Immunization.reaction [
     fhir:index 0;
     fhir:Immunization.reaction.date [ fhir:value "2013-01-10"^^xsd:date ];
     fhir:Immunization.reaction.detail [
       fhir:link <http://hl7.org/fhir/Observation/example>;
       fhir:Reference.reference [ fhir:value "Observation/example" ]
     ];
     fhir:Immunization.reaction.reported [ fhir:value "true"^^xsd:boolean ]
  ];
  fhir:Immunization.vaccinationProtocol [
     fhir:index 0;
     fhir:Immunization.vaccinationProtocol.doseSequence [ fhir:value "1"^^xsd:positiveInteger ];
     fhir:Immunization.vaccinationProtocol.description [ fhir:value "Vaccination Protocol Sequence 1" ];
     fhir:Immunization.vaccinationProtocol.authority [
       fhir:link <http://hl7.org/fhir/Organization/hl7>;
       fhir:Reference.reference [ fhir:value "Organization/hl7" ]
     ];
     fhir:Immunization.vaccinationProtocol.series [ fhir:value "Vaccination Series 1" ];
     fhir:Immunization.vaccinationProtocol.seriesDoses [ fhir:value "2"^^xsd:positiveInteger ];
     fhir:Immunization.vaccinationProtocol.targetDisease [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         a sct:1857005;
         fhir:Coding.system [ fhir:value "http://snomed.info/sct" ];
         fhir:Coding.code [ fhir:value "1857005" ]
       ]
     ];
     fhir:Immunization.vaccinationProtocol.doseStatus [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/vaccination-protocol-dose-status" ];
         fhir:Coding.code [ fhir:value "count" ];
         fhir:Coding.display [ fhir:value "Counts" ]
       ]
     ];
     fhir:Immunization.vaccinationProtocol.doseStatusReason [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/vaccination-protocol-dose-status-reason" ];
         fhir:Coding.code [ fhir:value "coldchbrk" ];
         fhir:Coding.display [ fhir:value "Cold chain break" ]
       ]

  ] ) ; # 
  fhir:isSubpotent [ fhir:v true] ; # 
  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:l <http://terminology.hl7.org/CodeSystem/immunization-program-eligibility>
         ] ;
         fhir:code [ fhir:v "uninsured" ]
       ] )

     ]
  ] .

  ] ) ; # 
  fhir:fundingSource [
     fhir:coding ( [
       fhir:system [
         fhir:v "http://terminology.hl7.org/CodeSystem/immunization-funding-source"^^xsd:anyURI ;
         fhir:l <http://terminology.hl7.org/CodeSystem/immunization-funding-source>
       ] ;
       fhir:code [ fhir:v "private" ]
     ] )
  ] . # 

<http://hl7.org/fhir/Organization/hl7> a fhir:Organization .


<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 .

<http://hl7.org/fhir/Observation/example> a fhir:Observation .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/Immunization/example.ttl> a owl:Ontology;
  owl:imports fhir:fhir.ttl;
  owl:versionIRI <http://hl7.org/fhir/STU3/Immunization/example.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.