---
title: "Appointment"
canonical: "https://wiki.patientsknowbest.com/space/api/3363897439/Appointment"
format: markdown
---
[https://www.hl7.org/fhir/STU3/appointment.html](https://www.hl7.org/fhir/STU3/appointment.html)

## Status

In development. API spec subject to change.

## Overview

The Appointment resource can be used to retrieve details of the patient's [[Appointment]]s.

## Relevant PKB entities

- [[[Appointment]]](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363700789)
- [[[Appointment Participant]]](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363700789)

## Endpoints

|  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- |
| Interaction | HTTP | URL | Supported Parameters | Permitted User Types | Description | Examples |
| [search](https://www.hl7.org/fhir/STU3/http.html#search) | GET | /Appointment | - **patient.**  Required. Multi-value support: none. Modifier support: [<type>].
- **date.**   Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le]. | - Patient
- Professional | Retrieve appointments for a given patient, optionally restricted by date range. | /Appointment?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01 |

## Mappings

See [here for a discussion about further mappings](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364618394).

|  |  |  |
| --- | --- | --- |
| FHIR | PKB | Notes |
| Resource id | [[Appointment.Data Point ID]] |  |
| Resource meta | - meta: Meta
  - lastUpdated = [[Data Point.Persisted Timestamp]]
  - security: Coding
    - system =  "[http://fhir.patientsknowbest.com/codesystem/privacy-label](http://fhir.patientsknowbest.com/codesystem/privacy-label)"
    - code = [[Data Point.Privacy Label]]<br>[[Data Point.Privacy Label]] code mappings (PKB → FHIR):<br>- GENERAL_HEALTH → GENERAL_HEALTH
- MENTAL_HEALTH → MENTAL_HEALTH
- SEXUAL_HEALTH → SEXUAL_HEALTH
- SOCIAL_CARE → SOCIAL_CARE |  |
| Appointment.status | [[Appointment.Status]]<br>[[Appointment.Status]] code mappings (PKB → FHIR):<br>- ACTIVE → booked
- CANCELLED  → cancelled
- DNA → noshow |  |
| Appointment.start | [[Appointment.Start Timestamp]] |  |
| Appointment.end | [[Appointment.End Timestamp]] |  |