Scope and Usage

The KISIM-Scheudling service allows the booking, rescheduling and cancelling of an appointment.

For the creation of new appointments a slot reference is needed. Such a slot can be obtained by

• searchSlotByPlan

For the rescheduling of new appointments a slot reference is needed. Such a slot can be obtained by

• searchSlotByPlan

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
Appointment		0..*	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)
serviceCategory		0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Scheduling Appointment ServiceCategory ValueSet (preferred)
serviceType	S	0..*	CodeableConcept	The specific service that is to be performed during this appointment
slot	S	0..*	Reference(Slot)	The slots that this appointment is filling
participant	S	1..*	BackboneElement	Participants involved in appointment
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Appointment.serviceCategory	preferred	KisimSchedulingAppointmentServiceCategoryValueSet (a valid code from Scheduling Appointment ServiceCategory CodeSystem)

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	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)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Scheduling Appointment ServiceCategory ValueSet (preferred)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
slot	S	0..*	Reference(Slot)	The slots that this appointment is filling
participant	SC	1..*	BackboneElement	Participants involved in appointment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Appointment.status	required	AppointmentStatus
Appointment.serviceCategory	preferred	KisimSchedulingAppointmentServiceCategoryValueSet (a valid code from Scheduling Appointment ServiceCategory CodeSystem)
Appointment.serviceType	example	ServiceType
Appointment.participant.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	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)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Scheduling Appointment ServiceCategory ValueSet (preferred)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
reasonCode	Σ	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
start	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot	S	0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
participant	SC	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	example	AppointmentCancellationReason
Appointment.serviceCategory	preferred	KisimSchedulingAppointmentServiceCategoryValueSet (a valid code from Scheduling Appointment ServiceCategory CodeSystem)
Appointment.serviceType	example	ServiceType
Appointment.specialty	preferred	PracticeSettingCodeValueSet
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes
Appointment.reasonCode	preferred	EncounterReasonCodes
Appointment.participant.type	extensible	ParticipantType
Appointment.participant.required	required	ParticipantRequired
Appointment.participant.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
Appointment		0..*	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)
serviceCategory		0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Scheduling Appointment ServiceCategory ValueSet (preferred)
serviceType	S	0..*	CodeableConcept	The specific service that is to be performed during this appointment
slot	S	0..*	Reference(Slot)	The slots that this appointment is filling
participant	S	1..*	BackboneElement	Participants involved in appointment
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Appointment.serviceCategory	preferred	KisimSchedulingAppointmentServiceCategoryValueSet (a valid code from Scheduling Appointment ServiceCategory CodeSystem)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	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)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Scheduling Appointment ServiceCategory ValueSet (preferred)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
slot	S	0..*	Reference(Slot)	The slots that this appointment is filling
participant	SC	1..*	BackboneElement	Participants involved in appointment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Appointment.status	required	AppointmentStatus
Appointment.serviceCategory	preferred	KisimSchedulingAppointmentServiceCategoryValueSet (a valid code from Scheduling Appointment ServiceCategory CodeSystem)
Appointment.serviceType	example	ServiceType
Appointment.participant.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	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)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Scheduling Appointment ServiceCategory ValueSet (preferred)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
reasonCode	Σ	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
start	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot	S	0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
participant	SC	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	example	AppointmentCancellationReason
Appointment.serviceCategory	preferred	KisimSchedulingAppointmentServiceCategoryValueSet (a valid code from Scheduling Appointment ServiceCategory CodeSystem)
Appointment.serviceType	example	ServiceType
Appointment.specialty	preferred	PracticeSettingCodeValueSet
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes
Appointment.reasonCode	preferred	EncounterReasonCodes
Appointment.participant.type	extensible	ParticipantType
Appointment.participant.required	required	ParticipantRequired
Appointment.participant.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Must-Support: 3 elements

Finding timeslots for booking a new appointment

To book an appointment, a client system needs to know the available time slots. Slots can be found with a so called search plan.

Search plan

A search plan is an abstraction of a set of rooms and practitioners which are grouped together to provide a service. Such a group could for example be a clinic inside the hospital such as gynecology. It could also be a group of physio therapists or an emergency clinic.

Booking the appointment

After the client has queried the server for a set of slots, an appointment can be booked on such a slot.

For the initial booking, a participant is needed inside the appointment, otherwise the appointment would not be conformant to the FHIR-Specification.

For a client to know which participant he should send with the appointment, he can query the Schedule resource. This resource belongs to a slot and contains a participant. This participant needs to be sent with the appointment.

After an appointment is created, the corresponding slot will not be persisted inside the appointment. This means, if the appointment is again queried by the client via GET request, it will not contain a Slot anymore.

Handling of slots as a client system

Since the nature of slots is quite dynamic, it is suggested to all client systems to not cache the slots for any amount of time. If a client system wishes to persist the kisim slots locally it should be noted that the slots are only valid for a short amount of time, the default here is 30 minutes, but it can be configured to be considerably shorter.

Examples

Initial booking

The following example shows an intial booking with a given slot.

POST [base]/Appointment

In this case, the appointment duration will be the size of the slot, meaning the whole slot will be filled.

This case is useful, if the client system lets the server decide how to split the slots.

Request content

{
  "resourceType": "Appointment",
  "identifier": [
    {
      "system": "http://yourproduct-example.com/fhir/apps/referralids",
      "value": "yourproduct_4019"
    }
  ],
  "slot": [
	 {
	 "reference": "Slot/4_4"
	 }
  ],
  "status": "proposed",
  "participant": [
	{
		"actor": {
			"reference": "Location/KONS-1231",
			"display": "Tets Resource Name"
		},
		"status": "accepted"
	}
  ]
}

Response

HTTP/1.1 201 OK
[other headers]

Initial booking with start and stop inside a slot

The following example shows an intial booking with a given slot.

POST [base]/Appointment

Note that the appointment here also contains a start and stop value. This can be used by a client system, if it does not wish to completely fill a found slot. A slot can be split by a client system into multiple bookings if it wishes to. The important thing is, that the start and stop are kept inside the requested Slots start- and stop time.

This case is useful, if the client system wishes to split the slots by itself.

Request content

{
  "resourceType": "Appointment",
  "identifier": [
    {
      "system": "http://yourproduct-example.com/fhir/apps/referralids",
      "value": "yourproduct_4019"
    }
  ],
  "slot": [
	 {
	 "reference": "Slot/4_4"
	 }
  ],
  "start":"2023-11-19T08:30:00+01:00",
  "stop":"2023-11-19T09:30:00+01:00",
  "status": "proposed",
  "participant": [
	{
		"actor": {
			"reference": "Location/KONS-1231",
			"display": "Tets Resource Name"
		},
		"status": "accepted"
	}
  ]
}

Response

HTTP/1.1 201 OK
[other headers]

Cancel booking The following example shows how to cancel a given appointment after it was created.

PUT [base]/Appointment/1231

Request content

{
  "resourceType": "Appointment",
  "id": "1231"
  "identifier": [
    {
      "system": "http://yourproduct-example.com/fhir/apps/referralids",
      "value": "yourproduct_4019"
    },
	{
	"system": "http://cistec.com",
	"value": "1231"
    }
  ],
  "status": "cancelled",
  "participant": [
	{
		"actor": {
			"reference": "Location/KONS-1231",
			"display": "Tets Resource Name"
		},
		"status": "accepted"
	}
  ]
}

Response

HTTP/1.1 201 OK
[other headers]

Additional operations

Additional operations on the appointment resource are:

• searchAppointmensByPlan
• searchAppointmensByEncounter