Student Medical Immunisations

GET 
/students/:communityId/medical/immunisations

Fetches a student's relevant medical immunisation information such as whether the student’s immunisation form has been received, the status and a list of the immunisations the student has received.

For a list of all medical vaccines, go to Lookup - Medical Vaccine.
For a list of all medical vaccine brands, go to Lookup - Medical Vaccine Brand.

Request

Path Parameters

communityId uuidrequired

The unique identifier of the community member.

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object[]
Array [
id stringrequired
immunityEndDate datenullablerequired
administeredDate datenullablerequired
administeredBy stringnullablerequired
batchNumber stringnullablerequired
active booleanrequired
medicalVaccine objectrequired
id uuidrequired
Lookup - Medical Vaccine
description stringrequired
medicalVaccineBrand objectnullablerequired
id uuidrequired
Lookup - Medical Vaccine Brand
description stringrequired
]

Example (from schema)

{
  "code": "OK",
  "data": [
    {
      "id": "string",
      "immunityEndDate": "2025-03-12",
      "administeredDate": "2025-03-12",
      "administeredBy": "string",
      "batchNumber": "string",
      "active": true,
      "medicalVaccine": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string"
      },
      "medicalVaccineBrand": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string"
      }
    }
  ]
}

Successful

{
  "code": "OK",
  "data": [
    {
      "id": "456e4567-e89b-12d3-a456-426614174222",
      "immunityEndDate": "2025-01-15",
      "administeredDate": "2023-01-10",
      "administeredBy": "Dr. John Doe",
      "batchNumber": "B12345",
      "active": true,
      "medicalVaccine": {
        "id": "123e4567-e89b-12d3-a456-426614174333",
        "description": "MMR"
      },
      "medicalVaccineBrand": {
        "id": "789e4567-e89b-12d3-a456-426614174444",
        "description": "MMR II"
      }
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...