api/transfer/renalunitpatient

Method: POST

Transfer a Patient from a different Service / Unit

Request Information

URI

https://services.anzdata.org.au/webservices/api/transfer/renalunitpatient

Parameters

Name	Description	Additional information
value	Patient Transfer object	Define this parameter in the request body.

Request body formats

** Empty XML node(s) or JSON element(s) should be excluded from posted data.

application/json, text/json

Sample:

{
  "Surname": "string 1",
  "GivenName": "string 2",
  "DateOfBirth": "2025-10-26T00:00:00",
  "TransferredFromRenalUnitCode": "string 3",
  "TransferDate": "2025-10-26T00:00:00",
  "ParentCentreCode": "string 4",
  "ParentCentreMRN": "string 5",
  "CentreCode": "string 6",
  "CentreMRN": "string 7"
}

application/xml, text/xml

Sample:

<Transfer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Surname>string 1</Surname>
  <GivenName>string 2</GivenName>
  <DateOfBirth>2025-10-26T00:00:00</DateOfBirth>
  <TransferredFromRenalUnitCode>string 3</TransferredFromRenalUnitCode>
  <TransferDate>2025-10-26T00:00:00</TransferDate>
  <ParentCentreCode>string 4</ParentCentreCode>
  <ParentCentreMRN>string 5</ParentCentreMRN>
  <CentreCode>string 6</CentreCode>
  <CentreMRN>string 7</CentreMRN>
</Transfer>

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Message": "string 1",
  "AnzdataPatientId": 1,
  "SuccessMessages": [
    "string 1",
    "string 2",
    "string 3"
  ],
  "WarningMessages": [
    "string 1",
    "string 2",
    "string 3"
  ],
  "ErrorMessages": [
    "string 1",
    "string 2",
    "string 3"
  ]
}

application/xml, text/xml

Sample:

<ResponseBody xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Code>Success</Code>
  <Message>string 1</Message>
  <AnzdataPatientId>1</AnzdataPatientId>
  <SuccessMessages>
    <SuccessMessage>string 1</SuccessMessage>
    <SuccessMessage>string 2</SuccessMessage>
    <SuccessMessage>string 3</SuccessMessage>
  </SuccessMessages>
  <WarningMessages>
    <WarningMessage>string 1</WarningMessage>
    <WarningMessage>string 2</WarningMessage>
    <WarningMessage>string 3</WarningMessage>
  </WarningMessages>
  <ErrorMessages>
    <ErrorMessage>string 1</ErrorMessage>
    <ErrorMessage>string 2</ErrorMessage>
    <ErrorMessage>string 3</ErrorMessage>
  </ErrorMessages>
</ResponseBody>

Attribute Details

PatientDetail

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
DateOfBirth	Date of birth	Date			Required.
GivenName	Patient's given name	String	50		Required.
Surname	Patient's surname	String	50		Required.
TransferredFromRenalUnitCode	Service / Renal Unit the patient is transferring from	String	10	Facility Codes	Required.

Transfer

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
CentreCode	Centre/facility of transfer	String	10	Facility Codes	Required.
CentreMRN	Centre/facility Medical Record Number	String	10
ParentCentreCode	Parent centre of transfer	String	10	Facility Codes	Required.
ParentCentreMRN	Parent centre Medical Record Number	String	10
TransferDate	Date of transfer	Date			Required.