Release 5 Preview #2

Immunization-example-protocol.ttl

Public Health and Emergency Response Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: 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><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>: <span>Twinrix (HepA/HepB)</span></p><p><b>patient</b>: <a>Generated Summary: id: example; Medical record number = 12345 (USUAL); active; Peter James Chalmers (OFFICIAL), Jim , Peter James Windsor (MAIDEN); -unknown-(HOME), ph: (03) 5555 6473(WORK), ph: (03) 3410 5613(MOBILE), ph: (03) 5555 8834(OLD); gender: male; birthDate: 1974-12-25; </a></p><p><b>encounter</b>: <a>Generated Summary: id: example; status: in-progress; <span>inpatient encounter</span></a></p><p><b>occurrence</b>: 2018-06-18</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Generated Summary: id: 1; B1-S.F2; status: active; name: South Wing, second floor; alias: BU MC, SW, F2, alias: Burgers University Medical Center, South Wing, second floor; description: Second floor of the Old South Wing, formerly in use by Psychiatry; mode: instance; ph: 2328(WORK), fax: 2329(WORK), second wing admissions, http://sampleorg.com/southwing(WORK); <span>Wing</span></a></p><p><b>manufacturer</b>: <a>Generated Summary: id: hl7; name: Health Level Seven International; alias: HL7 International; ph: (+1) 734-677-7777, fax: (+1) 734-677-6622, hq@HL7.org</a></p><p><b>lotNumber</b>: PT123F</p><p><b>expirationDate</b>: 2018-12-15</p><p><b>site</b>: <span>left arm</span></p><p><b>route</b>: <span>Injection, intramuscular</span></p><p><b>doseQuantity</b>: 5 mg</p><blockquote><p><b>performer</b></p><p><b>function</b>: <span>Ordering Provider</span></p><p><b>actor</b>: <a>Generated Summary: id: example; 23; active; Adam Careful </a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: <span>Administering Provider</span></p><p><b>actor</b>: <a>Generated Summary: id: example; 23; active; Adam Careful </a></p></blockquote><p><b>isSubpotent</b>: false</p><p><b>programEligibility</b>: <span>Not Eligible</span></p><p><b>fundingSource</b>: <span>Private</span></p><blockquote><p><b>protocolApplied</b></p><p><b>series</b>: 2-dose</p><p><b>targetDisease</b>: <span>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>: <span>Type B viral hepatitis</span></p><p><b>doseNumber</b>: 2</p><p><b>seriesDoses</b>: 3</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.doseNumber [ fhir:value "1" ]
  ], [
     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.doseNumber [ fhir:value "2" ];
     fhir:Immunization.protocolApplied.seriesDoses [ fhir:value "3" ]
  ] .

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