Retrieve Patient for a Subject Identifier
get
/HSDataService-web/api/3.2.0/subjectapi/subjects/{id}/patients
This endpoint supports the retrieval of Patient details for a Subject Identifier. It returns Subject Patient details like Subject Patient Demographics and other Subject Patient associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
- id
-
Type:
integer
(int64
)Required:true
Subject Identifier
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Body
Model for a Patient object in CDM.
Root Schema : Patient
Type:
object
Model for a Patient object in CDM.
- address
-
Type:
object
AddressModel for a postal address. - birthDate
-
Type:
string
(date-time
)Date of Birth - deceasedBoolean
-
Type:
boolean
Default Value:false
Alive or Deceased - deceasedDate
-
Type:
string
(date-time
)Deceased 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
identifiersA list of identifiers assigned to this patient - 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. - race
-
Type:
object
LinkedReference - subject
-
Type:
object
LinkedReference - telecom
-
Type:
object
Telecom
Nested Schema : Address
Type:
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 : LinkedReference
Type:
object
- display
-
Type:
string
- reference
-
Type:
string
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.
- coding
-
Type:
array
codingRead Only:true
Code(s) defined by a terminology system. - text
-
Type:
string
Plain text representation of the concept.
Nested Schema : identifiers
Type:
array
A list of identifiers assigned to this patient
-
Type:
object
IdentifierIdentifier assigned by a given system
Nested Schema : HumanName
Type:
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 : Telecom
Type:
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 : line
Nested Schema : coding
Nested Schema : Coding
Type:
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 : Identifier
Type:
object
Identifier assigned by a given system
- system
-
Type:
string
System which assigned this identifier - value
-
Type:
string
Identifier value
Nested Schema : given
400 Response
Invalid parameter supplied
404 Response
Subject's Patient not found
Examples
The following example submits a GET request.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients
Example of Response Body
The following example shows the response returned in JSON format.
{ "identifiers": [ { "system": "CDM", "value": "4" }, { "system": "Customer Defined", "value": "P44528" } ], "name": { "text": "Maria Isabella Sanchez", "family": "Sanchez", "given": [ "Maria", "Isabella" ] }, "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": "0", "display": "Female", "description": "Female", "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": [ "885 Centre St.", "Apt 721", "-" ], "city": "Newton", "district": "Middlesex", "state": { "coding": [ { "code": "MA", "display": "Massachusetts", "description": "Massachusetts", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "postalCode": "02467", "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/patientapi/patients/4/race" }, "ethnicity": { "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/4/ethnicity" }, "subject": { "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/4/subjects" } }