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​

alphahttps://api.dev.ovok.com/fhir/R4/AppointmentResponse
InteractionMethodPath
ReadGET/fhir/R4/AppointmentResponse/[id]
VreadGET/fhir/R4/AppointmentResponse/[id]/_history/[vid]
UpdatePUT/fhir/R4/AppointmentResponse/[id]
PatchPATCH/fhir/R4/AppointmentResponse/[id]
DeleteDELETE/fhir/R4/AppointmentResponse/[id]
CreatePOST/fhir/R4/AppointmentResponse
SearchGET/fhir/R4/AppointmentResponse
HistoryGET/fhir/R4/AppointmentResponse/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*External Ids for this item
appointmentReference1..1Appointment this response relates to
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, Location, HealthcareService, or Device
participantStatuscode1..1accepted | declined | tentative | needs-action modifier
commentstring0..1Additional comments

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
actorstringhttp://hl7.org/fhir/SearchParameter/AppointmentResponse-actor
appointmentstringhttp://hl7.org/fhir/SearchParameter/AppointmentResponse-appointment
identifierstringhttp://hl7.org/fhir/SearchParameter/AppointmentResponse-identifier
locationstringhttp://hl7.org/fhir/SearchParameter/AppointmentResponse-location
part-statusstringhttp://hl7.org/fhir/SearchParameter/AppointmentResponse-part-status
patientstringhttp://hl7.org/fhir/SearchParameter/AppointmentResponse-patient
practitionerstringhttp://hl7.org/fhir/SearchParameter/AppointmentResponse-practitioner

Reference​