Appointment

https://www.hl7.org/fhir/STU3/appointment.html

Status

Released. Further enhancements planned.

Overview

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

Relevant PKB entities

Endpoints

InteractionHTTPURLSupported ParametersPermitted User TypesDescriptionExamples (more)
searchGET/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].
  • _revinclude=Provenance:target
  • Patient
  • Professional
Retrieve appointments for a specific patient, optionally restricted by date range.

In addition, can optionally include source information.		/Appointment?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01

/Appointment?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01&_revinclude=Provenance:target

Mappings

FHIRPKBNotes
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.extension
  • extension[0]: Extension
    • url = "http://fhir.patientsknowbest.com/structuredefinition/specialty"
    • valueCoding: Coding
      • code = [[Data Point.Specialty]]
 
Appointment.status
[[Appointment.Status]]

[[Appointment.Status]] code mappings (PKB → FHIR):
  • ACTIVE → booked
  • CANCELLED  → cancelled
  • DNA → noshow
 
Appointment.reason
  • reason: CodeableConcept
    • coding[0]: Coding
      • display = [[Appointment.Subject]]
 
Appointment.start[[Appointment.Start Timestamp]]
Appointment.end[[Appointment.End Timestamp]] 
Appointment.comment[[Appointment.Description]] 
Appointment.participantFor the [[Appointment->Appointment Participant]] corresponding to the [[Patient]], add a Reference to the Patient resource.
  • participant: BackboneElement
    • actor: Reference
      • reference = the relative URL of the Patient resource
      • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
    • status = "accepted"
 
 For any [[Appointment->Appointment Participant]] corresponding to a [[Professional]], add a Reference to the Practitioner resource.
  • participant: BackboneElement
    • actor: Reference
      • reference = the relative URL of the Practitioner resource
      • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
    • status = "accepted"

 For any [[Appointment->Appointment Participant]] corresponding to a [[Patient]] other than the patient receiving care (i.e. a carer), add a contained RelatedPerson resource to the response...

(see RelatedPerson mappings)

...and reference from the participant list.
  • participant: BackboneElement
    • actor: Reference
      • reference = a reference to the contained RelatedPerson resource
    • status = "accepted"

 For any [[Appointment->External Appointment Participant]], add a contained Practitioner resource to the response...
  • Practitioner.name: HumanName
    • text = [[External Appointment Participant.Name]]
...and reference from the participant list.
  • participant: BackboneElement
    • actor: Reference
      • reference = a reference to the contained Practitioner resource
    • status = "accepted"
 

If PKB has a non-blank location value, then add a contained Location resource to the response...
  • Location.description = [[Appointment.Location]]
...and reference from the participant list.
  • participant: BackboneElement
    • actor: Reference
      • reference = a reference to the contained Location resource
    • status = "accepted"

Subpages (1): Examples
Comments