ANZDATA Web API

ANZDATA exposes a number of APIs that can be consumed by facilities to automatically transfer data to ANZDATA. For a printer friendly version, click here.

For more information, please contact ANZDATA.

The following APIs are available:

Patient

End Point Description
api/patient/search
Method: GET

Search for an existing ANZDATA patient.

At least one of the following search parameters must be provided:
GivenName, Surname, DateOfBirth, ParentRenalUnitCode, PreviousParentRenalUnitCode, TreatmentModality.
api/patient/details/{id}
Method: GET

Retrieve current details for an existing ANZDATA patient.
api/patient/add
Method: POST

Register a new patient in ANZDATA.
api/patient/maintain/{id}
Method: PATCH

Update ANZDATA patient details.

NOTE: Patient details are only updatable when they are new in the open surveys, otherwise only the 'PhysicianCode' field can be updated.
api/patient/transfer/{id}
Method: PATCH

Transfer an existing ANZDATA patient to another facility.
api/patient/treatment/{id}
Method: PATCH

Create or Update Course of Treatment for an existing patient.
api/patient/treatmenttransfer/{id}
Method: PATCH

Maintain Course of Treatment record and/or Transfer an existing patient.

Transfer

End Point Description
api/transfer/renalunitpatient
Method: POST

Transfer a Patient from a different Service / Unit

Dialysis

End Point Description
api/dialysis/maintain/{id}
Methods: POST, PATCH

Update patient dialysis details for a survey period.

Survey period will be derived from the value of SurveyDate passed through.
api/dialysis/bloodstreaminfection/{id}
Method: PATCH

Create or update Haemodialysis Access Bloodstream Infection (HD Access BSI) record for an existing ANZDATA patient.
api/dialysis/peritonitisepisode/{id}
Methods: POST, PATCH

Create or update Peritonitis Episode record for an existing ANZDATA patient.

Transplant

End Point Description
api/transplant/maintain/{id}
Method: PATCH

Maintain Transplant details for a Patient
api/transplant/surgicaldata/{id}
Method: PATCH

Maintain Surgical Details for Transplant
api/transplant/therapy/{id}
Method: PATCH

Maintain Therapies for Transplant
api/transplant/dailydrugdose/{id}
Method: PATCH

Maintain Daily Drug Doses for Transplant
api/transplant/weight/{id}
Method: PATCH

Maintain Weights for Transplant
api/transplant/serumcreatinine/{id}
Method: PATCH

Maintain Serum Creatinines for Transplant
api/transplant/rejectionepisode/{id}
Method: PATCH

Maintain Rejection Episodes for Transplant

Paediatric

End Point Description
api/paediatric/maintain/{id}
Method: PATCH

Maintain Paediatric Survey Assessment for a Patient

Survey period will be derived from the value of SurveyDate passed through.

Parenthood Outcome

End Point Description
api/parenthoodoutcome/maintain/{id}
Method: PATCH

Maintain Parenthood Outcome for a Patient

To update an existing Parenthood Outcome record, PatientId and OutcomeDate must match an existing Parenthood Outcome record in ANZDATA.

Infection

End Point Description
api/infection/maintain/{id}
Method: PATCH

Create or Update Infection records for an existing patient.

TEACH PD

End Point Description
api/teachpd/maintain/{id}
Method: PATCH

Enrol or Update a TEACH-PD Trial Participant

RESOLVE

End Point Description
api/resolve/enrolmentsearch
Method: GET

Search for Trial Enrolment records.

The search parameter must be provided in the request body.
api/resolve/baseline/{id}
Method: PATCH

Update a RESOLVE Baseline Data for a Participant
api/resolve/event/{id}
Method: PATCH

Add or update a RESOLVE Event record for a Participant