REST API for Oracle Healthcare Translational Research

Retrieve Clinical Specimen Metadata for a Specimen Identifier

get

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

This endpoint supports the retrieval of Patient/Subject Clinical Specimen Metadata for a Clinical Specimen Row ID. It returns Clinical Specimen Metadata information like Specimen Number, Specimen Vendor Number and other metadata associated information.

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 Clinical Specimen Row ID

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

Model for paginated collections of data.

Root Schema : PageableCollection

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 Serializable

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

Type: object

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

http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/2/metadata?limit=2&offset=2

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "SpecimenMetadata",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "871045"
      },
      "metadata": {
        "attrName": "ATTR_13",
        "attrDesc": "ATTRIBUTE_DESC_13",
        "strValue": "ATTR_13_VAL_2",
        "strValueUpper": "ATTR_13_VAL_2"
      },
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/2",
        "display": "HG0002(vendor2)"
      },
      "specimenVendorNumber": "vendor2",
      "accessionIdentifier": "HG0002"
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "1075613"
      },
      "metadata": {
        "attrName": "ATTR_16",
        "attrDesc": "ATTRIBUTE_DESC_16",
        "strValue": "ATTR_16_VAL_2",
        "strValueUpper": "ATTR_16_VAL_2"
      },
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/2",
        "display": "HG0002(vendor2)"
      },
      "specimenVendorNumber": "vendor2",
      "accessionIdentifier": "HG0002"
    }
  ],
  "count": 2,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/2/metadata?limit=2&offset=2"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/2/metadata?offset=4&limit=2"
    },
    {
      "rel": "prev",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/2/metadata?offset=0&limit=2"
    }
  ]
}