api/transplant/therapy/{id}

Method: PATCH

Maintain Therapies for Transplant

Request Information

URI

https://services.anzdata.org.au/webservices/api/transplant/therapy/{id}

Parameters

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

{
  "GraftNo": 1,
  "TransplantDate": "2024-12-04T00:00:00",
  "Therapies": [
    {
      "TherapyDate": "2024-12-04T00:00:00",
      "AgentCode": "string 4",
      "AgentOther": "string 5",
      "DosesGiven": 1,
      "ReasonCode": "string 6",
      "ReasonOther": "string 7"
    },
    {
      "TherapyDate": "2024-12-04T00:00:00",
      "AgentCode": "string 4",
      "AgentOther": "string 5",
      "DosesGiven": 1,
      "ReasonCode": "string 6",
      "ReasonOther": "string 7"
    },
    {
      "TherapyDate": "2024-12-04T00:00:00",
      "AgentCode": "string 4",
      "AgentOther": "string 5",
      "DosesGiven": 1,
      "ReasonCode": "string 6",
      "ReasonOther": "string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<TransplantTherapies xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GraftNo>1</GraftNo>
  <TransplantDate>2024-12-04T00:00:00</TransplantDate>
  <Therapies>
    <Therapy>
      <TherapyDate>2024-12-04T00:00:00</TherapyDate>
      <AgentCode>string 4</AgentCode>
      <AgentOther>string 5</AgentOther>
      <DosesGiven>1</DosesGiven>
      <ReasonCode>string 6</ReasonCode>
      <ReasonOther>string 7</ReasonOther>
    </Therapy>
    <Therapy>
      <TherapyDate>2024-12-04T00:00:00</TherapyDate>
      <AgentCode>string 4</AgentCode>
      <AgentOther>string 5</AgentOther>
      <DosesGiven>1</DosesGiven>
      <ReasonCode>string 6</ReasonCode>
      <ReasonOther>string 7</ReasonOther>
    </Therapy>
    <Therapy>
      <TherapyDate>2024-12-04T00:00:00</TherapyDate>
      <AgentCode>string 4</AgentCode>
      <AgentOther>string 5</AgentOther>
      <DosesGiven>1</DosesGiven>
      <ReasonCode>string 6</ReasonCode>
      <ReasonOther>string 7</ReasonOther>
    </Therapy>
  </Therapies>
</TransplantTherapies>

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

Therapies

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
AgentCode	Type of agent	String	10	Monoclonal Polyclonal Agent Codes
AgentOther	Other types of agent	String	50		Required if AgentCode of "Specify" is provided.
CourseNo	Therapy course number	Number
DosesGiven	Actual number of doses given	Number			Value must be between 1 and 50.
ReasonCode	Reason for use	String	10	Monoclonal Polyclonal Reason Codes
ReasonOther	Other reason	String	50		Required if ReasonCode of "Specify" is provided.
TherapyDate	Date of Monoclonal/Polyclonal therapy	Date			Required.