REST API for Oracle Healthcare Translational Research

Retrieve Genomics Specimen Identifiers for Clinical Specimen Identifiers

get

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

This endpoint supports the retrieval of Patient/Subject Genomic Specimen Row IDs List for multiple Clinical Specimens Row IDs, 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

Query Parameters

id

Type: array

Required: true

Collection Format: multi

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Patient/Subject Clinical Specimen Row IDs List

Items

Type: integer (int64)

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

Model for paginated collections of data.

Root Schema : PageableCollectionGenomicSpecimen

Type: object

Model for paginated collections of data.

Properties

count: Type: integer (int64)

Number of objects in the 'items' collection.
hasMore: Type: boolean

Default Value: false

A boolean indicating if more pages are available.
items: Type: array items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object GenomicSpecimen

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested 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

Genomic specimen or genomic 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/genomicspecimens?id=96&id=97&limit=20&offset=0

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "GenomicSpecimen",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "71"
      },
      "patient": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/genomicspecimens/97"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "63"
      },
      "patient": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/genomicspecimens/96"
      }
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://loalhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/genomicspecimens?id=96&id=97&limit=20&offset=0"
    }
  ]
}

API URL — Subject Context

http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/genomicspecimens?id=96&id=97&limit=20&offset=0

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "GenomicSpecimen",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "63"
      },
      "subject": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/genomicspecimens/96"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "71"
      },
      "subject": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/genomicspecimens/97"
      }
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/genomicspecimens?id=96&id=97&limit=20&offset=0"
    }
  ]
}