Generated Narrative: OperationDefinition BookAppointment

URL: [base]/Appointment/$book

Output parameters Profile:Portal Find Appointment response

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment1..1Appointment (Appointment Portal)

The Appointment to be created, modified, or cancelled.

  • CREATE:
    • Appointment.id is absent or refers to a non-existing appointment
    • Appointment.status is 'pending'
  • MODIFY:
    • Appointment.id identifies an existing appointment
    • Appointment.status is 'booked' and details (time, participants, etc.) are updated
  • CANCEL:
    • Appointment.id identifies an existing appointment
    • Appointment.status is 'cancelled'
INappointment-reference0..1Reference (Appointment Portal)

A resource id for one of proposed Appointments returned by a prior $find operation (e.g., Resource/1234). References can be to an absolute URL, but servers only perform this operation on their own appointments.

INpatient-identifier1..*Identifier

The Patient is identified by their personal number. | SHOULD be an identifier system from a national FHIR Patient profile.

INcomment0..1string

The optional comment can be added for additional notes that could be useful for booking, canceling, or modifying an appointment

OUTreturn1..1Bundle

On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:

  • status 'booked' for created or modified appointments
  • status 'cancelled' for cancelled appointments

On error, an OperationOutcome is returned instead of this parameter.

 <status value="active"/> <kind value="operation"/> <date value="2026-04-20T08:10:56+00:00"/> <publisher value="Service Well AB"/> <contact> <name value="Service Well AB"/> <telecom> <system value="url"/> <value value="https://servicewell.se"/> </telecom> <telecom> <system value="email"/> <value value="info@servicewell.se"/> </telecom> </contact> <contact> <name value="Service well"/> <telecom> <system value="email"/> <value value="info@servicewell.se"/> <use value="work"/> </telecom> </contact> <description value="Creates, modifies, or cancels an Appointment based on the supplied Appointment resource. This operation corresponds to the IHE ITI Scheduling $book operation and: - CREATES a new Appointment when a new, schedulable Appointment is supplied - MODIFIES an existing Appointment when an updated Appointment is supplied - CANCELS an existing Appointment when a cancellation Appointment is supplied On success, the operation returns the finalized Appointment in an IHE Scheduled Availability Bundle."/> <affectsState value="true"/> <code value="book"/> <base value="https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book"/> <resource value="Appointment"/> <system value="false"/> <type value="true"/> <instance value="false"/> <outputProfile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-find-appointment-bundle"/> <parameter> <name value="appointment"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="The Appointment to be created, modified, or cancelled. - CREATE: - Appointment.id is absent or refers to a non-existing appointment - Appointment.status is 'pending' - MODIFY: - Appointment.id identifies an existing appointment - Appointment.status is 'booked' and details (time, participants, etc.) are updated - CANCEL: - Appointment.id identifies an existing appointment - Appointment.status is 'cancelled'"/> <type value="Appointment"/> <targetProfile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-appointment"/> </parameter> <parameter> <name value="appointment-reference"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="A resource id for one of proposed Appointments returned by a prior $find operation (e.g., Resource/1234). References can be to an absolute URL, but servers only perform this operation on their own appointments."/> <type value="Reference"/> <targetProfile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-appointment"/> </parameter> <parameter> <name value="patient-identifier"/> <use value="in"/> <min value="1"/> <max value="*"/> <documentation value="The Patient is identified by their personal number. | SHOULD be an identifier system from a national FHIR Patient profile. "/> <type value="Identifier"/> </parameter> <parameter> <name value="comment"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The optional comment can be added for additional notes that could be useful for booking, canceling, or modifying an appointment"/> <type value="string"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment: - status 'booked' for created or modified appointments - status 'cancelled' for cancelled appointments On error, an OperationOutcome is returned instead of this parameter."/> <type value="Bundle"/> </parameter> </OperationDefinition>