api/resolve/enrolmentsearch

Method: GET

Search for Trial Enrolment records.

The search parameter must be provided in the request body.

Request Information

URI

https://services.anzdata.org.au/webservices/api/resolve/enrolmentsearch

Parameters

Name	Description	Additional information
value	Trial Enrolment Search Parameter 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:

{
  "AnzdataPatientId": 1,
  "EnrolmentStatusCode": 1,
  "AtEnrolmentFacilityCode": "string 2",
  "CurrentFacilityCode": "string 3"
}

application/xml, text/xml

Sample:

<EnrolmentSearch xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AnzdataPatientId>1</AnzdataPatientId>
  <EnrolmentStatusCode>1</EnrolmentStatusCode>
  <AtEnrolmentFacilityCode>string 2</AtEnrolmentFacilityCode>
  <CurrentFacilityCode>string 3</CurrentFacilityCode>
</EnrolmentSearch>

Response Information

Response body formats

application/json, text/json

Sample:

{
  "TrialParticipants": [
    {
      "AnzdataPatientId": 1,
      "RESOLVEPatientId": "string 2",
      "Surname": "string 3",
      "GivenName": "string 4",
      "EnrolmentStatusCode": "string 5",
      "EnrolmentStatus": "string 6",
      "EnrolmentDate": "2024-12-04T00:00:00",
      "AtEnrolmentRenalUnitCode": "string 8",
      "AtEnrolmentFacilityCode": "string 9",
      "CurrentRenalUnitCode": "string 10",
      "CurrentFacilityCode": "string 11",
      "CurrentTreatment": "string 12"
    },
    {
      "AnzdataPatientId": 1,
      "RESOLVEPatientId": "string 2",
      "Surname": "string 3",
      "GivenName": "string 4",
      "EnrolmentStatusCode": "string 5",
      "EnrolmentStatus": "string 6",
      "EnrolmentDate": "2024-12-04T00:00:00",
      "AtEnrolmentRenalUnitCode": "string 8",
      "AtEnrolmentFacilityCode": "string 9",
      "CurrentRenalUnitCode": "string 10",
      "CurrentFacilityCode": "string 11",
      "CurrentTreatment": "string 12"
    },
    {
      "AnzdataPatientId": 1,
      "RESOLVEPatientId": "string 2",
      "Surname": "string 3",
      "GivenName": "string 4",
      "EnrolmentStatusCode": "string 5",
      "EnrolmentStatus": "string 6",
      "EnrolmentDate": "2024-12-04T00:00:00",
      "AtEnrolmentRenalUnitCode": "string 8",
      "AtEnrolmentFacilityCode": "string 9",
      "CurrentRenalUnitCode": "string 10",
      "CurrentFacilityCode": "string 11",
      "CurrentTreatment": "string 12"
    }
  ]
}

application/xml, text/xml

Sample:

<TrialEnrolmentSearchResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TrialParticipants>
    <Participant>
      <AnzdataPatientId>1</AnzdataPatientId>
      <RESOLVEPatientId>string 2</RESOLVEPatientId>
      <Surname>string 3</Surname>
      <GivenName>string 4</GivenName>
      <EnrolmentStatusCode>string 5</EnrolmentStatusCode>
      <EnrolmentStatus>string 6</EnrolmentStatus>
      <EnrolmentDate>2024-12-04T00:00:00</EnrolmentDate>
      <AtEnrolmentRenalUnitCode>string 8</AtEnrolmentRenalUnitCode>
      <AtEnrolmentFacilityCode>string 9</AtEnrolmentFacilityCode>
      <CurrentRenalUnitCode>string 10</CurrentRenalUnitCode>
      <CurrentFacilityCode>string 11</CurrentFacilityCode>
      <CurrentTreatment>string 12</CurrentTreatment>
    </Participant>
    <Participant>
      <AnzdataPatientId>1</AnzdataPatientId>
      <RESOLVEPatientId>string 2</RESOLVEPatientId>
      <Surname>string 3</Surname>
      <GivenName>string 4</GivenName>
      <EnrolmentStatusCode>string 5</EnrolmentStatusCode>
      <EnrolmentStatus>string 6</EnrolmentStatus>
      <EnrolmentDate>2024-12-04T00:00:00</EnrolmentDate>
      <AtEnrolmentRenalUnitCode>string 8</AtEnrolmentRenalUnitCode>
      <AtEnrolmentFacilityCode>string 9</AtEnrolmentFacilityCode>
      <CurrentRenalUnitCode>string 10</CurrentRenalUnitCode>
      <CurrentFacilityCode>string 11</CurrentFacilityCode>
      <CurrentTreatment>string 12</CurrentTreatment>
    </Participant>
    <Participant>
      <AnzdataPatientId>1</AnzdataPatientId>
      <RESOLVEPatientId>string 2</RESOLVEPatientId>
      <Surname>string 3</Surname>
      <GivenName>string 4</GivenName>
      <EnrolmentStatusCode>string 5</EnrolmentStatusCode>
      <EnrolmentStatus>string 6</EnrolmentStatus>
      <EnrolmentDate>2024-12-04T00:00:00</EnrolmentDate>
      <AtEnrolmentRenalUnitCode>string 8</AtEnrolmentRenalUnitCode>
      <AtEnrolmentFacilityCode>string 9</AtEnrolmentFacilityCode>
      <CurrentRenalUnitCode>string 10</CurrentRenalUnitCode>
      <CurrentFacilityCode>string 11</CurrentFacilityCode>
      <CurrentTreatment>string 12</CurrentTreatment>
    </Participant>
  </TrialParticipants>
</TrialEnrolmentSearchResults>

Attribute Details

Request Parameters / Participants

Attribute	Type	Length (Precision, Scale)	Code	Comments
AnzdataPatientId	Number			ANZDATA Registry Number
AtEnrolmentFacilityCode	String	10	Facility Codes	Facility Code as at Enrolment Date
AtEnrolmentRenalUnitCode	String	10	Facility Codes	Renal Unit Code as at Enrolment Date
CurrentFacilityCode	String	10	Facility Codes	Current Facility Code
CurrentRenalUnitCode	String	10	Facility Codes	Current Renal Unit Code
CurrentTreatment	String	250		Current Treatment Description
EnrolmentDate	Date
EnrolmentStatus	String	250		Enrolment Status Description
EnrolmentStatusCode	Number		Trial Patient Status Codes	Enrolment Status
GivenName	String	50
RESOLVEPatientId	String	100		RESOLVE Patient Id
Surname	String	50