Retrieve Patient's Home Address

Overview

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

Making a Request

HTTP method: GET

Endpoint URL: [Tenant URL]/pfs-api/v1/patient/{patientId}/home-address

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
`line1`	string	The first line of the patient’s address
`line2`	string	The second line of the patient’s address
`line3`	string	The third line of the patient’s address
`locality`	string	The patient’s address locality (a Town/city)
`administrativeArea`	string	The administrative area (the County)
`postalCode`	string	The patient’s address postcode
`country`	string	The patient’s country

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Request successful

Example Response

JSON

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

{
    "homeAddress": {
        "line1": "101A",
        "line2": "FELIXSTOWE ROAD",
        "line3": "LONDON",
        "locality": null,
        "administrativeArea": null,
        "postalCode": "N9 0DX",
        "country": "United Kingdom"
    }
}