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.

Specific Rules and Limitations

N/A

Profile Overview

AppointmentCancellationSe

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
permittedPatientActionsI0..0Extension(Coding)
serviceProviderI0..0Extension(Reference())
patientPremittedActionsI0..0Extension
cancellationMessageI0..*Extension(string)
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
statusΣ ?!1..1codeBindingFixed Value
cancelationReasonΣ0..1CodeableConcept
serviceCategoryΣ0..0CodeableConcept
serviceTypeΣ0..0CodeableConcept
specialtyΣ0..0CodeableConceptBinding
appointmentTypeΣ0..0CodeableConceptBinding
reasonCodeΣ0..0CodeableConceptBinding
reasonReferenceI0..0Reference(Condition | Procedure | Observation | ImmunizationRecommendation)
priority0..0unsignedInt
description0..0string
supportingInformationI0..0Reference(Resource)
startΣ0..0instant
endΣ0..0instant
minutesDuration0..0positiveInt
created0..0dateTime
comment0..0string
patientInstruction0..0string
basedOnI0..0Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
actorΣ I0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBindingFixed Value
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..0CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..0Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBindingFixed Value
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
requestedPeriodI0..0Period
id1..

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.

Extensions

Extension Data type Description
ServiceProvider Reference Service provider
CancellationMessage String Message why the appointment was cancelled

Statuses

FHIR status Status in COSMIC
Cancelled Cancelled

Supported Operations

HTTP Methods

Method Description
PUT Cancel a booked appointment.

Query Operations

Supported Queries

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

Supported SearchInclude Operations

N/A

Supported RevInclude Operations

N/A

Error Codes

No specific error codes for Appointment. For common codes, refer to Error handling section.