Jump to

• Request
• Response

Retrieve events for a Cohort

get

/ohfapi/cg/v3.3/cohortlists/{id}/events

This endpoint retreives the Patient Cohort events for a cohort - by Cohort Identifier .It returns a list of CohortEvent that includes information like Patient Id, Event Type, Event Name, start date, end date of the events.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: integer(int64)
  Minimum Value: 0

  Cohort ID

Query Parameters

• dateType(optional): string
  Clinical Filter query params: ?filter=ClinicalEventFilter

  Allowed Values: [ "start_date", "end_date" ]
• dimensionRowIds(optional): array
  Collection Format: multi

  Clinical Filter query params: ?filter=ClinicalEventFilter

  • [0]: integer(int64)

  {
      "name":"dimensionRowIds",
      "in":"query",
      "description":"Clinical Filter query params: ?filter=ClinicalEventFilter",
      "required":false,
      "type":"array",
      "items":{
          "type":"integer",
          "format":"int64"
      },
      "collectionFormat":"multi"
  }

• dimensionType(optional): string
  Clinical Filter query params: ?filter=ClinicalEventFilter

  Allowed Values: [ "Diagnosis", "Procedure", "Medication", "Observation", "Consent", "History", "PatientHistory", "Specimen", "Encounter" ]
• endDate(optional): string
  Clinical Filter query params: ?filter=ClinicalEventFilter
• eventTypes(optional): array
  Collection Format: multi

  Clinical Filter query params: ?filter=ClinicalEventFilter

  • [0]: string
    Allowed Values: [ "Diagnosis", "Procedure", "Medication", "Observation", "Consent", "History", "PatientHistory", "Specimen", "Encounter" ]

  {
      "name":"eventTypes",
      "in":"query",
      "description":"Clinical Filter query params: ?filter=ClinicalEventFilter",
      "required":false,
      "type":"array",
      "items":{
          "type":"string",
          "enum":[
              "Diagnosis",
              "Procedure",
              "Medication",
              "Observation",
              "Consent",
              "History",
              "PatientHistory",
              "Specimen",
              "Encounter"
          ]
      },
      "collectionFormat":"multi"
  }

• latestOnly(optional): boolean
  Clinical Filter query params: ?filter=ClinicalEventFilter
• limit(optional): integer(int32)
  Number of rows to return
• offset(optional): integer(int32)
  Row number to start from
• patientIdentifiers(optional): array
  Collection Format: multi

  Clinical Filter query params: ?filter=ClinicalEventFilter

  • [0]: string

  {
      "name":"patientIdentifiers",
      "in":"query",
      "description":"Clinical Filter query params: ?filter=ClinicalEventFilter",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• patientRowIds(optional): array
  Collection Format: multi

  Clinical Filter query params: ?filter=ClinicalEventFilter

  • [0]: integer(int64)

  {
      "name":"patientRowIds",
      "in":"query",
      "description":"Clinical Filter query params: ?filter=ClinicalEventFilter",
      "required":false,
      "type":"array",
      "items":{
          "type":"integer",
          "format":"int64"
      },
      "collectionFormat":"multi"
  }

• startDate(optional): string
  Clinical Filter query params: ?filter=ClinicalEventFilter

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

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
  A boolean indicating if more pages are available.
• items(optional): array items
  A collection of paged items.
• links(optional): array links
  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":{
                "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."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "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":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Serializable"
    }
}

Nested Schema : links

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":{
        "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

Back to Top