Retrieve Patient's Email Address

Overview

This endpoint allows a PFS Consumer app to retrieve a list of the patient's email addresses.

Making a Request

HTTP method: GET

Endpoint URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/email-addresses

If the response is successful, an array of the patient’s email addresses is returned.

A patient can have more than one email address, therefor the result is returned as an array.
If a patient has zero email addresses, then an empty array is returned.

Request Headers

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

URL Parameters

Parameter

Description

Validation Rules

patientId

Patient ID

e.g. e9af860e-cf8e-4272-b81a-a95cc8a531f7

Mandatory

UUID

Example Request

CODE

GET /pfs-api/v1/patient/e9af860e-cf8e-4272-b81a-a95cc8a531f7/home-addresses
Authorization: Bearer [token]

Response Details

Properties

Field

Type

Description

emailAddresses

An array of Email address strings

The patient’s Email address

Example:patient@email.com

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Request successful

Example Response

JSON

HTTP/1.1 200 OK
Content-Type: application/json
{
    "emailAddresses": [
        "huahua7wxws@papakiung.com",
        "serolenich@dlyemail.com",
        "anouchvl@dmxs8.com"
    ]
}