Skip to main content
GET
Fetch a vaccine treatment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

treatment_id
integer
required

The ID of the treatment to retrieve.

Response

200 - application/json

OK

Schema for vaccine Treatment objects in the external API

administered_at
string<date-time>
required

When the vaccine treatment was administered.

clinic_patient_id
integer
required

The ID of the patient this vaccine treatment belongs to.

created
string<date-time>
required

The datetime this object was created.

display_name
string
required

The group service display name of the vaccine treatment.

expires_at
string<date> | null
required

When the vaccine treatment expires.

id
integer
required

The unique identifier for the vaccine treatment.

lot_number
string | null
required

The lot number recorded for this vaccine, if any.

manufacturer
string | null
required

The vaccine manufacturer name, if any.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

patient_standard_care_reminders
ExternalVaccineTreatmentPatientStandardCareReminder · object[]
required

The patient standard care reminders associated with this vaccine treatment.

rabies_tag
string | null
required

The rabies tag recorded on this vaccine treatment, if any. Typically only populated for RABIES-kind vaccines where a tag was entered.

serial_number
string | null
required

The serial number recorded for this vaccine, if any.

vaccine_kind
enum<string>
required

The vaccine kind (e.g. RABIES, OTHER).

Available options:
RABIES,
OTHER