api/patient/details/{id}

Method: GET

Retrieve current details for an existing ANZDATA patient.

Request Information

URI

https://services.anzdata.org.au/webservices/api/patient/details/{id}

Parameters

Name	Description	Additional information
id	The ANZDATA Patient ID / Registry Number	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "PatientId": 1,
  "Physician": {
    "Code": 1,
    "Surname": "string 2",
    "GivenName": "string 3",
    "PracticeCode": "string 4"
  },
  "InitialCentreTransfer": {
    "TransferDate": "2024-12-04T00:00:00",
    "ParentCentreCode": "string 2",
    "ParentCentreMRN": "string 3",
    "CentreCode": "string 4",
    "CentreMRN": "string 5"
  },
  "CurrentCentreTransfer": {
    "TransferDate": "2024-12-04T00:00:00",
    "ParentCentreCode": "string 2",
    "ParentCentreMRN": "string 3",
    "CentreCode": "string 4",
    "CentreMRN": "string 5"
  },
  "Surname": "string 2",
  "GivenName": "string 3",
  "DateOfBirth": "2024-12-04T00:00:00",
  "GenderCode": "string 4",
  "BirthCountryCode": "string 5",
  "BirthCountryOther": "string 6",
  "Ethnicity1Code": "string 7",
  "Ethnicity1Other": "string 8",
  "Ethnicity2Code": "string 9",
  "Ethnicity2Other": "string 10",
  "LateReferralCode": "string 11",
  "CreatinineAtEntry": 1,
  "Height": 1.0,
  "Weight": 1.0,
  "SmokingCode": "string 12",
  "PrimaryRenalDiseaseCode": "string 13",
  "PrimaryRenalDiseaseOther": "string 14",
  "PrimaryKidneyDiseaseCode": 1,
  "BiopsyCode": "string 15",
  "GeneticTestCode": "string 16",
  "GeneticTestDiagnosisCode": "string 17",
  "CausativeGeneCode": "string 18",
  "CurrentTreatment": {
    "TreatmentDate": "2024-12-04T00:00:00",
    "TreatmentCode": "string 2",
    "ReasonCode": "string 3",
    "ReasonOther": "string 4",
    "GraftFailureCauseCode": "string 5",
    "GraftFailureCauseOther": "string 6",
    "GraftFailureSerumCreatinine": 1,
    "DeathCauseCode": "string 7",
    "DeathCauseOther": "string 8",
    "GraftSustainingLifeCode": "string 9"
  },
  "CurrentTransplant": {
    "GraftNo": 1,
    "TransplantDate": "2024-12-04T00:00:00"
  }
}

application/xml, text/xml

Sample:

<Patient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PatientId>1</PatientId>
  <Physician>
    <Code>1</Code>
    <Surname>string 2</Surname>
    <GivenName>string 3</GivenName>
    <PracticeCode>string 4</PracticeCode>
  </Physician>
  <InitialCentreTransfer>
    <TransferDate>2024-12-04T00:00:00</TransferDate>
    <ParentCentreCode>string 2</ParentCentreCode>
    <ParentCentreMRN>string 3</ParentCentreMRN>
    <CentreCode>string 4</CentreCode>
    <CentreMRN>string 5</CentreMRN>
  </InitialCentreTransfer>
  <CurrentCentreTransfer>
    <TransferDate>2024-12-04T00:00:00</TransferDate>
    <ParentCentreCode>string 2</ParentCentreCode>
    <ParentCentreMRN>string 3</ParentCentreMRN>
    <CentreCode>string 4</CentreCode>
    <CentreMRN>string 5</CentreMRN>
  </CurrentCentreTransfer>
  <Surname>string 2</Surname>
  <GivenName>string 3</GivenName>
  <DateOfBirth>2024-12-04T00:00:00</DateOfBirth>
  <GenderCode>string 4</GenderCode>
  <BirthCountryCode>string 5</BirthCountryCode>
  <BirthCountryOther>string 6</BirthCountryOther>
  <Ethnicity1Code>string 7</Ethnicity1Code>
  <Ethnicity1Other>string 8</Ethnicity1Other>
  <Ethnicity2Code>string 9</Ethnicity2Code>
  <Ethnicity2Other>string 10</Ethnicity2Other>
  <LateReferralCode>string 11</LateReferralCode>
  <CreatinineAtEntry>1</CreatinineAtEntry>
  <Height>1</Height>
  <Weight>1</Weight>
  <SmokingCode>string 12</SmokingCode>
  <PrimaryRenalDiseaseCode>string 13</PrimaryRenalDiseaseCode>
  <PrimaryRenalDiseaseOther>string 14</PrimaryRenalDiseaseOther>
  <PrimaryKidneyDiseaseCode>1</PrimaryKidneyDiseaseCode>
  <BiopsyCode>string 15</BiopsyCode>
  <GeneticTestCode>string 16</GeneticTestCode>
  <GeneticTestDiagnosisCode>string 17</GeneticTestDiagnosisCode>
  <CausativeGeneCode>string 18</CausativeGeneCode>
  <CurrentTreatment>
    <TreatmentDate>2024-12-04T00:00:00</TreatmentDate>
    <TreatmentCode>string 2</TreatmentCode>
    <ReasonCode>string 3</ReasonCode>
    <ReasonOther>string 4</ReasonOther>
    <GraftFailureCauseCode>string 5</GraftFailureCauseCode>
    <GraftFailureCauseOther>string 6</GraftFailureCauseOther>
    <GraftFailureSerumCreatinine>1</GraftFailureSerumCreatinine>
    <DeathCauseCode>string 7</DeathCauseCode>
    <DeathCauseOther>string 8</DeathCauseOther>
    <GraftSustainingLifeCode>string 9</GraftSustainingLifeCode>
  </CurrentTreatment>
  <CurrentTransplant>
    <GraftNo>1</GraftNo>
    <TransplantDate>2024-12-04T00:00:00</TransplantDate>
  </CurrentTransplant>
</Patient>

Attribute Details

PatientDetail

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
BiopsyCode	Was native kidney biopsied?	String	10	Yes No Codes
BirthCountryCode	Country of birth	String	10	Country Of Birth Codes
BirthCountryOther	Country of birth other	String	50		Required if BirthCountryCode of "Specify" is provided.
CausativeGeneCode	PKD Causative Gene as Diagnosed from test	String	10	Causative Gene Codes	Must be provided when GeneticTestDiagnosisCode is Y.
CreatinineAtEntry	Serum creatinine at entry	Number			Value should be between 150 and 2500 (warning only). Value must be between 0 and 4235.
DateOfBirth	Date of birth	Date			Required.
Ethnicity1Code	Ethnicity 1 Code	String	10	Racial Ethnic Origin Codes
Ethnicity1Other	Ethnicity 1 Other specify	String	200
Ethnicity2Code	Ethnicity 2 Code	String	10	Racial Ethnic Origin Codes
Ethnicity2Other	Ethnicity 2 Other specify	String	200
GenderCode	Gender	String	10	Gender Codes	Required.
GeneticTestCode	Genetic Test	String	10	Yes No Codes
GeneticTestDiagnosisCode	PKD Diagnosis from Test	String	10	Yes No Unknown Codes	Must be provided when GeneticTestCode is Y.
GivenName	Patient's given name	String	50		Required.
Height	Height at RRT entry (cm)	Number	Decimal(4, 1)		Value must be between 30 and 250.
InitialCentreCode	Initial centre/facility	String	10	Facility Codes	Required.
InitialCentreMRN	Initial centre/facility Medical Record Number	String	10		Required.
InitialParentCentreCode	Initial parent centre	String	10	Facility Codes	Required.
InitialParentCentreMRN	Initial parent centre Medical Record Number	String	10		Required.
LateReferralCode	Late referral seen <3 months before 1st treatment	String	10	Yes No Codes
PrimaryKidneyDiseaseCode	Primary kidney disease	Number		Primary Kidney Disease Codes	Replaces old PrimaryRenalDiseaseCode. New PrimaryKidneyDiseaseCode is inline with ERA-EDTA Registry PKD Codes. Valid codes are dependant on associated field, refer to 'Valid for' column on Codes page.
PrimaryRenalDiseaseCode	Primary renal disease	String	10	Renal Disease Codes	Variable collection ended: 2022-11-22 Replaced by new variable PrimaryKidneyDiseaseCode.
PrimaryRenalDiseaseOther	Primary renal disease other	String	50		Required if PrimaryRenalDiseaseCode of "Specify" is provided. Variable collection ended: 2022-11-22
SmokingCode	Smoking status at RRT entry	String	10	Smoking Codes
Surname	Patient's surname	String	50		Required.
Weight	Weight at RRT entry (kg)	Number	Decimal(4, 1)		Value must be between 1 and 300.

Physician

Attribute	Type	Length (Precision, Scale)	Code
Code	Number
GivenName	String	50
PracticeCode	String	10	Practice Codes
Surname	String	50

Transfer

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
CentreCode	Centre/facility of transfer	String	10	Facility Codes
CentreMRN	Centre/facility Medical Record Number	String	10
ParentCentreCode	Parent centre of transfer	String	10	Facility Codes	Required.
ParentCentreMRN	Parent centre Medical Record Number	String	10
TransferDate	Date of transfer	Date			Required.

Transplant

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
GraftNo	Graft number	Number			Required.
TransplantDate	Date of this transplant	Date			Required.

Treatment

Attribute	Variable Label	Type	Length (Precision, Scale)	Code	Comments
DeathCauseCode	Cause of death	String	10	Anzdata Cause Of Death Codes	Required if TreatmentCode is "Z".
DeathCauseOther	Other cause of death	String	200		Required if DeathCauseCode of "Specify" is provided.
GraftFailureCauseCode	Cause of graft failure	String	10	Cause Of Graft Failure Codes	Required if TreatmentCode is "P".
GraftFailureCauseOther	Other causes of graft failure	String	200		Required if GraftFailureCauseCode of "Specify" is provided.
GraftFailureSerumCreatinine	Serum Creatinine at graft failure	Number			Required if TreatmentCode is "P". Value should be between 150 and 2500 (warning only). Value must be between 0 and 4235.
GraftSustainingLifeCode	Was graft sustaining life at time of death?	String	10	Yes No Codes	Required if TreatmentCode is "Z" and the Patient had a current functioning Graft at time of death.
ReasonCode	Reason transfer from dialysis during survey	String	10	Change Treatment Reason Codes	Required if treatment has changed from HD to PD or PD to HD.
ReasonOther	Description of other reason for transfer	String	200		Required if ReasonCode of "Specify" is provided.
TreatmentCode	Treatment code	String	10	Course Of Treatment Codes	Required. Initial Renal Replacement Therapy must be a transplant (G, X), a non-hybrid HD (B, D, F, Y) or a non-hybrid PD (E, M) treatment.
TreatmentDate	Treatment date	Date			Required.