Clinical Genomic APIs for Oracle Healthcare Foundation

Retrieve Cohort List Members for a Cohort List Identifier

get

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

Cohort List ID

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

No data found

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/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/ohfapi/cg/v3.3/cohortlists/10000000002102"
    }
  ]
}