Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.27.0 - release New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.27.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Planned Event Example - TTL Representation

Raw ttl | Download

    @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/ImmunizationRecommendation/ir1> a fhir:ImmunizationRecommendation ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:Resource.id [ fhir:value "ir1"] ;
      fhir:Resource.meta [
         fhir:Meta.profile [
           fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation" ;
           fhir:index 0 ;
           fhir:link <https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation>
         ]
      ] ;
      fhir:DomainResource.text [
         fhir:Narrative.status [ fhir:value "extensions" ] ;
         fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ImmunizationRecommendation ir1</b></p><a name=\"ir1\"> </a><a name=\"hcir1\"> </a><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\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-air-immunization-recommendation.html\">AIR Immunization Recommendation</a></p></div><p><b>patient</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://fhir.org.nz/ig/base/pat\">pat</a></p><p><b>date</b>: 2021-01-20</p><blockquote><p><b>recommendation</b></p><blockquote><p><b>id</b></p>12345-asdf</blockquote><p><b>AIR Recommendation Id</b>: 12345</p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 397428000}\">Diphtheria</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 76902006}\">Tetanus</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 27836007}\">Pertussis</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 398102009}\">Poliomyelitis</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 66071002}\">Viral Hepatitis type B</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 91428005}\">Haemophilus influenzae infection</span></p><blockquote><p><b>AIR Antigen Group Vaccination Schedule</b></p><ul><li>schedule-type: <a href=\"CodeSystem-air-agvs-type.html#air-agvs-type-NIS\">AIR AGVS: NIS</a> (National Immunisation Schedule)</li><li>series-type: <a href=\"CodeSystem-air-agvs-series-type.html#air-agvs-series-type-PRIMARY\">AIR AGVS Series Type: PRIMARY</a> (Primary)</li><li>antigen-group: <a href=\"http://snomed.info/id/871761004\">SNOMED CT: 871761004</a> (RV1)</li><li>version: 1.0</li></ul></blockquote><blockquote><p><b>AIR Scheduled Event</b></p><ul><li>type: <a href=\"CodeSystem-air-planned-event-type-terms.html#air-planned-event-type-terms-CPE\">AIR Planned Event Type: CPE</a> (Consumer Planned Event)</li></ul></blockquote><p><b>vaccineCode</b>: <span title=\"Codes:{http://nzmt.org.nz 29455411000116105}\">DTaP-IPV-HepB/Hib</span></p><p><b>forecastStatus</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/immunization-recommendation-status due}\">Due</span></p><h3>DateCriterions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:\">DUE</span></td><td>2021-01-14</td></tr></table><p><b>series</b>: DTaP-IPV-HepB/Hib</p><p><b>doseNumber</b>: 1</p></blockquote></div>"
      ] ;
      fhir:ImmunizationRecommendation.patient [
         fhir:Reference.reference [ fhir:value "pat" ]
      ] ;
      fhir:ImmunizationRecommendation.date [ fhir:value "2021-01-20"^^xsd:date] ;
      fhir:ImmunizationRecommendation.recommendation [
         fhir:index 0 ;
         fhir:Element.id [ fhir:value "12345-asdf" ] ;
         fhir:Element.extension [
           fhir:index 0 ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state" ] ;
           fhir:Extension.valueString [ fhir:value "12345" ]
         ], [
           fhir:index 1 ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered" ] ;
           fhir:Extension.valueCodeableConcept [
             fhir:CodeableConcept.coding [
               fhir:index 0 ;
               a sct:397428000 ;
               fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
               fhir:Coding.code [ fhir:value "397428000" ] ;
               fhir:Coding.display [ fhir:value "Diphtheria" ]
             ]
           ]
         ], [
           fhir:index 2 ;
           fhir:Element.extension [
             fhir:index 0 ;
             fhir:Extension.url [ fhir:value "schedule-type" ] ;
             fhir:Extension.valueCoding [
               fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/air-agvs-type" ] ;
               fhir:Coding.code [ fhir:value "NIS" ]
             ]
           ], [
             fhir:index 1 ;
             fhir:Extension.url [ fhir:value "series-type" ] ;
             fhir:Extension.valueCoding [
               fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/air-agvs-series-type" ] ;
               fhir:Coding.code [ fhir:value "PRIMARY" ]
             ]
           ], [
             fhir:index 2 ;
             fhir:Extension.url [ fhir:value "antigen-group" ] ;
             fhir:Extension.valueCoding [
               a sct:871761004 ;
               fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
               fhir:Coding.code [ fhir:value "871761004" ] ;
               fhir:Coding.display [ fhir:value "RV1" ]
             ]
           ], [
             fhir:index 3 ;
             fhir:Extension.url [ fhir:value "version" ] ;
             fhir:Extension.valueString [ fhir:value "1.0" ]
           ] ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs" ]
         ], [
           fhir:index 3 ;
           fhir:Element.extension [
             fhir:index 0 ;
             fhir:Extension.url [ fhir:value "type" ] ;
             fhir:Extension.valueCoding [
               fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/air-scheduled-event-type-terms" ] ;
               fhir:Coding.code [ fhir:value "CPE" ]
             ]
           ] ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event" ]
         ], [
           fhir:index 4 ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered" ] ;
           fhir:Extension.valueCodeableConcept [
             fhir:CodeableConcept.coding [
               fhir:index 0 ;
               a sct:76902006 ;
               fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
               fhir:Coding.code [ fhir:value "76902006" ] ;
               fhir:Coding.display [ fhir:value "Tetanus" ]
             ]
           ]
         ], [
           fhir:index 5 ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered" ] ;
           fhir:Extension.valueCodeableConcept [
             fhir:CodeableConcept.coding [
               fhir:index 0 ;
               a sct:27836007 ;
               fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
               fhir:Coding.code [ fhir:value "27836007" ] ;
               fhir:Coding.display [ fhir:value "Pertussis" ]
             ]
           ]
         ], [
           fhir:index 6 ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered" ] ;
           fhir:Extension.valueCodeableConcept [
             fhir:CodeableConcept.coding [
               fhir:index 0 ;
               a sct:398102009 ;
               fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
               fhir:Coding.code [ fhir:value "398102009" ] ;
               fhir:Coding.display [ fhir:value "Poliomyelitis" ]
             ]
           ]
         ], [
           fhir:index 7 ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered" ] ;
           fhir:Extension.valueCodeableConcept [
             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:Coding.display [ fhir:value "Viral Hepatitis type B" ]
             ]
           ]
         ], [
           fhir:index 8 ;
           fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered" ] ;
           fhir:Extension.valueCodeableConcept [
             fhir:CodeableConcept.coding [
               fhir:index 0 ;
               a sct:91428005 ;
               fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
               fhir:Coding.code [ fhir:value "91428005" ] ;
               fhir:Coding.display [ fhir:value "Haemophilus influenzae infection" ]
             ]
           ]
         ] ;
         fhir:ImmunizationRecommendation.recommendation.vaccineCode [
           fhir:index 0 ;
           fhir:CodeableConcept.coding [
             fhir:index 0 ;
             fhir:Coding.system [ fhir:value "http://nzmt.org.nz" ] ;
             fhir:Coding.code [ fhir:value "29455411000116105" ] ;
             fhir:Coding.display [ fhir:value "DTaP-IPV-HepB/Hib" ]
           ]
         ] ;
         fhir:ImmunizationRecommendation.recommendation.forecastStatus [
           fhir:CodeableConcept.coding [
             fhir:index 0 ;
             fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/immunization-recommendation-status" ] ;
             fhir:Coding.code [ fhir:value "due" ]
           ]
         ] ;
         fhir:ImmunizationRecommendation.recommendation.dateCriterion [
           fhir:index 0 ;
           fhir:ImmunizationRecommendation.recommendation.dateCriterion.code [
             fhir:CodeableConcept.coding [
               fhir:index 0 ;
               fhir:Coding.code [ fhir:value "DUE" ]
             ]
           ] ;
           fhir:ImmunizationRecommendation.recommendation.dateCriterion.value [ fhir:value "2021-01-14"^^xsd:date ]
         ] ;
         fhir:ImmunizationRecommendation.recommendation.series [ fhir:value "DTaP-IPV-HepB/Hib" ] ;
         fhir:ImmunizationRecommendation.recommendation.doseNumberPositiveInt [ fhir:value "1"^^xsd:positiveInteger ]
      ] .

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

    <http://hl7.org/fhir/ImmunizationRecommendation/ir1.ttl> a owl:Ontology ;
      owl:imports fhir:fhir.ttl ;
      owl:versionIRI <http://build.fhir.org/ImmunizationRecommendation/ir1.ttl> .