Retrieve Patient Clinical Specimen Queries Status
get
/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries
This endpoint supports the retrieval of Patient Clinical Specimen Queries Status.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
apiContext: string
Patient/Subject API context
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
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : APIQueryStatus
Type:
Show Source
object
-
cohortQueryName(optional):
string
-
createdOnDate(optional):
string(date-time)
-
executeAsync(optional):
boolean
-
minRetentionPeriodDays(optional):
integer(int64)
Minimum Value:
0
-
queryCriteria(optional):
object AllCriteriaList
Contains all the Query Criteria
-
queryExecutionStatus(optional):
object QueryExecutionStatus
-
queryId(optional):
integer(int64)
-
retentionDate(optional):
string(date-time)
Nested Schema : AllCriteriaList
Type:
object
Contains all the Query Criteria
Show Source
-
allCriteriaList:
array allCriteriaList
Minimum Number of Items:
1
Maximum Number of Items:2147483647
List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria
Nested 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 : allCriteriaList
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
2147483647
List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria
Show Source
-
Array of:
object criteria
Discriminator:
type
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 shows how to view the status of a patient or subject clinical specimen query by submitting a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries
Example of Response Body
The following example shows the response returned in JSON format.
{ "items": [ { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1070, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1070" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1070/data" } ] } }, { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1069, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1069" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1069/data" } ] } }, { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1062, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1062" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1062/data" } ] } }, { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1061, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1061" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1061/data" } ] } }, { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1058, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1058" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/1058/data" } ] } } ], "count": 5, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries?limit=5" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries?offset=5&limit=5" } ] }