REST API for Oracle Healthcare Translational Research

Retrieve Clinical Specimen Metadata for Specimen Identifiers

get

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

This endpoint supports the retrieval of Patient/Subject Clinical Specimen Metadata for multiple Clinical Specimen Row IDs. 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

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

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 ClinicalSpecimenMetadata

Model for a Clinical Specimen Metadata object in CDM.

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

Type: object

Model for a Clinical Specimen Metadata object in CDM.

Properties

accessionIdentifier: Type: string

The Clinical Specimen identifier.
identifier: Type: object Identifier

Identifier assigned by a given system
metadata: Type: object Metadata

Model for a Metadata Attribute object in CDM.
specimenReference: Type: object LinkedReference
specimenVendorNumber: Type: string

The Clinical Specimen Vendor identifier.

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

Nested Schema : Metadata

Type: object

Model for a Metadata Attribute object in CDM.

Properties

attrDesc: Type: string

Metadata Attribute description.
attrName: Type: string

Metadata Attribute name.
strValue: Type: string

Metadata Attribute string value.
strValueUpper: Type: string

Metadata Attribute upper case string value.

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

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/metadata?id=43&id=44&limit=3&offset=9

Example of Response Body

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

{
  "resourceType": "SpecimenMetadata",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "530743"
      },
      "metadata": {
        "attrName": "ATTR_8",
        "attrDesc": "ATTRIBUTE_DESC_8",
        "strValue": "ATTR_8_VAL_43",
        "strValueUpper": "ATTR_8_VAL_43"
      },
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/43",
        "display": "HG00043(vendor2)"
      },
      "specimenVendorNumber": "vendor2",
      "accessionIdentifier": "HG00043"
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "53274"
      },
      "metadata": {
        "attrName": "ATTR_1",
        "attrDesc": "ATTRIBUTE_DESC_1",
        "strValue": "ATTR_1_VAL_44",
        "strValueUpper": "ATTR_1_VAL_44"
      },
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/44",
        "display": "HG00044(vendor2)"
      },
      "specimenVendorNumber": "vendor2",
      "accessionIdentifier": "HG00044"
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "666491"
      },
      "metadata": {
        "attrName": "ATTR_10",
        "attrDesc": "ATTRIBUTE_DESC_10",
        "strValue": "ATTR_10_VAL_44",
        "strValueUpper": "ATTR_10_VAL_44"
      },
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/44",
        "display": "HG00044(vendor2)"
      },
      "specimenVendorNumber": "vendor2",
      "accessionIdentifier": "HG00044"
    }
  ],
  "count": 3,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/metadata?id=43&id=44&limit=3&offset=9"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/metadata?offset=12&limit=3&id=43&id=44"
    },
    {
      "rel": "prev",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/metadata?offset=6&limit=3&id=43&id=44"
    }
  ]
}