appointments

Create Appointment

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

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringAppointmentThis is a Appointment resource
identifierarray(Identifier)This records identifiers associated with this appointment 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 (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|pending|booked|arrived|fulfilled|cancelled|noshow|entered-in-errorThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that has been booked in the slot (not service type).
reasonarray(CodeableConcept)The reason that this appointment is being scheduled. This is more clinical than administrative.
indicationarray(Reference)Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
prioritynumberThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
descriptionstringThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
supportingInformationarray(Reference)Additional information to support the appointment provided when making the appointment.
startstringDate/Time that the appointment is to take place.
endstringDate/Time that the appointment is to conclude.
minutesDurationnumberNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
slotarray(Reference)The slots from the participants' schedules that will be filled by the appointment.
createdstringThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
commentstringAdditional comments about the appointment.
incomingReferralarray(Reference)The referral request this appointment is allocated to assess (incoming referral).
participant*array(Appointment_Participant)List of participants involved in the appointment.
requestedPeriodarray(Period)A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.

Response

Patch Appointment

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

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

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*stringAppointmentThis is a Appointment resource
identifierarray(Identifier)This records identifiers associated with this appointment 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 (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|pending|booked|arrived|fulfilled|cancelled|noshow|entered-in-errorThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that has been booked in the slot (not service type).
reasonarray(CodeableConcept)The reason that this appointment is being scheduled. This is more clinical than administrative.
indicationarray(Reference)Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
prioritynumberThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
descriptionstringThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
supportingInformationarray(Reference)Additional information to support the appointment provided when making the appointment.
startstringDate/Time that the appointment is to take place.
endstringDate/Time that the appointment is to conclude.
minutesDurationnumberNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
slotarray(Reference)The slots from the participants' schedules that will be filled by the appointment.
createdstringThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
commentstringAdditional comments about the appointment.
incomingReferralarray(Reference)The referral request this appointment is allocated to assess (incoming referral).
participant*array(Appointment_Participant)List of participants involved in the appointment.
requestedPeriodarray(Period)A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.

Response

Read Appointment

get
/organizations/{organizationId}/fhir/3/Appointment/{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

get
/organizations/{organizationId}/fhir/3/Appointment/{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

get
/organizations/{organizationId}/fhir/3/Appointment/{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

delete
/organizations/{organizationId}/fhir/3/Appointment/{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

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

Request

Headers

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

Query params

_idstring
_languagestring
actorstring
appointment-typestring
datestring
identifierstring
incomingreferralstring
locationstring
part-statusstring
patientstring
pertains-tostring
practitionerstring
reasonstring
reason-codestring
service-typestring
slotstring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Appointment

get
/organizations/{organizationId}/fhir/3/Appointment/_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

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

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

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
appointment-typestring
datestring
identifierstring
incomingreferralstring
locationstring
part-statusstring
patientstring
pertains-tostring
practitionerstring
reasonstring
reason-codestring
service-typestring
slotstring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringAppointmentThis is a Appointment resource
identifierarray(Identifier)This records identifiers associated with this appointment 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 (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|pending|booked|arrived|fulfilled|cancelled|noshow|entered-in-errorThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that has been booked in the slot (not service type).
reasonarray(CodeableConcept)The reason that this appointment is being scheduled. This is more clinical than administrative.
indicationarray(Reference)Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
prioritynumberThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
descriptionstringThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
supportingInformationarray(Reference)Additional information to support the appointment provided when making the appointment.
startstringDate/Time that the appointment is to take place.
endstringDate/Time that the appointment is to conclude.
minutesDurationnumberNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
slotarray(Reference)The slots from the participants' schedules that will be filled by the appointment.
createdstringThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
commentstringAdditional comments about the appointment.
incomingReferralarray(Reference)The referral request this appointment is allocated to assess (incoming referral).
participant*array(Appointment_Participant)List of participants involved in the appointment.
requestedPeriodarray(Period)A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.

Response

Update Appointment

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

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAppointmentThis is a Appointment resource
identifierarray(Identifier)This records identifiers associated with this appointment 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 (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|pending|booked|arrived|fulfilled|cancelled|noshow|entered-in-errorThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
serviceCategoryCodeableConceptA broad categorisation of the service that is to be performed during this appointment.
serviceTypearray(CodeableConcept)The specific service that is to be performed during this appointment.
specialtyarray(CodeableConcept)The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that has been booked in the slot (not service type).
reasonarray(CodeableConcept)The reason that this appointment is being scheduled. This is more clinical than administrative.
indicationarray(Reference)Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
prioritynumberThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
descriptionstringThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
supportingInformationarray(Reference)Additional information to support the appointment provided when making the appointment.
startstringDate/Time that the appointment is to take place.
endstringDate/Time that the appointment is to conclude.
minutesDurationnumberNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
slotarray(Reference)The slots from the participants' schedules that will be filled by the appointment.
createdstringThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
commentstringAdditional comments about the appointment.
incomingReferralarray(Reference)The referral request this appointment is allocated to assess (incoming referral).
participant*array(Appointment_Participant)List of participants involved in the appointment.
requestedPeriodarray(Period)A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.

Response