Retrieve Studies for Study Identifiers
get
/ohfapi/cg/v3.3/studies
This endpoint supports the retrieval of Studies for zero or more Study Row ID(s) 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
-
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 : 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
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 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.
Show Source
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
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 : 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.
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.
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.
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
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.
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.
Nested Schema : Telecom
Type:
Show Source
object
-
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
Nested Schema : given
Type:
array
Given names (not always 'first'). Includes middle names.
Show Source
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.
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.
-
srvcProviderId(optional):
string
Service Provider Id of Specimen Alias .
-
srvcProviderName(optional):
string
Service Provider Name of Specimen Alias .
-
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.
400 Response
Invalid parameters supplied
404 Response
Studies were not found
Examples
The following example submits a GET request.
Example 1 ??? Paginated List of All Accessible Studies
API URL
http://localhost:7010/ohfapi/cg/v3.3/studies?limit=2&offset=0
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "Study", "items": [ { "identifier": { "system": "CDM", "value": "1" }, "studyId": "1", "studyName": "Comorbidity assessments", "studyDescription": "Comorbidity assessments", "studyStartDate": "01/17/2015", "studyEndDate": "01/06/2017", "principalInvestigator": { "identifier": { "system": "CDM", "value": "SVCPRV1" }, "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" } ] }, "name": { "text": "Steve", "given": [ "Steve" ] }, "telecom": { "value": "111-222-3456" }, "specimenAliasIssuerFlag": "Y" }, "studyPhenotype": { "identifier": { "system": "CDM", "value": "1" }, "type": { "code": "1", "display": "ST_PHENOTYPE_1", "description": "ST_PHENOTYPE_DESC1", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } }, "studySubjects": { "reference": "/ohfapi/cg/v3.3/studies/1/subjects" }, "studySpecimens": { "reference": "/ohfapi/cg/v3.3/studies/1/specimens" } }, { "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" } } ], "count": 2, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/studies?limit=2&offset=0" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/studies?offset=2&limit=2" } ] }
Example 2 ??? Studies for Multiple Study Row IDs
API URL
http://localhost:7010/ohfapi/cg/v3.3/studies?id=2&id=21
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?id=2&id=21" } ] }