REST API for Oracle Healthcare Translational Research

Retrieve Genomic Specimens for a Specimen Identifier

get

/HSDataService-web/api/3.2.0/{apiContext}/clinicalspecimens/{id}/genomicspecimens

This endpoint supports the retrieval of Patient/Subject Genomic Specimen Row IDs for a Clinical Specimen Row ID, if Clinical Specimen is valid and has corresponding omics data.

Request

Supported Media Types

application/json
application/xml

Path Parameters

apiContext: Type: string

Required: true

Pattern: subjectapi|patientapi

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

Required: true

Patient/Subject Specimen Row ID

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : GenomicSpecimen

Type: object

Properties

genomicFileMetadata: Type: object LinkedReference
genomicSpecimenMetadata: Type: object LinkedReference
identifier: Type: object Identifier

Identifier assigned by a given system
patient: Type: object LinkedReference
resourceType: Type: string
specimenNumber: Type: string

Specimen identifier in linked Specimen Datasource Database
specimenVendorNumber: Type: string

Vendor Identifier in linked Specimen Datasource Database
subject: Type: object LinkedReference

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

400 Response

Invalid parameters supplied

404 Response

Clinical specimen or clinical specimen metadata not found

Examples

The following example submits a GET request.

API URL — Patient Context

http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/96/genomicspecimens

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "resourceType": "GenomicSpecimen",
  "identifier": {
    "system": "ODB",
    "value": "63"
  },
  "patient": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/genomicspecimens/96"
  }
}

API URL — Subject Context

http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/97/genomicspecimens

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "resourceType": "GenomicSpecimen",
  "identifier": {
    "system": "ODB",
    "value": "71"
  },
  "subject": {
    "reference": "/HSDataService-web/api/3.2.0/subjectapi/genomicspecimens/97"
  }
}