api/transplant/surgicaldata/{id}

Method: PATCH

Maintain Surgical Details for Transplant

Request Information

URI

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

Parameters

Name	Description	Additional information
id	The ANZDATA Patient ID / Registry Number	Define this parameter in the request URI.
value	Surgical Data 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",
  "SurgicalDetails": [
    {
      "AnastomosisSiteCode": "string 1",
      "ArterialCode": "string 2",
      "ArterialOther": "string 3",
      "VenousCode": "string 4",
      "VenousOther": "string 5",
      "VenaCavaExtensionCode": "string 6",
      "AorticPatchCode": "string 7",
      "AnastomosisTime": 1,
      "Comments": "string 8"
    },
    {
      "AnastomosisSiteCode": "string 1",
      "ArterialCode": "string 2",
      "ArterialOther": "string 3",
      "VenousCode": "string 4",
      "VenousOther": "string 5",
      "VenaCavaExtensionCode": "string 6",
      "AorticPatchCode": "string 7",
      "AnastomosisTime": 1,
      "Comments": "string 8"
    },
    {
      "AnastomosisSiteCode": "string 1",
      "ArterialCode": "string 2",
      "ArterialOther": "string 3",
      "VenousCode": "string 4",
      "VenousOther": "string 5",
      "VenaCavaExtensionCode": "string 6",
      "AorticPatchCode": "string 7",
      "AnastomosisTime": 1,
      "Comments": "string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<TransplantSurgicalDetails 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>
  <SurgicalDetails>
    <SurgicalData>
      <AnastomosisSiteCode>string 1</AnastomosisSiteCode>
      <ArterialCode>string 2</ArterialCode>
      <ArterialOther>string 3</ArterialOther>
      <VenousCode>string 4</VenousCode>
      <VenousOther>string 5</VenousOther>
      <VenaCavaExtensionCode>string 6</VenaCavaExtensionCode>
      <AorticPatchCode>string 7</AorticPatchCode>
      <AnastomosisTime>1</AnastomosisTime>
      <Comments>string 8</Comments>
    </SurgicalData>
    <SurgicalData>
      <AnastomosisSiteCode>string 1</AnastomosisSiteCode>
      <ArterialCode>string 2</ArterialCode>
      <ArterialOther>string 3</ArterialOther>
      <VenousCode>string 4</VenousCode>
      <VenousOther>string 5</VenousOther>
      <VenaCavaExtensionCode>string 6</VenaCavaExtensionCode>
      <AorticPatchCode>string 7</AorticPatchCode>
      <AnastomosisTime>1</AnastomosisTime>
      <Comments>string 8</Comments>
    </SurgicalData>
    <SurgicalData>
      <AnastomosisSiteCode>string 1</AnastomosisSiteCode>
      <ArterialCode>string 2</ArterialCode>
      <ArterialOther>string 3</ArterialOther>
      <VenousCode>string 4</VenousCode>
      <VenousOther>string 5</VenousOther>
      <VenaCavaExtensionCode>string 6</VenaCavaExtensionCode>
      <AorticPatchCode>string 7</AorticPatchCode>
      <AnastomosisTime>1</AnastomosisTime>
      <Comments>string 8</Comments>
    </SurgicalData>
  </SurgicalDetails>
</TransplantSurgicalDetails>

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

Surgicals

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
AnastomosisSiteCode	Anastomosis Site Code	String	10	Which Kidney Codes	Required.
AnastomosisTime	Anastomosis Time	Number			Value should greater than or equal to 0 (warning only). Value must greater than or equal to 0.
AorticPatchCode	Aortic Patch Code	String	10	Yes No Codes
ArterialCode	Arterial Code	String	10	Arterial Codes
ArterialOther	Arterial Other	String	200		Required if ArterialCode of "Specify" is provided.
Comments		String
VenaCavaExtensionCode	Vena Cava Extension Code	String	10	Yes No Codes
VenousCode	Venous Code	String	10	Venous Codes
VenousOther	Venous Other	String	200		Required if VenousCode of "Specify" is provided.