Retrieve Patient's Name

Overview

This endpoint allows a PFS Consumer app to retrieve the patient’s name.

Making a Request

HTTP method: GET

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

If the response is successful, all of the patient’s name fields are returned. If one of the fields is blank in Medicus, then a null value will be returned for that field.

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/name
Authorization: Bearer [token]

Response Details

Properties

Field	Type	Description
`prefix`	string	The patient’s name prefix
`givenNames`	string	The patient’s given name
`middleNames`	string	The patient’s middle name
`familyName`	string	The patient’s family name
`suffix`	string	The patient’s suffix
`preferredName`	string	The patient’s preferred full name as a concatinated string

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Request successful

Example Response

JSON

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

{
    "prefix": "Miss", 
    "givenName": "Evelyn",
    "middleNames": "Millie",
    "familyName": "Turner",
    "suffix": "I",
    "preferredName": "Evie Turner"
}