# AppointmentResponse

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

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

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/AppointmentResponse/[id]` |
| Vread | `GET` | `/fhir/R4/AppointmentResponse/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/AppointmentResponse/[id]` |
| Patch | `PATCH` | `/fhir/R4/AppointmentResponse/[id]` |
| Delete | `DELETE` | `/fhir/R4/AppointmentResponse/[id]` |
| Create | `POST` | `/fhir/R4/AppointmentResponse` |
| Search | `GET` | `/fhir/R4/AppointmentResponse` |
| History | `GET` | `/fhir/R4/AppointmentResponse/[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-appointment"></span>`appointment` | [Reference](/fhir-elements/complex/reference) | `1..1` | Appointment this response relates to |
| <span id="element-start"></span>`start` | [instant](/fhir-elements/primitive/instant) | `0..1` | Time from appointment, or requested new start time |
| <span id="element-end"></span>`end` | [instant](/fhir-elements/primitive/instant) | `0..1` | Time from appointment, or requested new end time |
| <span id="element-participant-type"></span>`participantType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Role of participant in the appointment |
| <span id="element-actor"></span>`actor` | [Reference](/fhir-elements/complex/reference) | `0..1` | Person, Location, HealthcareService, or Device |
| <span id="element-participant-status"></span>`participantStatus` | [code](/fhir-elements/primitive/code) | `1..1` | accepted \| declined \| tentative \| needs-action |
| <span id="element-comment"></span>`comment` | [string](/fhir-elements/primitive/string) | `0..1` | Additional comments |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `actor` | reference | The Person, Location/HealthcareService or Device that this appointment response replies for |
| `appointment` | reference | The appointment that the response is attached to |
| `identifier` | token | An Identifier in this appointment response |
| `location` | reference | This Response is for this Location |
| `part-status` | token | The participants acceptance status for this appointment |
| `patient` | reference | This Response is for this Patient |
| `practitioner` | reference | This Response is for this Practitioner |

## Reference [#reference]

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