Update Student Medical Healthcare

PUT 
/students/:communityId/medical/healthcare

Update student healthcare information including 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.

application/json

Body

required

Update healthcare payload

hasPrivateInsurance booleanrequired
privateInsuranceNumber stringnullablerequired
privateInsuranceCoverLevel stringnullablerequired
hasPrivateInsuranceExtraCover booleanrequired
privateInsuranceExpiry stringnullablerequired
isAmbulanceMember booleanrequired
ambulanceNumber stringnullablerequired
medicareNumber stringnullablerequired
medicareLineNumber integernullablerequired
medicareExpiry stringnullablerequired
hasHealthcareCard booleanrequired
healthcareCardNumber stringnullablerequired
healthcareCardExpiry stringnullablerequired
medicalBloodGroup objectnullablerequired

id uuidrequired

Lookup - Medical Blood Group

medicalInsuranceFund objectnullablerequired

id uuidrequired

Lookup - Medical Insurance Fund

immunisationFormReceived booleanrequired
immunisationReceivedDate stringnullablerequired
immunisationDetails stringnullablerequired
immunisationFormStatus objectnullablerequired

id uuidrequired

Lookup - Immunisation Form Status

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
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

Example (from schema)

{
  "code": "OK",
  "data": {
    "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"
    }
  }
}

Successful

{
  "id": "b2580959-b0fb-4bbf-8477-a4ce49684c0c",
  "hasPrivateInsurance": true,
  "privateInsuranceNumber": "PI123456789",
  "privateInsuranceCoverLevel": "Gold",
  "hasPrivateInsuranceExtraCover": true,
  "privateInsuranceExpiry": "2024-12-31",
  "isAmbulanceMember": true,
  "ambulanceNumber": "AMB123456",
  "medicareNumber": "MED123456789",
  "medicareLineNumber": 1,
  "medicareExpiry": "2023-12-31",
  "hasHealthcareCard": true,
  "healthcareCardNumber": "HC123456789",
  "healthcareCardExpiry": "2023-12-31",
  "medicalBloodGroup": null,
  "medicalInsuranceFund": {
    "id": "0bdc6044-efe9-44c2-b0b4-d28bac8a8f38",
    "name": "Health Fund A"
  },
  "immunisationFormReceived": true,
  "immunisationReceivedDate": "2022-01-01",
  "immunisationDetails": "All immunisations up to date",
  "immunisationFormStatus": {
    "id": "acc0d657-29ba-422e-bb76-c36015077845",
    "description": "Form Completed",
    "code": "FC"
  }
}

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