api/transplant/rejectionepisode/{id}

Method: PATCH

Maintain Rejection Episodes for Transplant

Request Information

URI

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

Parameters

Name	Description	Additional information
id	The ANZDATA Patient ID / Registry Number	Define this parameter in the request URI.
value	Transplant Rejection Episode 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",
  "RejectionEpisodes": [
    {
      "AcuteRejectionDate": "2024-12-04T00:00:00",
      "BiopsyPerformedCode": "string 1",
      "ResponseConsideredCode": "string 2",
      "AntibodyMediatedCode": "string 7",
      "DSACode": "string 8",
      "TCellMediatedCode": "string 9",
      "AcuteBanffGCode": "string 10",
      "AcuteBanffICode": "string 11",
      "AcuteBanffTCode": "string 12",
      "AcuteBanffVCode": "string 13",
      "AcuteBanffPTCCode": "string 14",
      "AcuteBanffC4DCode": "string 15",
      "AcuteBanffCGCode": "string 16",
      "AcuteBanffCICode": "string 17",
      "AcuteBanffCTCode": "string 18",
      "AcuteBanffCVCode": "string 19",
      "AcuteBanffMMCode": "string 20",
      "AcuteBanffAHCode": "string 21",
      "AcuteBanffTICode": "string 22",
      "AcuteBanffIIFTACode": "string 23",
      "RejectionTreatments": [
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        },
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        },
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        }
      ],
      "TreatmentResponseCode": "string 24",
      "Comments": "string 25"
    },
    {
      "AcuteRejectionDate": "2024-12-04T00:00:00",
      "BiopsyPerformedCode": "string 1",
      "ResponseConsideredCode": "string 2",
      "AntibodyMediatedCode": "string 7",
      "DSACode": "string 8",
      "TCellMediatedCode": "string 9",
      "AcuteBanffGCode": "string 10",
      "AcuteBanffICode": "string 11",
      "AcuteBanffTCode": "string 12",
      "AcuteBanffVCode": "string 13",
      "AcuteBanffPTCCode": "string 14",
      "AcuteBanffC4DCode": "string 15",
      "AcuteBanffCGCode": "string 16",
      "AcuteBanffCICode": "string 17",
      "AcuteBanffCTCode": "string 18",
      "AcuteBanffCVCode": "string 19",
      "AcuteBanffMMCode": "string 20",
      "AcuteBanffAHCode": "string 21",
      "AcuteBanffTICode": "string 22",
      "AcuteBanffIIFTACode": "string 23",
      "RejectionTreatments": [
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        },
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        },
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        }
      ],
      "TreatmentResponseCode": "string 24",
      "Comments": "string 25"
    },
    {
      "AcuteRejectionDate": "2024-12-04T00:00:00",
      "BiopsyPerformedCode": "string 1",
      "ResponseConsideredCode": "string 2",
      "AntibodyMediatedCode": "string 7",
      "DSACode": "string 8",
      "TCellMediatedCode": "string 9",
      "AcuteBanffGCode": "string 10",
      "AcuteBanffICode": "string 11",
      "AcuteBanffTCode": "string 12",
      "AcuteBanffVCode": "string 13",
      "AcuteBanffPTCCode": "string 14",
      "AcuteBanffC4DCode": "string 15",
      "AcuteBanffCGCode": "string 16",
      "AcuteBanffCICode": "string 17",
      "AcuteBanffCTCode": "string 18",
      "AcuteBanffCVCode": "string 19",
      "AcuteBanffMMCode": "string 20",
      "AcuteBanffAHCode": "string 21",
      "AcuteBanffTICode": "string 22",
      "AcuteBanffIIFTACode": "string 23",
      "RejectionTreatments": [
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        },
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        },
        {
          "TreatmentNo": 1,
          "TreatmentCode": "string 1",
          "TreatmentOther": "string 2"
        }
      ],
      "TreatmentResponseCode": "string 24",
      "Comments": "string 25"
    }
  ]
}

application/xml, text/xml

Sample:

<RejectionEpisodes 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>
  <RejectionEpisodes>
    <RejectionEpisode>
      <AcuteRejectionDate>2024-12-04T00:00:00</AcuteRejectionDate>
      <BiopsyPerformedCode>string 1</BiopsyPerformedCode>
      <ResponseConsideredCode>string 2</ResponseConsideredCode>
      <AntibodyMediatedCode>string 7</AntibodyMediatedCode>
      <DSACode>string 8</DSACode>
      <TCellMediatedCode>string 9</TCellMediatedCode>
      <AcuteBanffGCode>string 10</AcuteBanffGCode>
      <AcuteBanffICode>string 11</AcuteBanffICode>
      <AcuteBanffTCode>string 12</AcuteBanffTCode>
      <AcuteBanffVCode>string 13</AcuteBanffVCode>
      <AcuteBanffPTCCode>string 14</AcuteBanffPTCCode>
      <AcuteBanffC4DCode>string 15</AcuteBanffC4DCode>
      <AcuteBanffCGCode>string 16</AcuteBanffCGCode>
      <AcuteBanffCICode>string 17</AcuteBanffCICode>
      <AcuteBanffCTCode>string 18</AcuteBanffCTCode>
      <AcuteBanffCVCode>string 19</AcuteBanffCVCode>
      <AcuteBanffMMCode>string 20</AcuteBanffMMCode>
      <AcuteBanffAHCode>string 21</AcuteBanffAHCode>
      <AcuteBanffTICode>string 22</AcuteBanffTICode>
      <AcuteBanffIIFTACode>string 23</AcuteBanffIIFTACode>
      <RejectionTreatments>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
      </RejectionTreatments>
      <TreatmentResponseCode>string 24</TreatmentResponseCode>
      <Comments>string 25</Comments>
    </RejectionEpisode>
    <RejectionEpisode>
      <AcuteRejectionDate>2024-12-04T00:00:00</AcuteRejectionDate>
      <BiopsyPerformedCode>string 1</BiopsyPerformedCode>
      <ResponseConsideredCode>string 2</ResponseConsideredCode>
      <AntibodyMediatedCode>string 7</AntibodyMediatedCode>
      <DSACode>string 8</DSACode>
      <TCellMediatedCode>string 9</TCellMediatedCode>
      <AcuteBanffGCode>string 10</AcuteBanffGCode>
      <AcuteBanffICode>string 11</AcuteBanffICode>
      <AcuteBanffTCode>string 12</AcuteBanffTCode>
      <AcuteBanffVCode>string 13</AcuteBanffVCode>
      <AcuteBanffPTCCode>string 14</AcuteBanffPTCCode>
      <AcuteBanffC4DCode>string 15</AcuteBanffC4DCode>
      <AcuteBanffCGCode>string 16</AcuteBanffCGCode>
      <AcuteBanffCICode>string 17</AcuteBanffCICode>
      <AcuteBanffCTCode>string 18</AcuteBanffCTCode>
      <AcuteBanffCVCode>string 19</AcuteBanffCVCode>
      <AcuteBanffMMCode>string 20</AcuteBanffMMCode>
      <AcuteBanffAHCode>string 21</AcuteBanffAHCode>
      <AcuteBanffTICode>string 22</AcuteBanffTICode>
      <AcuteBanffIIFTACode>string 23</AcuteBanffIIFTACode>
      <RejectionTreatments>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
      </RejectionTreatments>
      <TreatmentResponseCode>string 24</TreatmentResponseCode>
      <Comments>string 25</Comments>
    </RejectionEpisode>
    <RejectionEpisode>
      <AcuteRejectionDate>2024-12-04T00:00:00</AcuteRejectionDate>
      <BiopsyPerformedCode>string 1</BiopsyPerformedCode>
      <ResponseConsideredCode>string 2</ResponseConsideredCode>
      <AntibodyMediatedCode>string 7</AntibodyMediatedCode>
      <DSACode>string 8</DSACode>
      <TCellMediatedCode>string 9</TCellMediatedCode>
      <AcuteBanffGCode>string 10</AcuteBanffGCode>
      <AcuteBanffICode>string 11</AcuteBanffICode>
      <AcuteBanffTCode>string 12</AcuteBanffTCode>
      <AcuteBanffVCode>string 13</AcuteBanffVCode>
      <AcuteBanffPTCCode>string 14</AcuteBanffPTCCode>
      <AcuteBanffC4DCode>string 15</AcuteBanffC4DCode>
      <AcuteBanffCGCode>string 16</AcuteBanffCGCode>
      <AcuteBanffCICode>string 17</AcuteBanffCICode>
      <AcuteBanffCTCode>string 18</AcuteBanffCTCode>
      <AcuteBanffCVCode>string 19</AcuteBanffCVCode>
      <AcuteBanffMMCode>string 20</AcuteBanffMMCode>
      <AcuteBanffAHCode>string 21</AcuteBanffAHCode>
      <AcuteBanffTICode>string 22</AcuteBanffTICode>
      <AcuteBanffIIFTACode>string 23</AcuteBanffIIFTACode>
      <RejectionTreatments>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
        <RejectionTreatment>
          <TreatmentNo>1</TreatmentNo>
          <TreatmentCode>string 1</TreatmentCode>
          <TreatmentOther>string 2</TreatmentOther>
        </RejectionTreatment>
      </RejectionTreatments>
      <TreatmentResponseCode>string 24</TreatmentResponseCode>
      <Comments>string 25</Comments>
    </RejectionEpisode>
  </RejectionEpisodes>
</RejectionEpisodes>

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

RejectionEpisode

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
AcuteBanffAHCode	Acute BanffAH Code	String	10	Acute Banff Indices Codes
AcuteBanffC4DCode	Acute Banff C4D Code	String	10	Acute Banff Indices Codes
AcuteBanffCGCode	Acute BanffCG Code	String	10	Acute Banff Indices Codes
AcuteBanffCICode	Acute BanffCI Code	String	10	Acute Banff Indices Codes
AcuteBanffCTCode	Acute BanffCT Code	String	10	Acute Banff Indices Codes
AcuteBanffCVCode	Acute BanffCV Code	String	10	Acute Banff Indices Codes
AcuteBanffGCode	Acute BanffG Code	String	10	Acute Banff Indices Codes
AcuteBanffICode	Acute BanffI Code	String	10	Acute Banff Indices Codes
AcuteBanffIIFTACode	Acute BanffIIFTA Code	String	10	Acute Banff Indices Codes
AcuteBanffMMCode	Acute BanffMM Code	String	10	Acute Banff Indices Codes
AcuteBanffPTCCode	Acute BanffPTC Code	String	10	Acute Banff Indices Codes
AcuteBanffTCode	Acute BanffT Code	String	10	Acute Banff Indices Codes
AcuteBanffTICode	Acute BanffTI Code	String	10	Acute Banff Indices Codes
AcuteBanffVCode	Acute BanffV Code	String	10	Acute Banff Indices Codes
AcuteRejectionDate	Treatment number	Date			Required.
AntibodyMediatedCode	Antibody Mediated Code	String	10	Yes No Codes
BiopsyPerformedCode		String	10	Biopsy Performed Codes	Required.
Comments	Comments	String
DSACode	DSA Code	String	10	Donor Specific Antibody Codes	Required if the AntibodyMediatedCode value provided is not "1" (Nil).
ResponseConsideredCode	Response Considered Code	String	10	Rejection Considered Codes	Required if BiopsyPerformedCode of "N" is provided.
TCellMediatedCode	TCell Mediated Code	String	10	Yes No Codes
TreatmentResponseCode	Treatment Response Code	String	10	Rejection Treatment Response Codes

RejectionTreatments

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
TreatmentCode	Treatment code	String	10	Rejection Treatment Codes	Applies to multiple columns: TreatmentCode1, TreatmentCode2, ... TreatmentCode{n} Can be up to 'n' number of columns, where n must be sequential starting from 1.
TreatmentOther	Treatment other	String	50		Applies to multiple columns: TreatmentOther1, TreatmentOther2, ... TreatmentOther{n} Can be up to 'n' number of columns, where n must be sequential starting from 1.

Attribute

Variable Label

Type

Length
(Precision, Scale)

Code

Comments

TreatmentCode

Treatment code

String

Rejection Treatment Codes

Applies to multiple columns: TreatmentCode1, TreatmentCode2, ... TreatmentCode{n}
Can be up to 'n' number of columns, where n must be sequential starting from 1.

TreatmentOther

Treatment other

String

Applies to multiple columns: TreatmentOther1, TreatmentOther2, ... TreatmentOther{n}
Can be up to 'n' number of columns, where n must be sequential starting from 1.