Retrieve Patient Query Results for a Query Identifier
get
/HSDataService-web/api/3.2.0/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
-
Type:
string
Required:true
- id
Type:integer
(int64
)Required:true
Query ID
Query Parameters
- limit
-
Type:
integer
(int32
)Pagination query params: ?limit=2&offset=0- offset
Type:integer
(int32
)Pagination query params: ?limit=2&offset=0
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Body
Root Schema : PatientId
Type:
object
- patientId
-
Type:
integer
Patient Row ID - patientIdentifier
-
Type:
string
Patient Identifier
400 Response
Invalid request parameters
404 Response
Query not found
Examples
The following example shows how to view patient IDs for a query by submitting a GET request.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/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:7001/HSDataService-web/api/3.2.0/patientapi/patients/queries/989/data" } ] }