AppointmentCancellationSe

1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AppointmentCancellationSe

Official URL: https://fhir.cambio.se/StructureDefinition/AppointmentCancellationSe/v1				Version:
Active as of 2025-10-27				Computable Name: AppointmentCancellationSe

Introduction

AppointmentCancellationSe is a profile based on the FHIR resource Appointment.

Intended Use

AppointmentCancellationSe is used when a patient cancels an appointment. AppointmentCancellationSe is profiled for the Swedish market.

Versions

COS version	Profile version	Required COSMIC version	Date	Description
3.0.0	1.0.0	R8.3.05	May 2022	Initial version, support for PUT.

Statuses

FHIR status	Status in COSMIC
Cancelled	Cancelled

APIs & Supported Operations

HTTP Method	Description
PUT	Cancel a booked appointment.

Supported Queries

PUT [baseURL]/Appointment/[id] (Put)

Usages:

Examples for this Profile: Appointment/6563623
CapabilityStatements using this Profile: Cambio Open Services

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Appointment	C	0..*	AppointmentCoreSe	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) Constraints: app-2, app-3, app-4
id	Σ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:cancellationMessage		0..*	string	Message why the apppointment has been cancelled URL: https://fhir.cambio.se/StructureDefinition/appointment-message
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. Fixed Value: cancelled
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by type:$this Constraints: app-1
participant:All Slices				Content/Rules for all slices
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.
participant:patient	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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.
participant:location	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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.
participant:practitioner	C	0..*	BackboneElement	Participants involved in appointment Constraints: app-1
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.
participant:device	C	0..*	BackboneElement	Participants involved in appointment Constraints: app-1
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.
participant:healthcareService	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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.
participant:practitionerRole	C	0..*	BackboneElement	Participants involved in appointment Constraints: app-1
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 / Code	URI
Appointment.status	required	Fixed Value: cancelled `http://hl7.org/fhir/ValueSet/appointmentstatus\|4.0.1` From the FHIR Standard
Appointment.slot.type	extensible	Fixed Value: Slot `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
Appointment.participant.status	required	ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` From the FHIR Standard
Appointment.participant:patient.status	required	ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` From the FHIR Standard
Appointment.participant:location.status	required	ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` From the FHIR Standard
Appointment.participant:practitioner.status	required	ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` From the FHIR Standard
Appointment.participant:device.status	required	ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` From the FHIR Standard
Appointment.participant:healthcareService.status	required	ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` From the FHIR Standard
Appointment.participant:practitionerRole.status	required	ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, Appointment.participant:patient, Appointment.participant:location, Appointment.participant:practitioner, Appointment.participant:device, Appointment.participant:healthcareService, Appointment.participant:practitionerRole	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 AppointmentCoreSe

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Appointment	0..*	AppointmentCoreSe	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	1..1	id	Logical id of this artifact
Slices for extension			Content/Rules for all slices
extension:permittedPatientActions	0..0
extension:serviceProvider	0..0
extension:cancellationMessage	0..*	string	Message why the apppointment has been cancelled URL: https://fhir.cambio.se/StructureDefinition/appointment-message
status	1..1	code	proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error \| checked-in \| waitlist Fixed Value: cancelled
specialty	0..0
appointmentType	0..0
reasonCode	0..0
reasonReference	0..0
description	0..0
supportingInformation	0..0
start	0..0
end	0..0
minutesDuration	0..0
slot	0..0
created	0..0
comment	0..0
patientInstruction	0..0
basedOn	0..0
participant	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by type:$this
requestedPeriod	0..0
Documentation for this format

Description & Constraints Filter: Filters

Appointment

C

0..*

AppointmentCoreSe

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)
Constraints: app-2, app-3, app-4

id

Σ

1..1

id

Logical id of this artifact