Jump to

• Request
• Response

Find dimensions

get

/ohfapi/cg/v3.3/dimension/{dimensiontype}

This end point find the matching dimension for the dimension type, in the dimension tables. Either of Code or Name is required. If the operator is null, then it defaults to equals. If limit is null then defaults to 100.The API returns the matching dimensions for the code / name provided.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• dimensiontype: string
  Dimension Type

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

Query Parameters

• code(optional): string
  Dimension code
• limit(optional): integer(int32)
  Result Limit count
• name(optional): string
  Dimension name
• operator(optional): string
  Operator type

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]

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