StatusIn development. API spec subject to change.OverviewThe Appointment resource can be used to retrieve details of the patient's [[Appointment]]s. Relevant PKB entitiesEndpointsInteraction | HTTP | URL | Supported Parameters | Permitted User Types | Description | Examples | 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].
| | Retrieve appointments for a given patient, optionally restricted by date range. | /Appointment?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01 |
Mappings
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"
- code = [[Data Point.Privacy Label]]
[[Data Point.Privacy Label]] code mappings (PKB → FHIR):
- GENERAL_HEALTH → GENERAL_HEALTH
- MENTAL_HEALTH → MENTAL_HEALTH
- SEXUAL_HEALTH → SEXUAL_HEALTH
- SOCIAL_CARE → SOCIAL_CARE
|
| Appointment.status | [[Appointment.Status]] code mappings (PKB → FHIR): - ACTIVE → booked
- CANCELLED → cancelled
- DNA → noshow
| | Appointment.start | [[Appointment.Start Timestamp]] |
| Appointment.end | [[Appointment.End Timestamp]] | |
|
|