AppointmentResponse
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
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | External Ids for this item |
appointment | Reference | 1..1 | Appointment this response relates to |
start | instant | 0..1 | Time from appointment, or requested new start time |
end | instant | 0..1 | Time from appointment, or requested new end time |
participantType | CodeableConcept | 0..* | Role of participant in the appointment |
actor | Reference | 0..1 | Person, Location, HealthcareService, or Device |
participantStatus | code | 1..1 | accepted | declined | tentative | needs-action |
comment | string | 0..1 | Additional comments |
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
Official FHIR R4 spec: AppointmentResponse.
Maturity: Trial Use 3 (FMM 3).