api/Patient/Treatment/{id}

Method: PATCH

Create or Update Course of Treatment for an existing patient.

Request Information

URI

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

Parameters

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

{
  "TreatmentDate": "2024-04-25T00:00:00",
  "TreatmentCode": "string 5",
  "ReasonCode": "string 6",
  "ReasonOther": "string 7",
  "DeathCauseCode": "string 8",
  "DeathCauseOther": "string 9",
  "GraftSustainingLifeCode": "string 10",
  "GraftFailureCauseCode": "string 16",
  "GraftFailureCauseOther": "string 17",
  "GraftFailureSerumCreatinine": 1
}

application/xml, text/xml

Sample:

<Treatment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TreatmentDate>2024-04-25T00:00:00</TreatmentDate>
  <TreatmentCode>string 5</TreatmentCode>
  <ReasonCode>string 6</ReasonCode>
  <ReasonOther>string 7</ReasonOther>
  <DeathCauseCode>string 8</DeathCauseCode>
  <DeathCauseOther>string 9</DeathCauseOther>
  <GraftSustainingLifeCode>string 10</GraftSustainingLifeCode>
  <GraftFailureCauseCode>string 16</GraftFailureCauseCode>
  <GraftFailureCauseOther>string 17</GraftFailureCauseOther>
  <GraftFailureSerumCreatinine>1</GraftFailureSerumCreatinine>
</Treatment>

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

Treatment

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
DeathCauseCode	Cause of death	String	10	Anzdata Cause Of Death Codes	Required if TreatmentCode is "Z".
DeathCauseOther	Other cause of death	String	200		Required if DeathCauseCode of "Specify" is provided.
GraftFailureCauseCode	Cause of graft failure	String	10	Cause Of Graft Failure Codes	Required if TreatmentCode is "P".
GraftFailureCauseOther	Other causes of graft failure	String	200		Required if GraftFailureCauseCode of "Specify" is provided.
GraftFailureSerumCreatinine	Serum Creatinine at graft failure	Number			Required if TreatmentCode is "P". Value should be between 150 and 2500 (warning only). Value must be between 0 and 3030.
GraftSustainingLifeCode	Was graft sustaining life at time of death?	String	10	Yes No Codes	Required if TreatmentCode is "Z" and the Patient had a current functioning Graft at time of death.
ReasonCode	Reason transfer from dialysis during survey	String	10	Change Treatment Reason Codes	Required if treatment has changed from HD to PD or PD to HD.
ReasonOther	Description of other reason for transfer	String	200		Required if ReasonCode of "Specify" is provided.
TreatmentCode	Treatment code	String	10	Course Of Treatment Codes	Required. Initial Renal Replacement Therapy must be a transplant (G, X), a non-hybrid HD (B, D, F, Y) or a non-hybrid PD (E, M) treatment.
TreatmentDate	Treatment date	Date			Required.