REST API for Oracle Healthcare Translational Research

Retrieve Genomic Specimen details for a Clinical Specimen Identifier

get

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

This endpoint supports the retrieval of Genomic Specimen for a single Clinical Specimen Identifier passed. It returns Genomic Specimen information like Specimen Number, Specimen Vendor Number and other Genomic Specimen associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

apiContext: Type: string

Required: true

Pattern: patientapi|subjectapi
id: Type: integer (int64)

Required: true

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 request parameters

404 Response

Query status not found

Examples

The following example submits a GET request.

API URL — Patient Context

http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/genomicspecimens/10096?limit=20&offset=0

Example of Response Body

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

{
  "resourceType": "GenomicSpecimen",
  "identifier": {
    "system": "ODB",
    "value": "63"
  },
  "specimenNumber": "HG000_10096",
  "specimenVendorNumber": "vendor2",
  "genomicSpecimenMetadata": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/genomicspecimens/63/metadata"
  },
  "genomicFileMetadata": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/genomicspecimens/63/fileMetadata"
  },
  "patient": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/2"
  }
}

API URL — Subject Context

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

Example of Response Body

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

{
  "resourceType": "GenomicSpecimen",
  "identifier": {
    "system": "ODB",
    "value": "40001"
  },
  "specimenNumber": "ADME_SPEC1",
  "specimenVendorNumber": "adme",
  "genomicSpecimenMetadata": {
    "reference": "/HSDataService-web/api/3.2.0/subjectapi/genomicspecimens/40001/metadata"
  },
  "genomicFileMetadata": {
    "reference": "/HSDataService-web/api/3.2.0/subjectapi/genomicspecimens/40001/fileMetadata"
  },
  "subject": {
    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/7"
  }
}