Retrieve Demographics for a Patient Identifier
get
/ohfapi/cg/v3.3/patientapi/patients/{id}
This endpoint supports the retrieval of Demographics for a Patient Identifier. It returns Patient Demographic 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
Path Parameters
-
id: integer(int64)
Patient Identifier
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Model for a Patient object in CDM.
Root Schema : Patient
Type:
objectModel for a Patient object in CDM.
Show Source
-
address(optional):
object Address
Model for a postal address.
-
birthDate(optional):
string(date-time)
Date of Birth
-
deceasedBoolean(optional):
boolean
Default Value:
falseAlive 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 identifier
A list of identifiers assigned to this patient
-
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:
objectModel 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:
objectModel 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:
trueCode(s) defined by a terminology system. -
text(optional):
string
Plain text representation of the concept.
Nested Schema : identifier
Type:
arrayA list of identifiers assigned to this patient
Show Source
-
Array of:
object Identifier
Identifier assigned by a given system
Nested Schema : HumanName
Type:
objectModel 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:
arrayRead Only:
trueCode(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:
objectModel 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.
Nested Schema : Identifier
Type:
objectIdentifier assigned by a given system
Show Source
-
system(optional):
string
System which assigned this identifier
-
value(optional):
string
Identifier value
Nested Schema : given
Type:
arrayGiven 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
http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/1
Example of Response Body
The following example shows the response returned in JSON format.
{
"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"
}
}