api/dialysis/peritonitisepisode/{id} 

Methods: POST, PATCH

Create or update Peritonitis Episode record for an existing ANZDATA patient.

Request Information

URI

https://services.anzdata.org.au/webservices/api/dialysis/peritonitisepisode/{id}

Parameters

Name Description Additional information

id

The ANZDATA Patient ID / Registry Number

Define this parameter in the request URI.

value

Peritonitis 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: 
{
  "TypePDInfectionCode": 1,
  "InfectionDate": "2024-12-04T00:00:00",
  "RelapseRecurrenceCode": "string 4",
  "PeritonitisOrganisms": [
    {
      "OrganismCode": "string 3",
      "OrganismOther": "string 4"
    },
    {
      "OrganismCode": "string 3",
      "OrganismOther": "string 4"
    },
    {
      "OrganismCode": "string 3",
      "OrganismOther": "string 4"
    }
  ],
  "AntifungalTherapyCode": "string 6",
  "InitialAntibiotic1Code": "string 7",
  "InitialAntibiotic1Other": "string 8",
  "InitialAntibiotic2Code": "string 9",
  "InitialAntibiotic2Other": "string 10",
  "InitialAntibiotic3Code": "string 11",
  "InitialAntibiotic3Other": "string 12",
  "FinalAntibioticDoseDate": "2024-12-04T00:00:00",
  "FinalAntibiotic1Code": "string 13",
  "FinalAntibiotic1Other": "string 14",
  "FinalAntibiotic2Code": "string 15",
  "FinalAntibiotic2Other": "string 16",
  "FinalAntibiotic3Code": "string 17",
  "FinalAntibiotic3Other": "string 18",
  "GlucoseCode": "string 19",
  "ICODextrinCode": "string 20",
  "LowGDPCode": "string 21",
  "OtherPD": "string 22",
  "OvernightHospitalisationCode": "string 23",
  "HospitalisationNights": 1,
  "CatheterRemovedCode": "string 24",
  "CatheterRemovedDate": "2024-12-04T00:00:00",
  "InterimHDCode": "string 25",
  "FirstDialysisDate": "2024-12-04T00:00:00",
  "LastDialysisDate": "2024-12-04T00:00:00",
  "PermanentHDCode": "string 26",
  "PermanentHDDate": "2024-12-04T00:00:00",
  "Comments": "string 27"
}

application/xml, text/xml

Sample: 
<PeriotonitisEpisode xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TypePDInfectionCode>1</TypePDInfectionCode>
  <InfectionDate>2024-12-04T00:00:00</InfectionDate>
  <RelapseRecurrenceCode>string 4</RelapseRecurrenceCode>
  <PeritonitisOrganisms>
    <PeritonitisOrganism>
      <OrganismCode>string 3</OrganismCode>
      <OrganismOther>string 4</OrganismOther>
    </PeritonitisOrganism>
    <PeritonitisOrganism>
      <OrganismCode>string 3</OrganismCode>
      <OrganismOther>string 4</OrganismOther>
    </PeritonitisOrganism>
    <PeritonitisOrganism>
      <OrganismCode>string 3</OrganismCode>
      <OrganismOther>string 4</OrganismOther>
    </PeritonitisOrganism>
  </PeritonitisOrganisms>
  <AntifungalTherapyCode>string 6</AntifungalTherapyCode>
  <InitialAntibiotic1Code>string 7</InitialAntibiotic1Code>
  <InitialAntibiotic1Other>string 8</InitialAntibiotic1Other>
  <InitialAntibiotic2Code>string 9</InitialAntibiotic2Code>
  <InitialAntibiotic2Other>string 10</InitialAntibiotic2Other>
  <InitialAntibiotic3Code>string 11</InitialAntibiotic3Code>
  <InitialAntibiotic3Other>string 12</InitialAntibiotic3Other>
  <FinalAntibioticDoseDate>2024-12-04T00:00:00</FinalAntibioticDoseDate>
  <FinalAntibiotic1Code>string 13</FinalAntibiotic1Code>
  <FinalAntibiotic1Other>string 14</FinalAntibiotic1Other>
  <FinalAntibiotic2Code>string 15</FinalAntibiotic2Code>
  <FinalAntibiotic2Other>string 16</FinalAntibiotic2Other>
  <FinalAntibiotic3Code>string 17</FinalAntibiotic3Code>
  <FinalAntibiotic3Other>string 18</FinalAntibiotic3Other>
  <GlucoseCode>string 19</GlucoseCode>
  <ICODextrinCode>string 20</ICODextrinCode>
  <LowGDPCode>string 21</LowGDPCode>
  <OtherPD>string 22</OtherPD>
  <OvernightHospitalisationCode>string 23</OvernightHospitalisationCode>
  <HospitalisationNights>1</HospitalisationNights>
  <CatheterRemovedCode>string 24</CatheterRemovedCode>
  <CatheterRemovedDate>2024-12-04T00:00:00</CatheterRemovedDate>
  <InterimHDCode>string 25</InterimHDCode>
  <FirstDialysisDate>2024-12-04T00:00:00</FirstDialysisDate>
  <LastDialysisDate>2024-12-04T00:00:00</LastDialysisDate>
  <PermanentHDCode>string 26</PermanentHDCode>
  <PermanentHDDate>2024-12-04T00:00:00</PermanentHDDate>
  <Comments>string 27</Comments>
</PeriotonitisEpisode>

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

PeriotonitisEpisode

Attribute Variable Label Type Length
(Precision, Scale)		 Code Comments
AntifungalTherapyCode Antifungal Therapy? String 10 Yes No Codes 

          

          

            CatheterRemovedCode
            Was catheter removed?
            String
            10
            Yes No Codes
            

          

          

            CatheterRemovedDate
            Date catheter was removed
            Date
            
            
            
Required if CatheterRemovedCode of "Y" is provided


          

          

            Comments
            Comments
            String
            
            
            

          

          

            FinalAntibiotic1Code
            Name of final regimen first antibiotic given
            String
            10
            Antibiotics Codes
            

          

          

            FinalAntibiotic1Other
            Final regimen first antibiotic given (other)
            String
            100
            
            
Required if FinalAntibiotic1Code of "Specify" is provided.


          

          

            FinalAntibiotic2Code
            Name of final regimen second antibiotic given
            String
            10
            Antibiotics Codes
            

          

          

            FinalAntibiotic2Other
            Final regimen second antibiotic given (other)
            String
            100
            
            
Required if FinalAntibiotic2Code of "Specify" is provided.


          

          

            FinalAntibiotic3Code
            Name of final regimen third antibiotic given
            String
            10
            Antibiotics Codes
            

          

          

            FinalAntibiotic3Other
            Final regimen third antibiotic given (other)
            String
            100
            
            
Required if FinalAntibiotic3Code of "Specify" is provided.


          

          

            FinalAntibioticDoseDate
            Date of last dose of antibiotic given
            Date
            
            
            

          

          

            FirstDialysisDate
            Date of first interim haemodialysis
            Date
            
            
            
Required if InterimHDCode of "Y" is provided.


          

          

            GlucoseCode
            Glucose PD Solution at time of infection?
            String
            10
            Yes No Codes
            

          

          

            HospitalisationNights
            Number of nights in hospital
            Number
            
            
            
Required if OvernightHospitalisationCode of "Y" is provided.
Value must be between 1 and 365.

          

          

            ICODextrinCode
            Icodextrin PD Solution at time of infection?
            String
            10
            Yes No Codes
            

          

          

            InfectionDate
            
            Date
            
            
            

          

          

            InitialAntibiotic1Code
            Name of initial regimen first antibiotic given
            String
            10
            Antibiotics Codes
            

          

          

            InitialAntibiotic1Other
            Initial regimen first antibiotic given (other)
            String
            100
            
            
Required if InitialAntibiotic1Code of "Specify" is provided.


          

          

            InitialAntibiotic2Code
            Name of initial regimen second antibiotic given
            String
            10
            Antibiotics Codes
            

          

          

            InitialAntibiotic2Other
            Initial regimen second antibiotic given (other)
            String
            100
            
            
Required if InitialAntibiotic2Code of "Specify" is provided.


          

          

            InitialAntibiotic3Code
            Name of initial regimen third antibiotic given
            String
            10
            Antibiotics Codes
            

          

          

            InitialAntibiotic3Other
            Initial regimen third antibiotic given (other)
            String
            100
            
            
Required if InitialAntibiotic3Code of "Specify" is provided.


          

          

            InterimHDCode
            Did patient have interim haemodialysis?
            String
            10
            Yes No Codes
            

          

          

            LastDialysisDate
            Date of last interim haemodialysis
            Date
            
            
            
Required if InterimHDCode of "Y" is provided.


          

          

            LowGDPCode
            Low GDP
            String
            10
            Yes No Codes
            

          

          

            OtherPD
            Other PD Solution at time of infection?
            String
            50
            
            

          

          

            OvernightHospitalisationCode
            Was patient hospitalised overnight?
            String
            10
            Yes No Codes
            

          

          

            PermanentHDCode
            Did patient transfer to permanent haemodialysis?
            String
            10
            Yes No Codes
            

          

          

            PermanentHDDate
            Date of permanent transfer to haemodialysis
            Date
            
            
            
Required if PermanentHDCode of "Y" is provided.


          

          

            RelapseRecurrenceCode
            Was this a relapse or recurrence of peritonitis?
            String
            10
            Relapse Recurrence Codes
            

          

          

            TypePDInfectionCode
            PD Infection type
            Number
            
            PD Infection Type Codes
            
Collected for Facilities/Centres participating in TEACH PD trials only.
Defaults to Code "1" (Peritonitis) for non TEACH PD trial participants.


          

      
    

    
PeritonitisOrganisms

    

      
        

          Attribute
          Variable Label
          Type
          Length
(Precision, Scale)		
          Code
          Comments
        

      
      
          

            OrganismCode
            Name of organism
            String
            10
            Peritonitis Organism Codes
            

          

          

            OrganismOther
            Name of organism other
            String
            50
            
            
Required if OrganismCode of "Specify" is provided.