Skip to main content

AppointmentResponse

Trial Use 3 Workflow

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/AppointmentResponse
InteractionMethodPath
ReadGET/fhir/R5/AppointmentResponse/[id]
VreadGET/fhir/R5/AppointmentResponse/[id]/_history/[vid]
UpdatePUT/fhir/R5/AppointmentResponse/[id]
PatchPATCH/fhir/R5/AppointmentResponse/[id]
DeleteDELETE/fhir/R5/AppointmentResponse/[id]
CreatePOST/fhir/R5/AppointmentResponse
SearchGET/fhir/R5/AppointmentResponse?...
HistoryGET/fhir/R5/AppointmentResponse/[id]/_history
Type-historyGET/fhir/R5/AppointmentResponse/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*External Ids for this item
appointmentReference1..1Appointment this response relates to
proposedNewTimeboolean0..1Indicator for a counter proposal
startinstant0..1Time from appointment, or requested new start time
endinstant0..1Time from appointment, or requested new end time
participantTypeCodeableConcept0..*Role of participant in the appointment
actorReference0..1Person(s), Location, HealthcareService, or Device
participantStatuscode1..1accepted
commentmarkdown0..1Additional comments
recurringboolean0..1This response is for all occurrences in a recurring request
occurrenceDatedate0..1Original date within a recurring request
recurrenceIdpositiveInt0..1The recurrence ID of the specific recurring request

Resource-specific search parameters

ParameterTypeDescription
actorreferenceThe Person, Location/HealthcareService or Device that this appointment response replies for
appointmentreferenceThe appointment that the response is attached to
groupreferenceThis Response is for this Group
identifiertokenAccount number
locationreferenceThis Response is for this Location
part-statustokenThe participants acceptance status for this appointment
patientreferenceThe entity that caused the expenses
practitionerreferenceThis Response is for this Practitioner

Reference