Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

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.

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"API resource type."
        },
        "subject":{
            "type":"array",
            "description":"List of clinical API URIs to get details for the subjects that associated with particular patient.",
            "items":{
                "$ref":"#/definitions/LinkedReference"
            }
        },
        "patient":{
            "description":"Clinical API URI to get details about the patient that is associated with the listed subjects.",
            "$ref":"#/definitions/LinkedReference"
        }
    },
    "description":"Model for the list of the Subjects references for the particular Patient in CDM."
}

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : subject

Type: array

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

Show Source

• Array of: object LinkedReference

{
    "type":"array",
    "description":"List of clinical API URIs to get details for the subjects that associated with particular patient.",
    "items":{
        "$ref":"#/definitions/LinkedReference"
    }
}

400 Response

Invalid parameter supplied

404 Response

Patient Subject(s) not found

Back to Top

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"
  }
}

Back to Top