Retrieve Demographics for Cohort List Name or Subject Identifiers
get
/HSDataService-web/api/3.2.0/subjectapi/subjects
This endpoint supports the retrieval of Demographics for multiple Subject Identifiers or Cohort List Name. It returns Subject information like Name, Telecom, Address and other Subject associated information.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
- cohortListName
-
Type:
string
Cohort list name- id
Type:array
Collection Format:multi
Subject Row ID(s) (cannot be passed while requesting for subjects by cohort list name)-
Type:
integer
(int64
)
- limit
Type:integer
(int32
)Pagination query params: ?limit=2&offset=0- offset
Type:integer
(int32
)Pagination query params: ?limit=2&offset=0Response
Supported Media Types- application/json
- application/xml
200 Responsesuccessful operationBodyModel for paginated collections of data.Root Schema : PageableCollectionSubjectType:object
Model for paginated collections of data.- 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
itemsA collection of paged items. - links
-
Type:
array
linksA collection of links containing hrefs to the current, next, and previous pages as applicable. - resourceType
-
Type:
string
Identify the resource type
Nested Schema : linksNested Schema : SubjectType:object
- address
-
Type:
object
AddressModel for a postal address. - birthDate
-
Type:
string
(date-time
)Date of Birth - deceasedBoolean
-
Type:
boolean
Default Value:false
Deceased or Not - deceasedDate
-
Type:
string
(date-time
)Deceased Date - endDate
-
Type:
string
(date-time
)Enrollment End Date - enrollmentDate
-
Type:
string
(date-time
)Enrollment Date - ethnicity
-
Type:
object
LinkedReference - gender
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - identifiers
-
Type:
array
identifiersSpecimen Identifier - maritalStatus
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - name
-
Type:
object
HumanNameModel for a name of a human with text and parts information. - patient
-
Type:
object
LinkedReference - patientIdentifier
-
Type:
string
Patient Identifier - race
-
Type:
object
LinkedReference - startDate
-
Type:
string
(date-time
)Enrollment Start Date - studyIdentifier
-
Type:
string
Study Identifier - studyName
-
Type:
string
Study Name - telecom
-
Type:
object
Telecom
Nested Schema : AddressType:object
Model for a postal address.- city
-
Type:
string
Name of city, town etc. - country
-
Type:
object
CodeableConceptModel 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
lineStreet name, number, direction & P.O. Box etc. - postalCode
-
Type:
string
Postal code for area. - state
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
Nested Schema : LinkedReferenceType:object
- display
-
Type:
string
- reference
-
Type:
string
Nested Schema : CodeableConceptType:object
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.- coding
-
Type:
array
codingRead Only:true
Code(s) defined by a terminology system. - text
-
Type:
string
Plain text representation of the concept.
Nested Schema : identifiersNested Schema : HumanNameType:object
Model for a name of a human with text and parts information.- family
-
Type:
string
Family name (often called 'Surname'). - given
-
Type:
array
givenGiven names (not always 'first'). Includes middle names. - text
-
Type:
string
Text representation of the full name.
Nested Schema : TelecomType:object
- use
-
Type:
object
CodeableConceptModel 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 : lineNested Schema : codingNested Schema : CodingType:object
Model for a reference to a code defined by a terminology system.- 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.
Nested Schema : IdentifierType:object
Identifier assigned by a given system- system
-
Type:
string
System which assigned this identifier - value
-
Type:
string
Identifier value
Nested Schema : given400 ResponseInvalid parameters supplied404 ResponseSubject(s) not foundExamples
The following example submits a GET request.
Example 1 — API URL with Cohort List Name as Input
http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects?cohortListName=Cohort_List_Test5
Example of Response Body
The following example shows the response returned in JSON format.
{ "items": [ { "identifiers": [ { "system": "CDM", "value": "1" }, { "system": "Customer Defined", "value": "S1_1" } ], "studyName": "STUDY1", "studyIdentifier": "1", "patientIdentifier": "P2_2", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/patients" }, "name": { "text": "Juan MN1 Hernandez", "family": "Hernandez", "given": [ "Juan", "MN1" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "01/01/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD11", "SADD21", "SADD31" ], "city": "C1", "district": "C1", "state": { "coding": [ { "code": "1", "display": "State1", "description": "State1Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z1", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/ethnicity" } }, { "identifiers": [ { "system": "CDM", "value": "2" }, { "system": "Customer Defined", "value": "S2_2" } ], "studyName": "STUDY1", "studyIdentifier": "1", "patientIdentifier": "P3_3", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/2/patients" }, "name": { "text": "John MN2 Jones", "family": "Jones", "given": [ "John", "MN2" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "01/14/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD12", "SADD22", "SADD32" ], "city": "C2", "district": "C2", "state": { "coding": [ { "code": "2", "display": "State2", "description": "State2Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z2", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/2/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/2/ethnicity" } }, { "identifiers": [ { "system": "CDM", "value": "3" }, { "system": "Customer Defined", "value": "S3_3" } ], "studyName": "STUDY1", "studyIdentifier": "1", "patientIdentifier": "P3_3", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/3/patients" }, "name": { "text": "Hans MN3 Olsen", "family": "Olsen", "given": [ "Hans", "MN3" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "01/27/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD13", "SADD23", "SADD33" ], "city": "C3", "district": "C3", "state": { "coding": [ { "code": "0", "display": "State0", "description": "State0Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z3", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/3/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/3/ethnicity" } }, { "identifiers": [ { "system": "CDM", "value": "4" }, { "system": "Customer Defined", "value": "S4_4" } ], "studyName": "STUDY2", "studyIdentifier": "2", "patientIdentifier": "P4_4", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients" }, "name": { "text": "Mary MN4 Johnson", "family": "Johnson", "given": [ "Mary", "MN4" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "02/09/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD14", "SADD24", "SADD34" ], "city": "C4", "district": "C4", "state": { "coding": [ { "code": "1", "display": "State1", "description": "State1Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z4", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/ethnicity" } } ], "count": 4, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects?cohortListName=Cohort_List_Test5" } ] }
Example 1 — API URL with Subject IDs as Input
http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects?id=1&id=2&id=3&id=4&id=5&limit=10&offset=0
Example of Response Body
The following example shows the response returned in JSON format.
{ "items": [ { "identifiers": [ { "system": "CDM", "value": "1" }, { "system": "Customer Defined", "value": "S1_1" } ], "studyName": "STUDY1", "studyIdentifier": "1", "patientIdentifier": "P2_2", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/patients" }, "name": { "text": "Juan MN1 Hernandez", "family": "Hernandez", "given": [ "Juan", "MN1" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "01/01/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD11", "SADD21", "SADD31" ], "city": "C1", "district": "C1", "state": { "coding": [ { "code": "1", "display": "State1", "description": "State1Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z1", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/ethnicity" } }, { "identifiers": [ { "system": "CDM", "value": "2" }, { "system": "Customer Defined", "value": "S2_2" } ], "studyName": "STUDY1", "studyIdentifier": "1", "patientIdentifier": "P3_3", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/2/patients" }, "name": { "text": "John MN2 Jones", "family": "Jones", "given": [ "John", "MN2" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "01/14/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD12", "SADD22", "SADD32" ], "city": "C2", "district": "C2", "state": { "coding": [ { "code": "2", "display": "State2", "description": "State2Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z2", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/2/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/2/ethnicity" } }, { "identifiers": [ { "system": "CDM", "value": "3" }, { "system": "Customer Defined", "value": "S3_3" } ], "studyName": "STUDY1", "studyIdentifier": "1", "patientIdentifier": "P3_3", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/3/patients" }, "name": { "text": "Hans MN3 Olsen", "family": "Olsen", "given": [ "Hans", "MN3" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "01/27/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD13", "SADD23", "SADD33" ], "city": "C3", "district": "C3", "state": { "coding": [ { "code": "0", "display": "State0", "description": "State0Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z3", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/3/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/3/ethnicity" } }, { "identifiers": [ { "system": "CDM", "value": "4" }, { "system": "Customer Defined", "value": "S4_4" } ], "studyName": "STUDY2", "studyIdentifier": "2", "patientIdentifier": "P4_4", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients" }, "name": { "text": "Mary MN4 Johnson", "family": "Johnson", "given": [ "Mary", "MN4" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "02/09/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD14", "SADD24", "SADD34" ], "city": "C4", "district": "C4", "state": { "coding": [ { "code": "1", "display": "State1", "description": "State1Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z4", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/ethnicity" } }, { "identifiers": [ { "system": "CDM", "value": "5" }, { "system": "Customer Defined", "value": "S5_5" } ], "studyName": "STUDY1", "studyIdentifier": "1", "patientIdentifier": "P4_4", "patient": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/5/patients" }, "name": { "text": "FN5 MN5 LN5", "family": "LN5", "given": [ "FN5", "MN5" ] }, "telecom": { "value": "info@oracle.com", "use": { "coding": [ { "code": "CNTCT_INFO_SUBTYP_EML", "display": "Email", "description": "Communicate electronically on the computer", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "gender": { "coding": [ { "code": "1", "display": "Male", "description": "Male", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "birthDate": "02/22/1945", "deceasedBoolean": false, "maritalStatus": { "coding": [ { "code": "1", "display": "Married", "description": "Married", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "address": { "line": [ "SADD15", "SADD25", "SADD35" ], "city": "C5", "district": "C5", "state": { "coding": [ { "code": "2", "display": "State2", "description": "State2Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "Z5", "country": { "coding": [ { "code": "1", "display": "USA", "description": "United state of America", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "race": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/5/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/5/ethnicity" } } ], "count": 5, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects?id=1&id=2&id=3&id=4&id=5&limit=10&offset=0" } ] }