<StructureDefinition xmlns="http://hl7.org/fhir">
  <url value="https://fhir.clevermed.com/StructureDefinition/Immunization-BNet-Preg-Vaccinations" />
  <name value="Immunization-BNet-Preg-Vaccinations" />
  <status value="active" />
  <date value="2025-05-19T15:16:59.2541541Z" />
  <publisher value="Clevermed Ltd." />
  <contact>
    <name value="Clevermed BadgerNet Spine FHIR Team" />
    <telecom>
      <system value="email" />
      <value value="support@clevermed.com" />
      <use value="work" />
    </telecom>
  </contact>
  <description value="Currently, vaccination data is written by midwives into TURAS and requires re-entering into the BadgerNet record.&#xA;  Additionally, midwives in offline care locations do not have access to Turas to confirm vaccination statuses.&#xA;&#xA;The TURAS API allows vaccination records to be imported into the national BadgerNet pregnancy records for Scottish Pregnancy and Baby records.&#xA;The BadgerNet Spine will retrieve new vaccine data from the TURAS API on an hourly basis.&#xA;However, due to limitations of the TURAS API, a larger poll will occur at 02:00 to retrieve any records that are missed during the hourly polls.&#xA;Furthermore, where new records are created in the BadgerNet Spine, the new patients will be added to the hourly queue.&#xA;&#xA;To retrieve a patient's vaccination record, the Spine will use a patient's CHI number. This retrieved data is subsequently used by the Spine to update a patient's BadgerNet record.&#xA;&#xA;The information below details the key vaccination elements which are retrieved from TURAS." />
  <copyright value="(c) Clevermed Ltd.  Usage by permission and for BadgerNet Spine Platform integration only." />
  <fhirVersion value="4.0.1" />
  <kind value="resource" />
  <abstract value="false" />
  <type value="Immunization" />
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Immunization" />
  <derivation value="constraint" />
  <differential>
    <element id="Immunization.id">
      <path value="Immunization.id" />
      <short value="External identifier for immunization resource" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
    </element>
    <element id="Immunization.occurenceDateTime">
      <path value="Immunization.occurenceDateTime" />
      <short value="The datetime at which immunization took place, formatted as an ISO timestamp string in UTC with the use of 'Z' or an appropriate offset" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.patient.reference">
      <path value="Immunization.patient.reference" />
      <short value="This is a reference to the logical ID of the patient in the format Patient/[logicalID]" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.performer.actor.reference">
      <path value="Immunization.performer.actor.reference" />
      <short value="Only the first performer in the performer array is used. Supported references are a UUID or a local reference" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.primarySource">
      <path value="Immunization.primarySource" />
      <short value="A Boolean to indicate the context the data was recorded in" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.protocolApplied.targetDisease">
      <path value="Immunization.protocolApplied.targetDisease" />
      <short value="SNOMED code for disease" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.protocolApplied.targetDisease.coding.system">
      <path value="Immunization.protocolApplied.targetDisease.coding.system" />
      <fixedUri value="http://snomed.info/sct" />
    </element>
    <element id="Immunization.protocolApplied.targetDisease.coding.code">
      <path value="Immunization.protocolApplied.targetDisease.coding.code" />
      <min value="1" />
      <binding>
        <strength value="required" />
        <description value="SNOMED Disease Code" />
        <valueSet value="https://simplifier.net/badgernet/ValueSet-BNet-Preg-DiseaseCode" />
      </binding>
    </element>
    <element id="Immunization.protocolApplied.doseNumberString">
      <path value="Immunization.protocolApplied.doseNumberString" />
      <short value="String used when dose number is not applicable or unknown" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.protocolApplied.doseNumberPositiveInt">
      <path value="Immunization.protocolApplied.doseNumberPositiveInt" />
      <short value="Dose number within series, e.g. 1" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.site">
      <path value="Immunization.site" />
      <short value="Code describing where on patient the vaccine was administered" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.site.coding.system">
      <path value="Immunization.site.coding.system" />
      <fixedUri value="http://terminology.hl7.org/CodeSystem/v3-ActSite" />
    </element>
    <element id="Immunization.site.coding.code">
      <path value="Immunization.site.coding.code" />
      <min value="1" />
      <binding>
        <strength value="required" />
        <description value="How vaccine entered body" />
        <valueSet value="https://simplifier.net/badgernet/ValueSet-BNet-Preg-VaccinationSite" />
      </binding>
    </element>
    <element id="Immunization.status">
      <path value="Immunization.status" />
      <short value="Immunization status." />
      <definition value="This element describes the status of the immunization.&#xA;&#xA;Completed is defined as the event has now concluded.&#xA;&#xA;Entered in error is defined as the electronic record should have never existed, though it is possible that real world decisions were based on it." />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.statusReason">
      <path value="Immunization.statusReason" />
      <short value="Reason for why vaccine was not completed. Where the vaccination was administered, this value will bet set to NULL" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.statusReason.coding.system">
      <path value="Immunization.statusReason.coding.system" />
      <fixedUri value="http://snomed.info/sct" />
    </element>
    <element id="Immunization.statusReason.coding.code">
      <path value="Immunization.statusReason.coding.code" />
      <min value="1" />
      <binding>
        <strength value="required" />
        <description value="Status of Vaccination" />
        <valueSet value="https://simplifier.net/badgernet/ValueSet-BNet-Preg-VacStatusReasonSNOMED" />
      </binding>
    </element>
    <element id="Immunization.vaccineCode">
      <path value="Immunization.vaccineCode" />
      <short value="Vaccine product administered" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.vaccineCode.coding.system">
      <path value="Immunization.vaccineCode.coding.system" />
      <fixedUri value="http://snomed.info/sct" />
    </element>
    <element id="Immunization.vaccineCode.coding.code">
      <path value="Immunization.vaccineCode.coding.code" />
      <min value="1" />
      <binding>
        <strength value="required" />
        <description value="SNOMED Vaccine Code" />
        <valueSet value="https://simplifier.net/badgernet/ValueSet-BNet-Preg-VaccinationCode" />
      </binding>
    </element>
    <element id="Immunization.recorded">
      <path value="Immunization.recorded" />
      <short value="When the immunization was first captured in the subject's record" />
      <definition value="" />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
    <element id="Immunization.extension.Booster">
      <path value="Immunization.extension.Booster" />
      <short value="This element signifies whether the dose is a booster." />
      <definition value="A Booelean to signify whether the dose number identified in 'protocolApplied.doseNumberPositiveInt' was a booster. This field is only applicable when protocolApplied.targetDisease='840539006(COVID)'. If this element is posted as true with any other value for protocolApplied.targetDisease, it will be ignored.&#xA; The extension URL is https://clevermed.com/fhir/StructureDefinition/booster." />
      <min value="1" />
      <max value="1" />
      <mustSupport value="true" />
    </element>
  </differential>
</StructureDefinition>