# Appointment

Canonical page: https://docs.ovok.com/api/fhir/r4/appointment

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Appointment/[id]` |
| Vread | `GET` | `/fhir/R4/Appointment/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Appointment/[id]` |
| Patch | `PATCH` | `/fhir/R4/Appointment/[id]` |
| Delete | `DELETE` | `/fhir/R4/Appointment/[id]` |
| Create | `POST` | `/fhir/R4/Appointment` |
| Search | `GET` | `/fhir/R4/Appointment` |
| History | `GET` | `/fhir/R4/Appointment/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | External Ids for this item |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error \| checked-in \| waitlist |
| <span id="element-cancelation-reason"></span>`cancelationReason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | The coded reason for the appointment being cancelled |
| <span id="element-service-category"></span>`serviceCategory` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | A broad categorization of the service that is to be performed during this appointment |
| <span id="element-service-type"></span>`serviceType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The specific service that is to be performed during this appointment |
| <span id="element-specialty"></span>`specialty` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The specialty of a practitioner that would be required to perform the service requested in this appointment |
| <span id="element-appointment-type"></span>`appointmentType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | The style of appointment or patient that has been booked in the slot (not service type) |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Coded reason this appointment is scheduled |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Reason the appointment is to take place (resource) |
| <span id="element-priority"></span>`priority` | [unsignedInt](/fhir-elements/primitive/unsigned-int) | `0..1` | Used to make informed decisions if needing to re-prioritize |
| <span id="element-description"></span>`description` | [string](/fhir-elements/primitive/string) | `0..1` | Shown on a subject line in a meeting request, or appointment list |
| <span id="element-supporting-information"></span>`supportingInformation` | [Reference](/fhir-elements/complex/reference) | `0..*` | Additional information to support the appointment |
| <span id="element-start"></span>`start` | [instant](/fhir-elements/primitive/instant) | `0..1` | When appointment is to take place |
| <span id="element-end"></span>`end` | [instant](/fhir-elements/primitive/instant) | `0..1` | When appointment is to conclude |
| <span id="element-minutes-duration"></span>`minutesDuration` | [positiveInt](/fhir-elements/primitive/positive-int) | `0..1` | Can be less than start/end (e.g. estimate) |
| <span id="element-slot"></span>`slot` | [Reference](/fhir-elements/complex/reference) | `0..*` | The slots that this appointment is filling |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | The date that this appointment was initially created |
| <span id="element-comment"></span>`comment` | [string](/fhir-elements/primitive/string) | `0..1` | Additional comments |
| <span id="element-patient-instruction"></span>`patientInstruction` | [string](/fhir-elements/primitive/string) | `0..1` | Detailed information and instructions for the patient |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | The service request this appointment is allocated to assess |
| <span id="element-participant"></span>`participant` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..*` | Participants involved in appointment |
| <span id="element-requested-period"></span>`requestedPeriod` | [Period](/fhir-elements/complex/period) | `0..*` | Potential date/time interval(s) requested to allocate the appointment within |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `actor` | reference | Any one of the individuals participating in the appointment |
| `appointment-type` | token | The style of appointment or patient that has been booked in the slot (not service type) |
| `based-on` | reference | The service request this appointment is allocated to assess |
| `date` | date | Appointment date/time. |
| `identifier` | token | An Identifier of the Appointment |
| `location` | reference | This location is listed in the participants of the appointment |
| `part-status` | token | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. |
| `patient` | reference | One of the individuals of the appointment is this patient |
| `practitioner` | reference | One of the individuals of the appointment is this practitioner |
| `reason-code` | token | Coded reason this appointment is scheduled |
| `reason-reference` | reference | Reason the appointment is to take place (resource) |
| `service-category` | token | A broad categorization of the service that is to be performed during this appointment |
| `service-type` | token | The specific service that is to be performed during this appointment |
| `slot` | reference | The slots that this appointment is filling |
| `specialty` | token | The specialty of a practitioner that would be required to perform the service requested in this appointment |
| `status` | token | The overall status of the appointment |
| `supporting-info` | reference | Additional information to support the appointment |

## Reference [#reference]

Official FHIR R4 spec: [Appointment](https://hl7.org/fhir/R4/appointment.html).  
Maturity: Trial Use 3 (FMM 3).
