{ "resourceType": "StructureDefinition", "url": "https://fhir.clevermed.com/StructureDefinition/Immunization-BNet-Preg-Vaccinations", "name": "Immunization-BNet-Preg-Vaccinations", "status": "active", "date": "2025-05-19T15:16:59.2541541Z", "publisher": "Clevermed Ltd.", "contact": [ { "name": "Clevermed BadgerNet Spine FHIR Team", "telecom": [ { "system": "email", "value": "support@clevermed.com", "use": "work" } ] } ], "description": "Currently, vaccination data is written by midwives into TURAS and requires re-entering into the BadgerNet record.\n Additionally, midwives in offline care locations do not have access to Turas to confirm vaccination statuses.\n\nThe TURAS API allows vaccination records to be imported into the national BadgerNet pregnancy records for Scottish Pregnancy and Baby records.\nThe BadgerNet Spine will retrieve new vaccine data from the TURAS API on an hourly basis.\nHowever, 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.\nFurthermore, where new records are created in the BadgerNet Spine, the new patients will be added to the hourly queue.\n\nTo 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.\n\nThe information below details the key vaccination elements which are retrieved from TURAS.", "copyright": "(c) Clevermed Ltd. Usage by permission and for BadgerNet Spine Platform integration only.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "differential": { "element": [ { "id": "Immunization.id", "path": "Immunization.id", "short": "External identifier for immunization resource", "definition": "", "min": 1, "max": "1" }, { "id": "Immunization.occurenceDateTime", "path": "Immunization.occurenceDateTime", "short": "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": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "short": "This is a reference to the logical ID of the patient in the format Patient/[logicalID]", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.performer.actor.reference", "path": "Immunization.performer.actor.reference", "short": "Only the first performer in the performer array is used. Supported references are a UUID or a local reference", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.primarySource", "path": "Immunization.primarySource", "short": "A Boolean to indicate the context the data was recorded in", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "short": "SNOMED code for disease", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.protocolApplied.targetDisease.coding.system", "path": "Immunization.protocolApplied.targetDisease.coding.system", "fixedUri": "http://snomed.info/sct" }, { "id": "Immunization.protocolApplied.targetDisease.coding.code", "path": "Immunization.protocolApplied.targetDisease.coding.code", "min": 1, "binding": { "strength": "required", "description": "SNOMED Disease Code", "valueSet": "https://simplifier.net/badgernet/ValueSet-BNet-Preg-DiseaseCode" } }, { "id": "Immunization.protocolApplied.doseNumberString", "path": "Immunization.protocolApplied.doseNumberString", "short": "String used when dose number is not applicable or unknown", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.protocolApplied.doseNumberPositiveInt", "path": "Immunization.protocolApplied.doseNumberPositiveInt", "short": "Dose number within series, e.g. 1", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.site", "path": "Immunization.site", "short": "Code describing where on patient the vaccine was administered", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.site.coding.system", "path": "Immunization.site.coding.system", "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ActSite" }, { "id": "Immunization.site.coding.code", "path": "Immunization.site.coding.code", "min": 1, "binding": { "strength": "required", "description": "How vaccine entered body", "valueSet": "https://simplifier.net/badgernet/ValueSet-BNet-Preg-VaccinationSite" } }, { "id": "Immunization.status", "path": "Immunization.status", "short": "Immunization status.", "definition": "This element describes the status of the immunization.\n\nCompleted is defined as the event has now concluded.\n\nEntered 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": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.statusReason", "path": "Immunization.statusReason", "short": "Reason for why vaccine was not completed. Where the vaccination was administered, this value will bet set to NULL", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.statusReason.coding.system", "path": "Immunization.statusReason.coding.system", "fixedUri": "http://snomed.info/sct" }, { "id": "Immunization.statusReason.coding.code", "path": "Immunization.statusReason.coding.code", "min": 1, "binding": { "strength": "required", "description": "Status of Vaccination", "valueSet": "https://simplifier.net/badgernet/ValueSet-BNet-Preg-VacStatusReasonSNOMED" } }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "short": "Vaccine product administered", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.vaccineCode.coding.system", "path": "Immunization.vaccineCode.coding.system", "fixedUri": "http://snomed.info/sct" }, { "id": "Immunization.vaccineCode.coding.code", "path": "Immunization.vaccineCode.coding.code", "min": 1, "binding": { "strength": "required", "description": "SNOMED Vaccine Code", "valueSet": "https://simplifier.net/badgernet/ValueSet-BNet-Preg-VaccinationCode" } }, { "id": "Immunization.recorded", "path": "Immunization.recorded", "short": "When the immunization was first captured in the subject's record", "definition": "", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.extension.Booster", "path": "Immunization.extension.Booster", "short": "This element signifies whether the dose is a booster.", "definition": "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.\n The extension URL is https://clevermed.com/fhir/StructureDefinition/booster.", "min": 1, "max": "1", "mustSupport": true } ] } }