Skip to main content

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.

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​

ElementTypeCardinalityDescription
idstring0..1Logical id of this artifact
metaMeta0..1Metadata about the resource
implicitRulesuri0..1A set of rules under which this content was created
languagecode0..1Language of the resource content
textNarrative0..1Text summary of the resource, for human interpretation
containedResource0..*Contained, inline Resources
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored
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
commentstring0..1Additional comments

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
identifiertokenAn Identifier in this appointment response
locationreferenceThis Response is for this Location
part-statustokenThe participants acceptance status for this appointment
patientreferenceThis Response is for this Patient
practitionerreferenceThis Response is for this Practitioner

Reference​

Official FHIR R4 spec: AppointmentResponse.
Maturity: Trial Use 3 (FMM 3).