Retrieve Patient's Date of Birth
Overview
This endpoint allows a PFS Consumer app to retrieve the patient’s date of birth.
Making a Request
HTTP method: GET
Endpoint URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/dob
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/dob
Authorization: Bearer [token]Response Details
Properties
Field | Type | Description |
|---|---|---|
| date (ISO 8601 date format) | The patient’s date of birth |
Specific Response Codes
HTTP Code | Error Code | Scenario |
|---|---|---|
|
| Request successful |
Example Response
JSON
HTTP/1.1 200 OK
Content-Type: application/json
{
"dob": "2005-06-10"
}