REST API for Oracle Healthcare Translational Research

Retrieve Clinical Specimen Alias for Specimen Identifiers

get

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

This endpoint supports the retrieval of Patient/Subject Clinical Specimen Aliases for multiple Clinical Specimen Row IDs. It returns Paginated List of Clinical Specimen Aliases information like Specimen alias and its Row ID, Service Provider Identifier and reference to the Clinical Specimen details. Result includes only aliases to which user has read access.

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

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

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 ClinicalSpecimenAlias

Model for a Clinical Specimen Alias 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 : ClinicalSpecimenAlias

Type: object

Model for a Clinical Specimen Alias object in CDM.

Properties

identifier: Type: object Identifier

Identifier assigned by a given system
serviceProviderIdentifier: Type: string

Identifier of the Service Provider that issued the Alias for the Clinical Specimen.
specimenAlias: Type: string

Clinical Specimen Alias value.
specimenAliasUpper: Type: string

Clinical Specimen Alias upper case value.
specimenReference: Type: object LinkedReference

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 : 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 — Patient Context

http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/aliases?id=1005&id=1010&id=1012&id=1015

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "SpecimenAlias",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "159"
      },
      "serviceProviderIdentifier": "vcf",
      "specimenAlias": "ALIAS_SVCPRV1_SN 005",
      "specimenAliasUpper": "ALIAS_SVCPRV1_SN 005",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/1005"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "16"
      },
      "serviceProviderIdentifier": "vcf",
      "specimenAlias": "ALIAS_SVCPRV1_CNV_dummy_01",
      "specimenAliasUpper": "ALIAS_SVCPRV1_CNV_DUMMY_01",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/1010"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "17"
      },
      "serviceProviderIdentifier": "vcf",
      "specimenAlias": "ALIAS_SVCPRV1_TCGA-06-0187-01A-01W2",
      "specimenAliasUpper": "ALIAS_SVCPRV1_TCGA-06-0187-01A-01W2",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/1015"
      }
    }
  ],
  "count": 3,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/aliases?id=1005&id=1010&id=1012&id=1015"
    }
  ]
}

API URL — Subject Context

http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/aliases?id=1035&id=1040&id=1041&id=1075

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "SpecimenAlias",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "89"
      },
      "serviceProviderIdentifier": "SVCPRV1",
      "specimenAlias": "ALIAS_SVCPRV1_TCGA-08-0375-11A-8109",
      "specimenAliasUpper": "ALIAS_SVCPRV1_TCGA-08-0375-11A-8109",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/1035"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "4"
      },
      "serviceProviderIdentifier": "SVCPRV1",
      "specimenAlias": "ALIAS_SVCPRV1_TCGA-02-0026-10A-01W",
      "specimenAliasUpper": "ALIAS_SVCPRV1_TCGA-02-0026-10A-01W",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/1040"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "47"
      },
      "serviceProviderIdentifier": "SVCPRV1",
      "specimenAlias": "ALIAS_SVCPRV1_NEGATIVE 2",
      "specimenAliasUpper": "ALIAS_SVCPRV1_NEGATIVE 2",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/1075"
      }
    }
  ],
  "count": 3,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/aliases?id=1035&id=1040&id=1041&id=1075"
    }
  ]
}