REST API for Oracle Healthcare Translational Research

Retrieve Subjects for a Patient Identifier

get

/HSDataService-web/api/3.2.0/patientapi/patients/{id}/subjects

This endpoint supports the retrieval of Patient Subjects for a Patient Identifier. It returns information like References to the Patient Subjects and Patient Details.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Patient Identifier

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for the list of the Subjects references for the particular Patient in CDM.

Root Schema : PatientSubjects

Type: object

Model for the list of the Subjects references for the particular Patient in CDM.

Properties

patient: Type: object LinkedReference
resourceType: Type: string

API resource type.
subject: Type: array subject

List of clinical API URIs to get details for the subjects that associated with particular patient.

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : subject

Type: array

List of clinical API URIs to get details for the subjects that associated with particular patient.

Items

Type: object LinkedReference

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/HSDataService-web/api/3.2.0/patientapi/patients/6/subjects

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "Subject",
  "subject": [
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/89993"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/89994"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/30015"
    }
  ],
  "patient": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/6"
  }
}