Retrieve Subjects for a Patient Record Id
get
/ohfapi/cg/v3.3/patientapi/patients/{id}/subjects
This endpoint supports the retrieval of Patient Subjects for a Patient Record Id (row id). It returns information like References to the Patient Subjects and Patient Details.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
Patient Record Id
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PatientSubjects
Type:
object
Model for the list of the Subjects references for the particular Patient in CDM.
Show Source
-
patient(optional):
object LinkedReference
-
resourceType(optional):
string
API resource type.
-
subject(optional):
array subject
List of clinical API URIs to get details for the subjects that associated with particular patient.
Nested Schema : subject
Type:
array
List of clinical API URIs to get details for the subjects that associated with particular patient.
Show Source
400 Response
Invalid parameter supplied
404 Response
Patient Subject(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:port/ohfapi/cg/v3.3/patientapi/patients/6/subjects
Example of Response Body
The following example shows the response returned in JSON format.
{ "resourceType": "Subject", "subject": [ { "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/89993" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/89994" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/30015" } ], "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/6" } }