List Linked Patients

Overview

The List Linked Patients endpoint allows Patient Facing Services apps to receive a list of the PFS Accounts that are associated with the App User Linkage.

Prerequisites

The app’s user identifier must be supplied as part of the userIdentifierValue claim in the JWT token (see JWT Token).

Making a Request

HTTP method: GET

Endpoint URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/user/list-linked-patients

Request Headers

Header	Value	Description
`Authorization`	`Bearer [token]`	The JWT token provided by the Consumer

Example Request

CODE

GET /pfs-api/v1/user/list-linked-patients
Authorization: Bearer [token]
X-User-Identifier a83569be-3fc8-4396-b11e-0faeefaa5fe3

Response Details

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		The request

Properties

Field	Type	Description
`associatedPatients`	array	An array of patients that are available to the app

associatedPatients

Field	Type	Description
id	UUID	The patient’s ID.
`name`	string	The full name of the patient.
`associationType`	enum	The type of association. Can be either “patient” or “proxy”.
`careRecordAccess`	boolean	Is care record access (the journal) available for this patient?
`appointmentManagement`	boolean	Is appointment management available for this patient?
`prescriptionOrdering`	boolean	Is prescription ordering available for this patient?

Example Response (One or More Linked Patients)

JSON

HTTP/1.1 200 OK
Content-Type: application/json

{
    "associatedPatients": [
        {
            "id": "ea358b82-360c-11ed-91f6-060b232f1aa2",
            "name": "MR Kurt BIGGS",
            "associationType": "self",
            "careRecordAccess": "enabled",
            "appointmentManagement": "enabled",
            "prescriptionOrdering": "enabled"
        },{
            "id": "f3d33f42-1f3b-4821-8fbe-cf26124b1de6",
            "name": "MR Steve SMITH",
            "associationType": "proxy",
            "careRecordAccess": "disabled",
            "appointmentManagement": "disabled",
            "prescriptionOrdering": "disabled"
        }
    ]
}

Example Response (Zero Linked Patients)

JSON

HTTP/1.1 200 OK
Content-Type: application/json
{
    "associatedPatients": []
}