Jump to

• Request
• Response
• Examples

Retrieve Patient Query Results for a Query Identifier

get

/ohfapi/cg/v3.3/patientapi/patients/queries/{id}/data

This endpoint supports the retrieval of Patient Identifiers resulted as response to the Query.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• apiContext: string
• id: integer(int64)
  Minimum Value: 0

  Query ID

Query Parameters

• limit(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0
• offset(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : PatientId

Type: object

Show Source

• patientId(optional): integer
  Patient Row ID
• patientIdentifier(optional): string
  Patient Identifier

{
    "type":"object",
    "properties":{
        "patientId":{
            "type":"integer",
            "description":"Patient Row ID"
        },
        "patientIdentifier":{
            "type":"string",
            "description":"Patient Identifier"
        }
    }
}

400 Response

Invalid request parameters

404 Response

Query not found

Back to Top

Examples

The following example shows how to view patient IDs for a query by submitting a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/patientsqueries/989/data

Example of Response Body

The following example shows the response returned in JSON format.

{
  "items": [
    {
      "patientId": 59518,
      "patientIdentifier": "OBFUSCATED_59518"
    },
    {
      "patientId": 59539,
      "patientIdentifier": "OBFUSCATED_59539"
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/queries/989/data"
    }
  ]
}

Back to Top