REST API for Oracle Healthcare Translational Research

Retrieve Patient Clinical Specimen Query Status

get

/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/{id}

This endpoint supports the retrieval of Patient Clinical Specimen Query Status for a Query Identifier.

Request

Supported Media Types

application/json
application/xml

Path Parameters

apiContext: Type: string

Required: true

Patient/Subject API context
id: Type: integer (int64)

Required: true

Query ID

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root 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 : 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 submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/999

Example of Response Body

The following example shows the response returned in JSON format.

{
  "executeAsync": false,
  "minRetentionPeriodDays": 5,
  "queryCriteria": {
    "allCriteriaList": [
      {
        "type": "MedicationCriteria",
        "exclude": false,
        "medicationCodeList": [
          "1000000"
        ],
        "medicationOutcomeCodeList": [
          "1"
        ]
      },
      {
        "type": "SequenceVariantsCriteria",
        "exclude": false,
        "radioOptionMode": "VAR_IN_SELECTED_GENES",
        "geneInformation": {
          "type": "SequenceVariantsGeneDetails",
          "geneList": [
            "BID"
          ],
          "dnaVersionList": [
            2
          ],
          "dnaAlignmentList": [
            "GRCh37"
          ]
        },
        "geneRegionsList": [
          "PROMOTER"
        ],
        "polyphenSelected": false,
        "siftSelected": false,
        "fileTypeVCFSelected": true,
        "fileTypeMAFSelected": false,
        "fileTypeCGISelected": false
      }
    ]
  },
  "queryId": 999,
  "queryExecutionStatus": {
    "status": "DONE",
    "links": [
      {
        "rel": "status",
        "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/999"
      },
      {
        "rel": "result",
        "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/queries/999/data"
      }
    ]
  }
}