Clinical Genomic APIs for Oracle Healthcare Foundation

Retrieve Studies for Study Identifiers and Names

get

/ohfapi/cg/v3.3/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(optional): array

Collection Format: multi

List of Study Identifier.

[0]: string

{
    "name":"id",
    "in":"query",
    "description":"List of Study Identifier.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"multi"
}

limit(optional): integer(int32)

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

name(optional): array

Collection Format: multi

List of Study Names,

[0]: string

{
    "name":"name",
    "in":"query",
    "description":"List of Study Names,",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"multi"
}

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

Model for paginated collections of data.

Root Schema : PageableCollectionStudy

Type: object

Model for paginated collections of data.

Show Source

count(optional): integer(int64)

Number of objects in the 'items' collection.
hasMore(optional): boolean

Default Value: false

A boolean indicating if more pages are available.
items(optional): array items

A collection of paged items.
links(optional): array link

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType(optional): string

Identify the resource type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Study"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available.",
            "default":false
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

Array of: object Study

Model for a Clinical Study details.

{
    "type":"array",
    "xml":{
        "name":"items",
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Study"
    }
}

Nested Schema : link

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Show Source

Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Nested Schema : Study

Type: object

Model for a Clinical Study details.

Show Source

identifier(optional): object Identifier

Identifier assigned by a given system
principalInvestigator(optional): 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(optional): string

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

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

Clinical Study identifier.
studyName(optional): string

Clinical Study name.
studyPhenotype(optional): object StudyPhenotype

Model for a clinical study standardized Phenotype.
studySpecimens(optional): object LinkedReference
studyStartDate(optional): string(date-time)
studySubjects(optional): object LinkedReference

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"API resource type. it's included if Response is not paginated."
        },
        "identifier":{
            "description":"Clinical Study Row ID value.",
            "$ref":"#/definitions/Identifier"
        },
        "studyId":{
            "type":"string",
            "description":"Clinical Study identifier."
        },
        "studyName":{
            "type":"string",
            "description":"Clinical Study name."
        },
        "studyDescription":{
            "type":"string",
            "description":"Clinical Study description."
        },
        "studyStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "studyEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "principalInvestigator":{
            "description":"A principal investigator for a Clinical Study. The investigator's identifier includes the service provider unique identifier.",
            "$ref":"#/definitions/Practitioner"
        },
        "studyPhenotype":{
            "description":"Clinical Study phenotype.",
            "$ref":"#/definitions/StudyPhenotype"
        },
        "studySubjects":{
            "description":"Clinical API URI to get paginated list of the study Subjects references.",
            "$ref":"#/definitions/LinkedReference"
        },
        "studySpecimens":{
            "description":"Clinical API URI to get paginated list of the study subjects Clinical Specimens references.",
            "$ref":"#/definitions/LinkedReference"
        }
    },
    "description":"Model for a Clinical Study details."
}

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"
}

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.

Show Source

address(optional): object Address

Model for a postal address.
identifier(optional): object CdmIdentifier

Identifier assigned by a given system
name(optional): object HumanName

Model for a name of a human with text and parts information.
speciality(optional): 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(optional): string

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

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

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Healthcare service provider system identifier. It can include a service provider Row ID value or service provider unique identifier.",
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"The healthcare practitioner type or role, i.e. type/role code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "name":{
            "description":"A name associated with the person.",
            "$ref":"#/definitions/HumanName"
        },
        "telecom":{
            "description":"A contact detail for the practitioner. For example, the telephone number, email, or fax.",
            "$ref":"#/definitions/Telecom"
        },
        "address":{
            "description":"Where practitioner can be found/visited.",
            "$ref":"#/definitions/Address"
        },
        "speciality":{
            "description":"Detaile of the specific specialty of the practitioner, i.e. specialty code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "specimenAliasIssuerFlag":{
            "type":"string",
            "description":"The flag that indicates that this Service Provider has issued Specimen Alias(es)."
        }
    },
    "description":"Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility."
}

Nested Schema : StudyPhenotype

Type: object

Model for a clinical study standardized Phenotype.

Show Source

identifier(optional): object Identifier

Identifier assigned by a given system
type(optional): object Coding

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

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Clinical Study Phenotype Row ID value.",
            "$ref":"#/definitions/Identifier"
        },
        "type":{
            "description":"The Clinical Study Phenotype definition details, i.e. phenotype code, name, description etc.",
            "$ref":"#/definitions/Coding"
        }
    },
    "description":"Model for a clinical study standardized Phenotype."
}

Nested Schema : LinkedReference

Type: object

Show Source

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

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

Nested Schema : Address

Type: object

Model for a postal address.

Show Source

city(optional): string

Name of city, town etc.
country(optional): 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(optional): string

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

Street name, number, direction & P.O. Box etc.
postalCode(optional): string

Postal code for area.
state(optional): object CodeableConcept

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

{
    "type":"object",
    "properties":{
        "line":{
            "type":"array",
            "description":"Street name, number, direction & P.O. Box etc.",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string",
            "description":"Name of city, town etc."
        },
        "district":{
            "type":"string",
            "description":"District name (aka county)."
        },
        "state":{
            "description":"Sub-unit of country (abbreviations ok).",
            "$ref":"#/definitions/CodeableConcept"
        },
        "postalCode":{
            "type":"string",
            "description":"Postal code for area."
        },
        "country":{
            "description":"Country (can be ISO 3166 3 letter code).",
            "$ref":"#/definitions/CodeableConcept"
        }
    },
    "description":"Model for a postal address."
}

Nested Schema : CdmIdentifier

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"
}

Nested Schema : HumanName

Type: object

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

Show Source

family(optional): string

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

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

Text representation of the full name.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Text representation of the full name."
        },
        "family":{
            "type":"string",
            "description":"Family name (often called 'Surname')."
        },
        "given":{
            "type":"array",
            "description":"Given names (not always 'first'). Includes middle names.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for a name of a human with text and parts information."
}

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.

Show Source

coding(optional): array coding

Read Only: true

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

Plain text representation of the concept.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Plain text representation of the concept."
        },
        "coding":{
            "type":"array",
            "description":"Code(s) defined by a terminology system.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Coding"
            }
        }
    },
    "description":"Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text."
}

Nested Schema : Telecom

Type: object

Show Source

use(optional): 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(optional): string

Telecom Value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Telecom Value"
        },
        "use":{
            "description":"Telecom Use CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : line

Type: array

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

Show Source

Array of: string

{
    "type":"array",
    "description":"Street name, number, direction & P.O. Box etc.",
    "items":{
        "type":"string"
    }
}

Nested Schema : given

Type: array

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

Show Source

Array of: string

{
    "type":"array",
    "description":"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.

Show Source

Array of: object Coding

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

{
    "type":"array",
    "description":"Code(s) defined by a terminology system.",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Coding"
    }
}

Nested Schema : Coding

Type: object

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

Show Source

code(optional): string

Symbol in syntax defined by the system.
description(optional): string

Description defined by the system.
display(optional): string

Representation defined by the system.
sysId(optional): string

Identity of the terminology system.
sysName(optional): string

Name of the terminology system.
sysVersion(optional): string

Version of the system - if relevant.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Symbol in syntax defined by the system."
        },
        "display":{
            "type":"string",
            "description":"Representation defined by the system."
        },
        "description":{
            "type":"string",
            "description":"Description defined by the system."
        },
        "sysId":{
            "type":"string",
            "description":"Identity of the terminology system."
        },
        "sysName":{
            "type":"string",
            "description":"Name of the terminology system."
        },
        "sysVersion":{
            "type":"string",
            "description":"Version of the system - if relevant."
        }
    },
    "description":"Model for a reference to a code defined by a terminology system."
}

400 Response

Invalid parameters supplied

404 Response

Studies were not found

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/studies/2/subjects"
      },
      "studySpecimens": {
        "reference": "/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/studies/21/subjects"
      },
      "studySpecimens": {
        "reference": "/ohfapi/cg/v3.3/studies/21/specimens"
      }
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/studies/search?name=ami&id=ct"
    }
  ]
}