Clinical Genomic APIs for Oracle Healthcare Foundation

Retrieve Saved Cohort Lists

get

/ohfapi/cg/v3.3/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(optional): integer(int32)

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

Row number to start from

Security

basicAuth: basic

Type: basic

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Model for paginated collections of data.

Root Schema : PageableCollection

Type: object

Model for paginated collections of data.

Show Source

count(optional): integer(int64)

Number of objects in the 'items' collection.
hasMore(optional): boolean

Default Value: false

A boolean indicating if more pages are available.
items(optional): array items

A collection of paged items.
links(optional): array link

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

Identify the resource type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Serializable"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available.",
            "default":false
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

Array of: object Serializable

{
    "type":"array",
    "xml":{
        "name":"items",
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Serializable"
    }
}

Nested Schema : link

Type: array

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

Show Source

Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

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

Nested Schema : Serializable

Type: object

400 Response

Invalid parameters supplied

404 Response

Cohort List(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/cohortlists/10000000002102"
      }
    },
    {
      "cohortListId": 10000000003004,
      "cohortListName": "null 40 List",
      "cohortListDescription": " ",
      "contextFlag": "PATIENT",
      "privacy": "SHARED",
      "createdDate": "10/19/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/ohfapi/cg/v3.3/cohortlists/10000000003004"
      }
    },
    {
      "cohortListId": 10000000003006,
      "cohortListName": "New List",
      "cohortListDescription": "New List Description",
      "contextFlag": "PATIENT",
      "privacy": "PUBLIC",
      "createdDate": "11/17/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/ohfapi/cg/v3.3/cohortlists/10000000003006"
      }
    },
    {
      "cohortListId": 10000000003008,
      "cohortListName": "Cohort_List_Test2",
      "cohortListDescription": "Cohort_List_Test1",
      "contextFlag": "PATIENT",
      "privacy": "PRIVATE",
      "createdDate": "11/22/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/ohfapi/cg/v3.3/cohortlists/10000000003008"
      }
    },
    {
      "cohortListId": 10000000003014,
      "cohortListName": "Cohort_List_Test3",
      "cohortListDescription": "Cohort_List_Test3",
      "contextFlag": "PATIENT",
      "privacy": "PRIVATE",
      "createdDate": "11/22/2016",
      "ownedBy": "tester",
      "cohortListDetails": {
        "reference": "/ohfapi/cg/v3.3/cohortlists/10000000003014"
      }
    }
  ],
  "count": 5,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:9010/ohfapi/cg/v3.3/cohortlists?limit=5"
    },
    {
      "rel": "next",
      "href": "http://localhost:9010/ohfapi/cg/v3.3/cohortlists?offset=5&limit=5"
    }
  ]
}