appointment responses

Create Appointment Response

post
/organizations/{organizationId}/fhir/3/AppointmentResponse

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringAppointmentResponseThis is a AppointmentResponse resource
identifierarray(Identifier)This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
appointment*ReferenceAppointment that this response is replying to.
startstringDate/Time that the appointment is to take place, or requested new start time.
endstringThis may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
participantTypearray(CodeableConcept)Role of participant in the appointment.
actorReferenceA Person, Location/HealthcareService or Device that is participating in the appointment.
participantStatusstringParticipation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
commentstringAdditional comments about the appointment.

Response

Patch Appointment Response

patch
/organizations/{organizationId}/fhir/3/AppointmentResponse/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAppointmentResponseThis is a AppointmentResponse resource
identifierarray(Identifier)This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
appointment*ReferenceAppointment that this response is replying to.
startstringDate/Time that the appointment is to take place, or requested new start time.
endstringThis may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
participantTypearray(CodeableConcept)Role of participant in the appointment.
actorReferenceA Person, Location/HealthcareService or Device that is participating in the appointment.
participantStatusstringParticipation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
commentstringAdditional comments about the appointment.

Response

Read Appointment Response

get
/organizations/{organizationId}/fhir/3/AppointmentResponse/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Appointment Response

get
/organizations/{organizationId}/fhir/3/AppointmentResponse/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Appointment Response

get
/organizations/{organizationId}/fhir/3/AppointmentResponse/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Appointment Response

delete
/organizations/{organizationId}/fhir/3/AppointmentResponse/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Appointment Response

get
/organizations/{organizationId}/fhir/3/AppointmentResponse

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actorstring
appointmentstring
identifierstring
locationstring
part-statusstring
patientstring
practitionerstring

Params

organizationId*string|stringid|slug

Response

Search History Appointment Response

get
/organizations/{organizationId}/fhir/3/AppointmentResponse/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Appointment Response

post
/organizations/{organizationId}/fhir/3/AppointmentResponse/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actorstring
appointmentstring
identifierstring
locationstring
part-statusstring
patientstring
practitionerstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringAppointmentResponseThis is a AppointmentResponse resource
identifierarray(Identifier)This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
appointment*ReferenceAppointment that this response is replying to.
startstringDate/Time that the appointment is to take place, or requested new start time.
endstringThis may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
participantTypearray(CodeableConcept)Role of participant in the appointment.
actorReferenceA Person, Location/HealthcareService or Device that is participating in the appointment.
participantStatusstringParticipation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
commentstringAdditional comments about the appointment.

Response

Update Appointment Response

put
/organizations/{organizationId}/fhir/3/AppointmentResponse/{resourceId}

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAppointmentResponseThis is a AppointmentResponse resource
identifierarray(Identifier)This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
appointment*ReferenceAppointment that this response is replying to.
startstringDate/Time that the appointment is to take place, or requested new start time.
endstringThis may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
participantTypearray(CodeableConcept)Role of participant in the appointment.
actorReferenceA Person, Location/HealthcareService or Device that is participating in the appointment.
participantStatusstringParticipation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
commentstringAdditional comments about the appointment.

Response