Retrieve Clinical Specimen Metadata for Specimen Identifiers
get
/ohfapi/cg/v3.3/{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: string
Pattern:
subjectapi|patientapi
Patient/Subject API context
Query Parameters
-
id: array
Collection Format:
multi
Minimum Number of Items:1
Maximum Number of Items:2147483647
Patient/Subject Clinical Specimen Row IDs List -
limit(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
-
offset(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollectionClinicalSpecimenMetadata
Type:
object
Model for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
A boolean indicating if more pages are available.
-
items(optional):
array items
A collection of paged items.
-
links(optional):
array links
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : items
Type:
array
A collection of paged items.
Show Source
-
Array of:
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.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}
Nested Schema : ClinicalSpecimenMetadata
Type:
object
Model for a Clinical Specimen Metadata object in CDM.
Show Source
-
accessionIdentifier(optional):
string
The Clinical Specimen identifier.
-
identifier(optional):
object Identifier
Identifier assigned by a given system
-
metadata(optional):
object Metadata
Model for a Metadata Attribute object in CDM.
-
specimenReference(optional):
object LinkedReference
-
specimenVendorNumber(optional):
string
The Clinical Specimen Vendor identifier.
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
Nested Schema : Metadata
Type:
object
Model for a Metadata Attribute object in CDM.
Show Source
-
attrDesc(optional):
string
Metadata Attribute description.
-
attrName(optional):
string
Metadata Attribute name.
-
strValue(optional):
string
Metadata Attribute string value.
-
strValueUpper(optional):
string
Metadata Attribute upper case string value.
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:7010/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/44", "display": "HG00044(vendor2)" }, "specimenVendorNumber": "vendor2", "accessionIdentifier": "HG00044" } ], "count": 3, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/metadata?id=43&id=44&limit=3&offset=9" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/metadata?offset=12&limit=3&id=43&id=44" }, { "rel": "prev", "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/metadata?offset=6&limit=3&id=43&id=44" } ] }