REST API for Oracle Healthcare Translational Research

Retrieve Cohort List Members for a Cohort List Identifier

get

/HSDataService-web/api/3.2.0/cohortlists/{id}

This endpoint supports the retrieval of Cohort List Member Identifiers by Cohort List Identifier.It returns information like Patient Identifiers for Patient Context's Cohort List and Subject Identifiers for Subject Context's Cohort List.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Cohort List ID

Query Parameters

limit: Type: integer (int32)

Number of rows to return
offset: Type: integer (int32)

Row number to start from

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollectionCohortListMember

Type: object

Model for paginated collections of data.

Properties

count: Type: integer (int64)

Number of objects in the 'items' collection.
hasMore: Type: boolean

Default Value: false

A boolean indicating if more pages are available.
items: Type: array items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object CohortListMember

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested Schema : CohortListMember

Type: object

Properties

patientWid: Type: integer (int64)
subjectWid: Type: integer (int64)

400 Response

Invalid parameters supplied

404 Response

No data found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/cohortlists/10000000002102

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "CohortListMembers",
  "items": [
    {
      "patientWid": 10000
    },
    {
      "patientWid": 100000
    },
    {
      "patientWid": 110000
    },
    {
      "patientWid": 120000
    },
    {
      "patientWid": 130000
    },
    {
      "patientWid": 140000
    },
    {
      "patientWid": 150000
    },
    {
      "patientWid": 160000
    }
  ],
  "count": 8,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "localhost:9010/HSDataService-web/api/3.2.0/cohortlists/10000000002102"
    }
  ]
}