Appointment

Owned by Andrew Turner (Unlicensed)
Last updated: Dec 06, 2022 by Tom Pick
1 min read

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

Endpoints

Interaction

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].

  • 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.

FHIR

PKB

Notes

Resource id

[[Appointment.Data Point ID]]

 

Resource meta

[[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]]



[[Appointment.Status]] code mappings (PKB → FHIR):

  • ACTIVE → booked

  • CANCELLED  → cancelled

  • DNA → noshow

 

Appointment.start

[[Appointment.Start Timestamp]]



Appointment.end

[[Appointment.End Timestamp]]