Retrieve Patient Query Status for a Query Identifier
get
/ohfapi/cg/v3.3/patientapi/patients/queries/{id}
This end point supports the retrieval of Patient Query Status, Error Code, Error Message and other Status associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
apiContext: string
-
id: integer(int64)
Minimum Value:
0
Query ID
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : QueryExecutionStatus
Type:
Show Source
object
-
error(optional):
object QueryJobError
-
links(optional):
array links
A collection of links containing hrefs to query status and results
-
queryId(optional):
integer(int64)
-
status(optional):
string
Nested Schema : links
Type:
array
A collection of links containing hrefs to query status and results
Show Source
Example:
{rel: 'status',href: '/patientapi/patients/queries/{id}'}
400 Response
Invalid request parameters
404 Response
Query status not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/queries/986
Example of Response Body
The following example shows the response returned in JSON format.
{ "executeAsync": false, "minRetentionPeriodDays": 5, "queryCriteria": { "allCriteriaList": [ { "type": "ObservationCriteria", "exclude": false, "observationCodeList": [ "70443" ] }, { "type": "ConsentCriteria", "exclude": false, "consentTypeCodeList": [ "70" ], "consentStatusCodeList": [ "5" ] }, { "type": "MedicationCriteria", "exclude": false, "dosageUOMCodeList": [ "1001" ], "medicationCodeList": [ "1114470" ], "medicationStartDateRange": { "value": "01/01/2020", "op": { "code": "COMP_OP_GE" } }, "medicationEndDateRange": { "value": "01/31/2020", "op": { "code": "COMP_OP_LE" } }, "medicationDosageRange": { "value": 88, "op": { "code": "COMP_OP_EQ" } } }, { "type": "DiagnosisCriteria", "exclude": false, "diagnosisCodeList": [ "N179" ] }, { "type": "DemographicsCriteria", "exclude": false, "genderNameList": [ "FEMALE" ] }, { "type": "MicroarrayExpressionCriteria", "exclude": false, "maxPValue": 0.9, "intensityOperator": "<", "intensityAggregate": "AVG", "intensityFactor": 0.1, "aggregationMode": "1", "dualChannel": false, "geneInformation": { "type": "MicroarrayExpressionGeneDetails", "geneList": [ "BID", "YWHAB", "AKT1", "PPP3R1", "BCL2", "PPP3CC", "BAD" ], "dnaAlignmentList": [ "GRCh37" ] } } ] }, "queryId": 986, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/ohfapi/cg/v3.3/patientapi/patients/queries/986" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/patientapi/patients/queries/986/data" } ] } }