Retrieve Patient's Mobile Telephone

Overview

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

Making a Request

HTTP method: GET

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

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

Response Details

Properties

Field	Type	Description
`mobileTelephoneNumbers`	array of telephone number	The patient’s mobile 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

{
    "mobileTelephoneNumbers": [
        "01273 360500",
        "01345 568304",
    ]
}