api/Patient/Transfer/{id}

Method: PATCH

Transfer an existing ANZDATA patient to another facility.

Request Information

URI

https://services.anzdata.org.au/webservices/api/patient/transfer/{id}

Parameters

Name	Description	Additional information
id	The ANZDATA Patient ID / Registry Number	Define this parameter in the request URI.
value	Patient Facility 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:

{
  "DateOfBirth": "2024-04-24T00:00:00",
  "TransferDate": "2024-04-24T00:00:00",
  "ParentCentreCode": "string 1",
  "ParentCentreMRN": "string 2",
  "CentreCode": "string 3",
  "CentreMRN": "string 4"
}

application/xml, text/xml

Sample:

<Transfer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DateOfBirth>2024-04-24T00:00:00</DateOfBirth>
  <TransferDate>2024-04-24T00:00:00</TransferDate>
  <ParentCentreCode>string 1</ParentCentreCode>
  <ParentCentreMRN>string 2</ParentCentreMRN>
  <CentreCode>string 3</CentreCode>
  <CentreMRN>string 4</CentreMRN>
</Transfer>

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Message": "string 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>
  <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.

Transfer

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
CentreCode	Centre/facility of transfer	String	10	Facility Codes
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.