REST API for Oracle Healthcare Translational Research

Retrieve Studies for Study Identifiers and Names

get

/HSDataService-web/api/3.2.0/studies/search

This endpoint supports the retrieval of Studies for Zero or more for Study Identifiers and/or Names passed. It returns Study information like Name, Description, Start Date, End Date and other Study associated information.

Request

Supported Media Types

application/json
application/xml

Query Parameters

id

Type: array

Collection Format: multi

List of Study Identifier.

Items

Type: string

limit

Type: integer (int32)

Pagination query params: ?limit=2&offset=0

name

Type: array

Collection Format: multi

List of Study Names,

Items

Type: string

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

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 Study

Model for a Clinical Study details.

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

Type: object

Model for a Clinical Study details.

Properties

identifier: Type: object Identifier

Identifier assigned by a given system
principalInvestigator: Type: object Practitioner

Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.
resourceType: Type: string

API resource type. it's included if Response is not paginated.
studyDescription: Type: string

Clinical Study description.
studyEndDate: Type: string (date-time)
studyId: Type: string

Clinical Study identifier.
studyName: Type: string

Clinical Study name.
studyPhenotype: Type: object StudyPhenotype

Model for a clinical study standardized Phenotype.
studySpecimens: Type: object LinkedReference
studyStartDate: Type: string (date-time)
studySubjects: 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 : Practitioner

Type: object

Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.

Properties

address: Type: object Address

Model for a postal address.
identifier: Type: object CdmIdentifier

Identifier assigned by a given system
name: Type: object HumanName

Model for a name of a human with text and parts information.
speciality: Type: object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
specimenAliasIssuerFlag: Type: string

The flag that indicates that this Service Provider has issued Specimen Alias(es).
telecom: Type: object Telecom
type: Type: object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Nested Schema : StudyPhenotype

Type: object

Model for a clinical study standardized Phenotype.

Properties

identifier: Type: object Identifier

Identifier assigned by a given system
type: Type: object Coding

Model for a reference to a code defined by a terminology system.

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : Address

Type: object

Model for a postal address.

Properties

city: Type: string

Name of city, town etc.
country: Type: object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
district: Type: string

District name (aka county).
line: Type: array line

Street name, number, direction & P.O. Box etc.
postalCode: Type: string

Postal code for area.
state: Type: object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Nested Schema : CdmIdentifier

Type: object

Identifier assigned by a given system

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

Nested Schema : HumanName

Type: object

Model for a name of a human with text and parts information.

Properties

family: Type: string

Family name (often called 'Surname').
given: Type: array given

Given names (not always 'first'). Includes middle names.
text: Type: string

Text representation of the full name.

Nested Schema : CodeableConcept

Type: object

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Properties

coding: Type: array coding

Read Only: true

Code(s) defined by a terminology system.
text: Type: string

Plain text representation of the concept.

Nested Schema : Telecom

Type: object

Properties

use: Type: object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
value: Type: string

Telecom Value

Nested Schema : line

Type: array

Street name, number, direction & P.O. Box etc.

Items

Type: string

Nested Schema : given

Type: array

Given names (not always 'first'). Includes middle names.

Items

Type: string

Nested Schema : coding

Type: array

Read Only: true

Code(s) defined by a terminology system.

Items

Type: object Coding

Model for a reference to a code defined by a terminology system.

Nested Schema : Coding

Type: object

Model for a reference to a code defined by a terminology system.

Properties

code: Type: string

Symbol in syntax defined by the system.
description: Type: string

Description defined by the system.
display: Type: string

Representation defined by the system.
sysId: Type: string

Identity of the terminology system.
sysName: Type: string

Name of the terminology system.
sysVersion: Type: string

Version of the system - if relevant.

400 Response

Invalid parameters supplied

404 Response

Studies were not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/studies/search?name=ami&id=ct

Example of Response Body

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

{
  "resourceType": "Study",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "2"
      },
      "studyId": "NCT02085388",
      "studyName": "Effect Of Obesity Surgery on Gene Expression Profile",
      "studyDescription": "Gene expression profiling (whole genome analysis, with first interest in FTO and BDNF expression) to assess changes in gene expression before vs. after surgery, and to associate gene expression with weight loss after surgery.",
      "studyStartDate": "01/17/2015",
      "studyEndDate": "01/06/2017",
      "principalInvestigator": {
        "identifier": {
          "system": "CDM",
          "value": "NCT02085388:SPI"
        },
        "type": {
          "coding": [
            {
              "code": "STUDY-PI",
              "display": "Study PI",
              "description": "Study Principal Investigator",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "name": {
          "text": "Sarah Jane Smith",
          "family": "Smith",
          "given": [
            "Sarah",
            "Jane"
          ]
        },
        "telecom": {
          "value": "sara.j.smith@somecompany.com",
          "use": {
            "coding": [
              {
                "code": "EMAIL",
                "display": "Email",
                "description": "Company email",
                "sysId": "CONTACT_INFO_TYPE_CD_SYS_ID2",
                "sysName": "CONTACT_INFO_TYPE_CD_SYS_NAME2",
                "sysVersion": "CONTACT_INFO_TYPE_CD_SYS_VER2"
              }
            ]
          }
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "studyPhenotype": {
        "identifier": {
          "system": "CDM",
          "value": "2"
        },
        "type": {
          "code": "E66",
          "display": "Overweight and obesity",
          "description": "Includes: E66.0-Obesity due to excess calories; E66.3-Overweight; E66.8-Other obesity; E66.9-Obesity, unspecified",
          "sysId": "EHA_CUSTOM_CD_SYS",
          "sysName": "EHA Custom Code System",
          "sysVersion": "1"
        }
      },
      "studySubjects": {
        "reference": "/HSDataService-web/api/3.2.0/studies/2/subjects"
      },
      "studySpecimens": {
        "reference": "/HSDataService-web/api/3.2.0/studies/2/specimens"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "21"
      },
      "studyId": "11",
      "studyName": "Troponin levels after AMI",
      "studyDescription": "Troponin levels after AMI",
      "studyStartDate": "01/17/2015",
      "studyEndDate": "01/06/2017",
      "principalInvestigator": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV10"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "specimenAliasIssuerFlag": "N"
      },
      "studyPhenotype": {
        "identifier": {
          "system": "CDM",
          "value": "10"
        },
        "type": {
          "code": "10",
          "display": "ST_PHENOTYPE_10",
          "description": "ST_PHENOTYPE_DESC10",
          "sysId": "EHA_CUSTOM_CD_SYS",
          "sysName": "EHA Custom Code System",
          "sysVersion": "1"
        }
      },
      "studySubjects": {
        "reference": "/HSDataService-web/api/3.2.0/studies/21/subjects"
      },
      "studySpecimens": {
        "reference": "/HSDataService-web/api/3.2.0/studies/21/specimens"
      }
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/studies/search?name=ami&id=ct"
    }
  ]
}