REST API for Oracle Healthcare Translational Research

Retrieve Patient Clinical Specimen Queries Status

get

/HSDataService-web/api/3.2.0/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: Type: string

Required: true

Patient/Subject API context

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 : APIQueryStatus

Type: object

Properties

cohortQueryName: Type: string
createdOnDate: Type: string (date-time)
executeAsync: Type: boolean

Default Value: false
minRetentionPeriodDays: Type: integer (int64)

Minimum Value: 0
queryCriteria: Type: object OracleDBQueryDS

Contains all the Query Criteria
queryExecutionStatus: Type: object QueryExecutionStatus
queryId: Type: integer (int64)
retentionDate: Type: string (date-time)

Nested Schema : OracleDBQueryDS

Type: object

Contains all the Query Criteria

Properties

allCriteriaList: Type: array allCriteriaList

Required: true

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: object

Properties

error: Type: object QueryJobError
links: Type: array links

A collection of links containing hrefs to query status and results
queryId: Type: integer (int64)
status: Type: 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

Items

Type: object criteria

Discriminator: type

Nested Schema : criteria

Type: object

Discriminator: type

Properties

exclude: Type: boolean

Default Value: false

Nested Schema : QueryJobError

Type: object

Properties

errorCode: Type: string
errorMessage: Type: string

Nested Schema : links

Type: array

A collection of links containing hrefs to query status and results

Example

{rel: 'status',href: '/patientapi/patients/queries/{id}'}

Items

Type: string

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:7001/HSDataService-web/api/3.2.0/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": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1070"
          },
          {
            "rel": "result",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1070/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1069,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1069"
          },
          {
            "rel": "result",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1069/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1062,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1062"
          },
          {
            "rel": "result",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1062/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1061,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1061"
          },
          {
            "rel": "result",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1061/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1058,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1058"
          },
          {
            "rel": "result",
            "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/1058/data"
          }
        ]
      }
    }
  ],
  "count": 5,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries?limit=5"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries?offset=5&limit=5"
    }
  ]
}