REST API for Oracle Healthcare Translational Research

Retrieve Saved Cohort Lists

get

/HSDataService-web/api/3.2.0/cohortlists

This endpoint supports the retrieval of Cohort Lists saved for the Logged in User.It returns Cohort List information like Description, Context, Privacy and other Cohort List associated information.

Request

Supported Media Types

application/json
application/xml

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 : PageableCollectionCohortList

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 CohortList

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 : CohortList

Type: object

Properties

cohortListDescription: Type: string
cohortListDetails: Type: object LinkedReference
cohortListId: Type: integer (int64)
cohortListName: Type: string
contextFlag: Type: string
createdDate: Type: string (date-time)
ownedBy: Type: string
privacy: Type: string

Allowed Values: [ "PUBLIC", "PRIVATE", "SHARED" ]

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

400 Response

Invalid parameters supplied

404 Response

Cohort List(s) not found

Examples

The following example submits a GET request.

API URL

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

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "CohortLists",
  "items": [
    {
      "cohortListId": 10000000002102,
      "cohortListName": "TestList_1",
      "cohortListDescription": "Changed List",
      "contextFlag": "PATIENT",
      "privacy": "PRIVATE",
      "createdDate": "12/05/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/HSDataService-web/api/3.2.0/cohortlists/10000000002102"
      }
    },
    {
      "cohortListId": 10000000003004,
      "cohortListName": "null 40 List",
      "cohortListDescription": " ",
      "contextFlag": "PATIENT",
      "privacy": "SHARED",
      "createdDate": "10/19/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/HSDataService-web/api/3.2.0/cohortlists/10000000003004"
      }
    },
    {
      "cohortListId": 10000000003006,
      "cohortListName": "New List",
      "cohortListDescription": "New List Description",
      "contextFlag": "PATIENT",
      "privacy": "PUBLIC",
      "createdDate": "11/17/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/HSDataService-web/api/3.2.0/cohortlists/10000000003006"
      }
    },
    {
      "cohortListId": 10000000003008,
      "cohortListName": "Cohort_List_Test2",
      "cohortListDescription": "Cohort_List_Test1",
      "contextFlag": "PATIENT",
      "privacy": "PRIVATE",
      "createdDate": "11/22/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/HSDataService-web/api/3.2.0/cohortlists/10000000003008"
      }
    },
    {
      "cohortListId": 10000000003014,
      "cohortListName": "Cohort_List_Test3",
      "cohortListDescription": "Cohort_List_Test3",
      "contextFlag": "PATIENT",
      "privacy": "PRIVATE",
      "createdDate": "11/22/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/HSDataService-web/api/3.2.0/cohortlists/10000000003014"
      }
    }
  ],
  "count": 5,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:9010/HSDataService-web/api/3.2.0/cohortlists?limit=5"
    },
    {
      "rel": "next",
      "href": "http://localhost:9010/HSDataService-web/api/3.2.0/cohortlists?offset=5&limit=5"
    }
  ]
}