api/Transplant/DailyDrugDose/{id}

Method: PATCH

Maintain Daily Drug Doses for Transplant

Request Information

URI

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

Parameters

Name	Description	Additional information
id	The ANZDATA Patient ID / Registry Number	Define this parameter in the request URI.
value	Transplant Drug Dose 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-04-19T00:00:00",
  "DrugDoses": [
    {
      "DrugCode": "string 3",
      "MonthCode": "string 5",
      "DrugDose": 1.0
    },
    {
      "DrugCode": "string 3",
      "MonthCode": "string 5",
      "DrugDose": 1.0
    },
    {
      "DrugCode": "string 3",
      "MonthCode": "string 5",
      "DrugDose": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<TransplantDrugDoses xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GraftNo>1</GraftNo>
  <TransplantDate>2024-04-19T00:00:00</TransplantDate>
  <DrugDoses>
    <DrugDose>
      <DrugCode>string 3</DrugCode>
      <MonthCode>string 5</MonthCode>
      <DrugDose>1</DrugDose>
    </DrugDose>
    <DrugDose>
      <DrugCode>string 3</DrugCode>
      <MonthCode>string 5</MonthCode>
      <DrugDose>1</DrugDose>
    </DrugDose>
    <DrugDose>
      <DrugCode>string 3</DrugCode>
      <MonthCode>string 5</MonthCode>
      <DrugDose>1</DrugDose>
    </DrugDose>
  </DrugDoses>
</TransplantDrugDoses>

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

DrugDoses

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
DrugCode		String	10	Anzdata Drugs Codes	Valid codes are dependant on associated field, refer to 'Valid for' column on Codes page.
DrugDose	Dose	Number	Decimal(6, 2)		Value must be between 0 and 99.
MonthCode	Time after transplant	String	10	Tx Drug Dose Months Codes