Student Healthcare Information

GET 
/students/:communityId/medical/healthcare

Fetches a student's relevant medical healthcare information such as Medicare number, medical insurance fund name, blood group, and healthcare provider details.

For a list of all medical blood groups, go to Lookup - Medical Blood Group.

For a list of all medical insurance funds, go to Lookup - Medical Insurance Fund.

For a list of all immunisation form statuses, go to Lookup - Immunisation Form Status.

Request

Path Parameters

communityId uuidrequired

The unique identifier of the community member.

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
healthRecords objectrequired
id uuidnullablerequired
hasPrivateInsurance booleanrequired
privateInsuranceNumber stringnullablerequired
privateInsuranceCoverLevel stringnullablerequired
hasPrivateInsuranceExtraCover booleanrequired
privateInsuranceExpiry datenullablerequired
isAmbulanceMember booleanrequired
ambulanceNumber stringnullablerequired
medicareNumber stringnullablerequired
medicareLineNumber numbernullablerequired
medicareExpiry datenullablerequired
hasHealthcareCard booleanrequired
healthcareCardNumber stringnullablerequired
healthcareCardExpiry datenullablerequired
medicalBloodGroup objectnullablerequired
id stringnullablerequired
description stringnullablerequired
medicalInsuranceFund objectnullablerequired
id stringnullablerequired
description stringnullablerequired
immunisationFormReceived booleanrequired
immunisationReceivedDate datenullablerequired
immunisationDetails stringnullablerequired
immunisationFormStatus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
healthcareProviders object[]required
Array [
id uuidrequired
name stringrequired
location stringnullablerequired
specialisation stringnullablerequired
email stringnullablerequired
sortOrder numberrequired
phones object[]required
Array [
phone stringnullablerequired
phoneOrder numberrequired
Possible values: [1, 2]
Can only be for Phone (1) and Alt Phone (2)
]
medicalProfessionalType objectnullablerequired
id uuidrequired
description stringrequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "healthRecords": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "hasPrivateInsurance": true,
      "privateInsuranceNumber": "string",
      "privateInsuranceCoverLevel": "string",
      "hasPrivateInsuranceExtraCover": true,
      "privateInsuranceExpiry": "2025-03-12",
      "isAmbulanceMember": true,
      "ambulanceNumber": "string",
      "medicareNumber": "string",
      "medicareLineNumber": 0,
      "medicareExpiry": "2025-03-12",
      "hasHealthcareCard": true,
      "healthcareCardNumber": "string",
      "healthcareCardExpiry": "2025-03-12",
      "medicalBloodGroup": {
        "id": "string",
        "description": "string"
      },
      "medicalInsuranceFund": {
        "id": "string",
        "description": "string"
      },
      "immunisationFormReceived": true,
      "immunisationReceivedDate": "2025-03-12",
      "immunisationDetails": "string",
      "immunisationFormStatus": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string",
        "code": "string"
      }
    },
    "healthcareProviders": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "location": "string",
        "specialisation": "string",
        "email": "string",
        "sortOrder": 0,
        "phones": [
          {
            "phone": "string",
            "phoneOrder": 1
          }
        ],
        "medicalProfessionalType": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string"
        }
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "healthRecords": {
      "id": "cec0c07f-3e81-4331-85b3-4a8698e3d143",
      "hasPrivateInsurance": true,
      "privateInsuranceNumber": "123456789",
      "privateInsuranceCoverLevel": "Platinum",
      "hasPrivateInsuranceExtraCover": true,
      "privateInsuranceExpiry": "2024-05-31",
      "isAmbulanceMember": true,
      "ambulanceNumber": "123456",
      "medicareNumber": "654321",
      "medicareLineNumber": 1,
      "medicareExpiry": "2024-05-31",
      "hasHealthcareCard": true,
      "healthcareCardNumber": "4567896",
      "healthcareCardExpiry": "2024-05-31",
      "medicalBloodGroup": "A+",
      "medicalInsuranceFund": "AHM Medical Insurance",
      "immunisationFormReceived": true,
      "immunisationReceivedDate": "2023-01-15",
      "immunisationDetails": "Student has completed all required immunisations.",
      "immunisationFormStatus": {
        "id": "789e4567-e89b-12d3-a456-426614174111",
        "description": "Form",
        "code": "FORM"
      }
    },
    "healthcareProviders": [
      {
        "id": "4362caa2-c26d-416c-9c41-0979909ed996",
        "name": "Jane Doe",
        "location": "42 Wallaby Way, Sydney",
        "specialisation": "Pediatrics",
        "email": "jd@doctorsoffice.com",
        "sortOrder": 1,
        "phones": [
          {
            "phone": "123456789",
            "phoneOrder": 1
          },
          {
            "phone": "987654321",
            "phoneOrder": 2
          }
        ],
        "medicalProfessionalType": "Doctor"
      }
    ]
  }
}

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...