Jump to

• Request
• Response
• Examples

Retrieve Genomic Specimens for a Specimen Identifier

get

/ohfapi/cg/v3.3/{apiContext}/clinicalspecimens/{id}/genomicspecimens

This endpoint supports the retrieval of Patient/Subject Genomic Specimen Row IDs for a Clinical Specimen Row ID, if Clinical Specimen is valid and has corresponding omics data.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• apiContext: string
  Pattern: subjectapi|patientapi

  Patient/Subject API context
• id: integer(int64)
  Minimum Value: 0

  Patient/Subject Specimen Row ID

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : GenomicSpecimen

Type: object

Show Source

• genomicFileMetadata(optional): object LinkedReference
• genomicSpecimenMetadata(optional): object LinkedReference
• identifier(optional): object Identifier
  Identifier assigned by a given system
• patient(optional): object LinkedReference
• resourceType(optional): string
• specimenNumber(optional): string
  Specimen identifier in linked Specimen Datasource Database
• specimenVendorNumber(optional): string
  Vendor Identifier in linked Specimen Datasource Database
• subject(optional): object LinkedReference

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string"
        },
        "identifier":{
            "description":"Genomic Specimen Identifier",
            "$ref":"#/definitions/Identifier"
        },
        "specimenNumber":{
            "type":"string",
            "description":"Specimen identifier in linked Specimen Datasource Database"
        },
        "specimenVendorNumber":{
            "type":"string",
            "description":"Vendor Identifier in linked Specimen Datasource Database"
        },
        "genomicSpecimenMetadata":{
            "example":"{href: 'patientapi/genomicspecimens/{id}/metadata'}",
            "description":"A link containing href to retrieve Genomic Specimen Metadata details",
            "$ref":"#/definitions/LinkedReference"
        },
        "genomicFileMetadata":{
            "example":"{href: 'patientapi/genomicspecimens/{id}/fileMetadata'}",
            "description":"A link containing href to retrieve Genomic Specimen File Metadata details",
            "$ref":"#/definitions/LinkedReference"
        },
        "subject":{
            "$ref":"#/definitions/LinkedReference"
        },
        "patient":{
            "$ref":"#/definitions/LinkedReference"
        }
    }
}

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Show Source

• system(optional): string
  System which assigned this identifier
• value(optional): string
  Identifier value

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

400 Response

Invalid parameters supplied

404 Response

Clinical specimen or clinical specimen metadata not found

Back to Top

Examples

The following example submits a GET request.

API URL ??? Patient Context

http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/96/genomicspecimens

Example of Response Body

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

{
  "resourceType": "GenomicSpecimen",
  "identifier": {
    "system": "ODB",
    "value": "63"
  },
  "patient": {
    "reference": "/ohfapi/cg/v3.3/patientapi/genomicspecimens/96"
  }
}

API URL ??? Subject Context

http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/97/genomicspecimens

Example of Response Body

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

{
  "resourceType": "GenomicSpecimen",
  "identifier": {
    "system": "ODB",
    "value": "71"
  },
  "subject": {
    "reference": "/ohfapi/cg/v3.3/subjectapi/genomicspecimens/97"
  }
}

Back to Top