Retrieve Demographics for Cohort List Name or Patient Record Ids
get
/ohfapi/cg/v3.3/patientapi/patients
This endpoint supports the retrieval of Demographics for multiple Patient Record (row) IDs or Cohort List Name. It returns Demographics information like Name, Telecom, Marital Status, Gender, Deceased Date, Birth Date, Address, Race, Ethnicity and other Demographics associated information.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
cohortListName(optional): string
Cohort list name
-
id(optional): array
Collection Format:
multi
Patient Row ID(s) (cannot be passed while requesting for patients by cohort list name) -
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 : PageableCollectionPatient
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 Patient
Model for a Patient 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 : Patient
Type:
object
Model for a Patient object in CDM.
Show Source
-
address(optional):
object Address
Model for a postal address.
-
ageInYears(optional):
integer(int32)
Age in Years
-
birthDate(optional):
string(date-time)
Date of Birth
-
deceasedBoolean(optional):
boolean
Alive or Deceased
-
deceasedDate(optional):
string(date-time)
Deceased Date
-
ethnicity(optional):
object LinkedReference
-
gender(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.
-
identifiers(optional):
array identifiers
A list of identifiers assigned to this patient
-
lastContactDate(optional):
string(date-time)
Last Contact Date
-
maritalStatus(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.
-
name(optional):
object HumanName
Model for a name of a human with text and parts information.
-
race(optional):
object LinkedReference
-
subject(optional):
object LinkedReference
-
telecom(optional):
object Telecom
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 : 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 : identifiers
Type:
array
A list of identifiers assigned to this patient
Show Source
-
Array of:
object Identifier
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.
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 : 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.
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 : given
Type:
array
Given names (not always 'first'). Includes middle names.
Show Source
400 Response
Invalid parameters supplied
404 Response
Patient(s) not found
Examples
The following example submits a GET request.
API URL ??? Cohort List
http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients?cohortListName=Cohort_List_Test3
Example of Response Body
The following example shows the response returned in JSON format.
{ "items": [ { "identifiers": [ { "system": "CDM", "value": "1" }, { "system": "Customer Defined", "value": "P1_1" } ], "name": { "text": "James MN1 Young", "family": "Young", "given": [ "James", "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": "/ohfapi/cg/v3.3/patientapi/patients/1/race" }, "ethnicity": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/1/ethnicity" }, "subject": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/1/subjects" } }, { "identifiers": [ { "system": "CDM", "value": "2" }, { "system": "Customer Defined", "value": "P2_2" } ], "name": { "text": "William MN2 Perry", "family": "Perry", "given": [ "William", "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": "/ohfapi/cg/v3.3/patientapi/patients/2/race" }, "ethnicity": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/2/ethnicity" }, "subject": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/2/subjects" } }, { "identifiers": [ { "system": "CDM", "value": "3" }, { "system": "Customer Defined", "value": "P3_3" } ], "name": { "text": "FN3 MN3 LN3", "family": "LN3", "given": [ "FN3", "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": "/ohfapi/cg/v3.3/patientapi/patients/3/race" }, "ethnicity": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/3/ethnicity" }, "subject": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/3/subjects" } }, { "identifiers": [ { "system": "CDM", "value": "4" }, { "system": "Customer Defined", "value": "P4_4" } ], "name": { "text": "FN4 MN4 LN4", "family": "LN4", "given": [ "FN4", "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": "/ohfapi/cg/v3.3/patientapi/patients/4/race" }, "ethnicity": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/4/ethnicity" }, "subject": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/4/subjects" } } ], "count": 4, "hasMore": false, "links": [ { "rel": "self", "href": "locahost:7010/ohfapi/cg/v3.3/patientapi/patients?cohortListName=Cohort_List_Test3" } ] }
API URL ??? Patient Identifier
http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients?id=1&id=2&id=3&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": "P1_1" } ], "name": { "text": "James MN1 Young", "family": "Young", "given": [ "James", "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": "/ohfapi/cg/v3.3/patientapi/patients/1/race" }, "ethnicity": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/1/ethnicity" }, "subject": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/1/subjects" } }, { "identifiers": [ { "system": "CDM", "value": "2" }, { "system": "Customer Defined", "value": "P2_2" } ], "name": { "text": "William MN2 Perry", "family": "Perry", "given": [ "William", "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": "/ohfapi/cg/v3.3/patientapi/patients/2/race" }, "ethnicity": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/2/ethnicity" }, "subject": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/2/subjects" } }, { "identifiers": [ { "system": "CDM", "value": "3" }, { "system": "Customer Defined", "value": "P3_3" } ], "name": { "text": "FN3 MN3 LN3", "family": "LN3", "given": [ "FN3", "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": "/ohfapi/cg/v3.3/patientapi/patients/3/race" }, "ethnicity": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/3/ethnicity" }, "subject": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/3/subjects" } } ], "count": 3, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients?id=1&id=2&id=3&limit=10&offset=0" } ] }