Jump to

• Request
• Response

Find dimensions in events

get

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

This endpoint searches the events for the matching dimensions. The dimension records that starts with the value provided are returned.It returns matching dimensions (code & name) that starts with the value provided within the available events for the cohort. The reponse is a list of key value pair. The key is the row id of the dimension record and the value is the matching value (code or name) and the value is the

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• dimensiontype: string
  Event (Dimension) Type

  Allowed Values: [ "Diagnosis", "Procedure", "Medication", "Observation", "Consent", "History", "PatientHistory", "Specimen", "Encounter" ]
• id: integer(int64)
  Minimum Value: 0

  Cohort ID

Query Parameters

• value: string
  Dimensions (code or name) that starts with

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Invalid parameters supplied

404 Response

No data found

Back to Top