Retrieve the Patient's NHS Number
Overview
This endpoint allows a PFS Consumer app to retrieve the patient’s NHS Number.
Making a Request
HTTP method: GET
Endpoint URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/nhs-number
Request Headers
Header | Value | Description |
|---|---|---|
|
| The JWT token provided by the Consumer |
URL Parameters
Parameter | Description | Validation Rules |
|---|---|---|
| Patient ID e.g. | Mandatory UUID |
Example Request
CODE
GET /pfs-api/v1/patient/e9af860e-cf8e-4272-b81a-a95cc8a531f7/nhs-number
Authorization: Bearer [token]Response Details
Properties
Field | Type | Description |
|---|---|---|
| NHS Number (string) | The patient’s NHS number Example: |
Specific Response Codes
HTTP Code | Error Code | Scenario |
|---|---|---|
|
| Request successful |
Example Response
JSON
HTTP/1.1 200 OK
Content-Type: application/json
{
"nhsNumber": "2343554277"
}