Retrieve Patient's Home Telephone Numbers

Overview

This endpoint allows a PFS Consumer app to query a patient’s home telephone numbers.

Making a Request

HTTP method: GET

Endpoint URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/home-telephone-numbers

If the response is successful, an array of the patient’s home telephone numbers is returned.
If a patient has zero home telephone numbers, 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-telephone-numbers
Authorization: Bearer [token]

Response Details

Properties

Field	Type	Description
`homeTelephoneNumbers`	array of telephone numbers	The patient’s home telephone numbers

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Request successful

Example Response

JSON

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

{
   "homeTelephoneNumbers": [
        "+441455862799",
        "+442037603944",
        "+442085768580",
        "+441273746541",
        "+442075815403"
    ]
}