# Immunisation - Medtech ALEX® AU Implementation Guide v1.0.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Immunisation**

## Resource Profile: Immunisation 

| | |
| :--- | :--- |
| *Official URL*:https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-immunisation | *Version*:1.0.0 |
| Active as of 2026-01-12 | *Computable Name*:AlexImmunisation |

 
The Immunisation exposed by ALEX 

**Usages:**

* Derived from this Profile: [Immunisation IPS Profile](StructureDefinition-alex-immunisation-ips.md)
* Use this Profile: [Immunisation Bundle](StructureDefinition-immunisation-search-bundle.md)
* Examples for this Profile: [Immunization/immunisation-full-example](Immunization-immunisation-full-example.md) and [Immunization/immunisation-min-example](Immunization-immunisation-min-example.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/medtechglobal.fhir.alex|current/StructureDefinition/alex-immunisation)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-alex-immunisation.csv), [Excel](StructureDefinition-alex-immunisation.xlsx), [Schematron](StructureDefinition-alex-immunisation.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "alex-immunisation",
  "url" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-immunisation",
  "version" : "1.0.0",
  "name" : "AlexImmunisation",
  "title" : "Immunisation",
  "status" : "active",
  "date" : "2026-01-12T22:43:00+00:00",
  "publisher" : "Medtech Global",
  "contact" : [
    {
      "name" : "Medtech Global",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://medtechglobal.com/au/"
        },
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com"
        }
      ]
    },
    {
      "name" : "Medtech Support",
      "telecom" : [
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "The Immunisation exposed by ALEX",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "workflow",
      "uri" : "http://hl7.org/fhir/workflow",
      "name" : "Workflow Pattern"
    },
    {
      "identity" : "v2",
      "uri" : "http://hl7.org/v2",
      "name" : "HL7 v2 Mapping"
    },
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    },
    {
      "identity" : "w5",
      "uri" : "http://hl7.org/fhir/fivews",
      "name" : "FiveWs Pattern Mapping"
    },
    {
      "identity" : "cda",
      "uri" : "http://hl7.org/v3/cda",
      "name" : "CDA (R2)"
    }
  ],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Immunization",
  "baseDefinition" : "http://hl7.org.au/fhir/StructureDefinition/au-immunization",
  "derivation" : "constraint",
  "differential" : {
    "element" : [
      {
        "id" : "Immunization",
        "path" : "Immunization",
        "constraint" : [
          {
            "key" : "status-reason-validation",
            "severity" : "error",
            "human" : "Status reason must be provided if status is 'not-done'",
            "expression" : "status.empty() or status = 'completed' or (status = 'not-done' and statusReason.empty().not())",
            "source" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-immunisation"
          },
          {
            "key" : "note-validation",
            "severity" : "error",
            "human" : "Note must not exceed 4096 characters",
            "expression" : "note.text.empty() or note.text.length() <= 4096",
            "source" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-immunisation"
          }
        ]
      },
      {
        "id" : "Immunization.meta.lastUpdated",
        "path" : "Immunization.meta.lastUpdated",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.implicitRules",
        "path" : "Immunization.implicitRules",
        "max" : "0"
      },
      {
        "id" : "Immunization.language",
        "path" : "Immunization.language",
        "max" : "0"
      },
      {
        "id" : "Immunization.contained",
        "path" : "Immunization.contained",
        "max" : "0"
      },
      {
        "id" : "Immunization.extension",
        "path" : "Immunization.extension",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "url"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        }
      },
      {
        "id" : "Immunization.extension:vaccineSerialNumber",
        "path" : "Immunization.extension",
        "sliceName" : "vaccineSerialNumber",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Immunization.identifier",
        "path" : "Immunization.identifier",
        "max" : "0"
      },
      {
        "id" : "Immunization.status",
        "path" : "Immunization.status",
        "binding" : {
          "strength" : "required",
          "valueSet" : "https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-status"
        }
      },
      {
        "id" : "Immunization.statusReason",
        "path" : "Immunization.statusReason",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-status-reason"
        }
      },
      {
        "id" : "Immunization.vaccineCode",
        "path" : "Immunization.vaccineCode",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.vaccineCode.coding:amtVaccineCode",
        "path" : "Immunization.vaccineCode.coding",
        "sliceName" : "amtVaccineCode",
        "max" : "0"
      },
      {
        "id" : "Immunization.vaccineCode.coding:airVaccineCode",
        "path" : "Immunization.vaccineCode.coding",
        "sliceName" : "airVaccineCode",
        "max" : "0"
      },
      {
        "id" : "Immunization.vaccineCode.coding:mtVaccineCode",
        "path" : "Immunization.vaccineCode.coding",
        "sliceName" : "mtVaccineCode",
        "min" : 0,
        "max" : "1",
        "binding" : {
          "strength" : "preferred",
          "valueSet" : "https://alexapi.medtechglobal.com.au/fhir/ValueSet/vaccine-code-vs"
        }
      },
      {
        "id" : "Immunization.vaccineCode.coding:mtVaccineCode.system",
        "path" : "Immunization.vaccineCode.coding.system",
        "min" : 1,
        "patternUri" : "https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.vaccineCode.coding:mtVaccineCode.code",
        "path" : "Immunization.vaccineCode.coding.code",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Immunization.vaccineCode.coding:mtVaccineCode.display",
        "path" : "Immunization.vaccineCode.coding.display",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.patient",
        "path" : "Immunization.patient",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.patient.reference",
        "path" : "Immunization.patient.reference",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.patient.display",
        "path" : "Immunization.patient.display",
        "short" : "External Name of Patient"
      },
      {
        "id" : "Immunization.occurrence[x]",
        "path" : "Immunization.occurrence[x]",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "type",
              "path" : "$this"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        }
      },
      {
        "id" : "Immunization.occurrence[x]:occurrenceDateTime",
        "path" : "Immunization.occurrence[x]",
        "sliceName" : "occurrenceDateTime",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "dateTime"
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Immunization.recorded",
        "path" : "Immunization.recorded",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.lotNumber",
        "path" : "Immunization.lotNumber",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.expirationDate",
        "path" : "Immunization.expirationDate",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.site",
        "path" : "Immunization.site",
        "binding" : {
          "strength" : "required",
          "valueSet" : "https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-site"
        }
      },
      {
        "id" : "Immunization.route",
        "path" : "Immunization.route",
        "binding" : {
          "strength" : "required",
          "valueSet" : "https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunization-route"
        }
      },
      {
        "id" : "Immunization.doseQuantity",
        "path" : "Immunization.doseQuantity",
        "max" : "0"
      },
      {
        "id" : "Immunization.performer",
        "path" : "Immunization.performer",
        "min" : 2,
        "max" : "2",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.performer.actor",
        "path" : "Immunization.performer.actor",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.performer:administeredBy",
        "path" : "Immunization.performer",
        "sliceName" : "administeredBy",
        "min" : 1
      },
      {
        "id" : "Immunization.performer:administeredBy.actor",
        "path" : "Immunization.performer.actor",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.performer:approvedBy",
        "path" : "Immunization.performer",
        "sliceName" : "approvedBy",
        "min" : 1
      },
      {
        "id" : "Immunization.performer:approvedBy.actor",
        "path" : "Immunization.performer.actor",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.note",
        "path" : "Immunization.note",
        "mustSupport" : true
      },
      {
        "id" : "Immunization.reasonCode",
        "path" : "Immunization.reasonCode",
        "max" : "0"
      },
      {
        "id" : "Immunization.reasonReference",
        "path" : "Immunization.reasonReference",
        "max" : "0"
      },
      {
        "id" : "Immunization.isSubpotent",
        "path" : "Immunization.isSubpotent",
        "max" : "0"
      },
      {
        "id" : "Immunization.subpotentReason",
        "path" : "Immunization.subpotentReason",
        "max" : "0"
      },
      {
        "id" : "Immunization.education",
        "path" : "Immunization.education",
        "max" : "0"
      },
      {
        "id" : "Immunization.programEligibility",
        "path" : "Immunization.programEligibility",
        "max" : "0"
      },
      {
        "id" : "Immunization.reaction",
        "path" : "Immunization.reaction",
        "max" : "0"
      },
      {
        "id" : "Immunization.protocolApplied.doseNumber[x]",
        "path" : "Immunization.protocolApplied.doseNumber[x]",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "type",
              "path" : "$this"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        }
      },
      {
        "id" : "Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt",
        "path" : "Immunization.protocolApplied.doseNumber[x]",
        "sliceName" : "doseNumberPositiveInt",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "positiveInt"
          }
        ],
        "mustSupport" : true
      }
    ]
  }
}

```
