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

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: AppointmentSe

Introduction

AppointmentSe is a profile based on the FHIR resource Appointment.

Intended Use

AppointmentSe is used for appointments. The profile can be used either to request all appointments for a patient, or request information for a single appointment. AppointmentSe is profiled for the Swedish market.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

A limitation to these APIs is that they are only applicable for appointments that are seen as web appointments in COSMIC. Web appointments are appointments that patients can see in an app or on a website outside of COSMIC. The appointment becomes a web appointment through configuration done in COSMIC, see requirements below.

A web appointment must adhere to the following rules in COSMIC:

• The unit which the appointment is connected to, should have the unit type 'Bokning via webbtidbok'.
• The offer/healthcare service which the appointment is connected to, should have the property 'show offer in web schedule' with selected value 'yes'.

Specific Rules and Limitations

Versions

Extensions

Statuses

APIs & Supported Operations

Search Parameters

Supported Queries

GET [baseURL]/Appointment/_search?_id=<appointmentId>&patient.identifier=rn:oid:1.2.752.129.2.1.3.1|<patient personal number>
GET [baseURL]/Appointment/_search?patient.identifier=urn:oid:1.2.752.129.2.1.3.1|<patient personal number> GET [baseURL]/Appointment/_search?date=[gt_date]&date=[lt_date] (Search)

Supported _include params

The following _include parameters are supported:

1. Appointment:participant:HealthCareService.providedBy

Usages:

• Examples for this Profile: Appointment/284242
• 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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:permittedPatientActions		0..*	Coding	Describes what actions the patient has permission for to do with the appointment. URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
extension:serviceProvider		0..1	Reference()	Organizational unit that is responsible for the appointment. URL: https://cambio.se/fhir/StructureDefinition/common-serviceProvider/v1
extension:url		0..1	url	Meeting URL for the appointment to which participants can connect. URL: http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
extension:urlLabel		0..1	string	Label of the meeting URL that can be displayed to the user. URL: https://fhir.cambio.se/StructureDefinition/urlLabel/v1
extension:urlNotAvailableMessage		0..1	string	Message explaining why the meeting URL is not available. URL: https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
extension:class		0..1	Coding	Code that defines what type of encounter the appointment is for. For example if the appointment is a video meeting, the class will have the code VIDEOCONF. URL: https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
extension:navigationInstruction		0..1	string	Instructions for navigating to the care unit where the appointment will be attended. URL: https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1
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.
Slices for supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:$this
supportingInformation:encounter		0..1	Reference(Encounter)	Additional information to support the appointment
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
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	Performing unit for the 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
Slices for type	Σ	0..*	CodeableConcept	Role of participant in the appointment Slice: Unordered, Open by value:coding.code Binding: ParticipantType (extensible): Role of participant in encounter.
type:primaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
type:secondaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
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
actor	Σ	0..1	Reference(HealthcareServiceLiteSe)	Person, Location/HealthcareService or Device
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.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Appointment.status	required	AppointmentStatus 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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:primaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:secondaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type 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:healthcareService	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	Flags	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)
Slices for extension				Content/Rules for all slices
extension:permittedPatientActions		0..*	CommonPermittedPatientActions	Describes what actions the patient has permission for to do with the appointment.
extension:serviceProvider		0..1	CommonServiceProvider	Organizational unit that is responsible for the appointment.
extension:url		0..*	url	Meeting URL for the appointment to which participants can connect. URL: http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
extension:urlLabel		0..1	string	Label of the meeting URL that can be displayed to the user. URL: https://fhir.cambio.se/StructureDefinition/urlLabel/v1
extension:urlNotAvailableMessage		0..1	string	Message explaining why the meeting URL is not available. URL: https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
extension:class		0..1	Coding	Code that defines what type of encounter the appointment is for. For example if the appointment is a video meeting, the class will have the code VIDEOCONF. URL: https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
extension:navigationInstruction		0..1	string	Instructions for navigating to the care unit where the appointment will be attended. URL: https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1
identifier		0..0
cancelationReason		0..0
specialty		0..0
appointmentType		0..0
reasonCode		0..0
reasonReference		0..0
Slices for supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:$this
supportingInformation:encounter		0..1	Reference(Encounter)	Additional information to support the appointment
minutesDuration		0..0
slot		0..0
created		0..0
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..0
Slices for participant				Content/Rules for all slices
participant:location		0..1	BackboneElement	Performing unit for the Appointment
participant:practitioner		0..*	BackboneElement	Participants involved in appointment
Slices for type		0..*	CodeableConcept	Role of participant in the appointment Slice: Unordered, Open by value:coding.code
type:primaryPerformer		0..*	CodeableConcept	Role of participant in the appointment
coding
code		1..1	code	The principal or primary performer of the appointment. Fixed Value: PPRF
type:secondaryPerformer		0..*	CodeableConcept	Role of participant in the appointment
coding
code		1..1	code	A secondary performer in the appointment. Fixed Value: SPRF
participant:device		0..0
participant:healthcareService		0..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(HealthcareServiceLiteSe)	Person, Location/HealthcareService or Device
participant:practitionerRole		0..0
requestedPeriod		0..0
Documentation for this format

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	Σ	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:permittedPatientActions		0..*	Coding	Describes what actions the patient has permission for to do with the appointment. URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
extension:serviceProvider		0..1	Reference()	Organizational unit that is responsible for the appointment. URL: https://cambio.se/fhir/StructureDefinition/common-serviceProvider/v1
extension:url		0..1	url	Meeting URL for the appointment to which participants can connect. URL: http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
extension:urlLabel		0..1	string	Label of the meeting URL that can be displayed to the user. URL: https://fhir.cambio.se/StructureDefinition/urlLabel/v1
extension:urlNotAvailableMessage		0..1	string	Message explaining why the meeting URL is not available. URL: https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
extension:class		0..1	Coding	Code that defines what type of encounter the appointment is for. For example if the appointment is a video meeting, the class will have the code VIDEOCONF. URL: https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
extension:navigationInstruction		0..1	string	Instructions for navigating to the care unit where the appointment will be attended. URL: https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1
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.
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:$this
supportingInformation:encounter		0..1	Reference(Encounter)	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
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
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
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
participant:patient	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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)	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
participant:location	C	0..1	BackboneElement	Performing unit for the Appointment Constraints: app-1
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(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
participant:practitioner	C	0..*	BackboneElement	Participants involved in appointment Constraints: app-1
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
Slices for type	Σ	0..*	CodeableConcept	Role of participant in the appointment Slice: Unordered, Open by value:coding.code Binding: ParticipantType (extensible): Role of participant in encounter.
type:primaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	The principal or primary performer of the appointment. Fixed Value: PPRF
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
type:secondaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	A secondary performer in the appointment. Fixed Value: SPRF
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
actor	Σ	0..1	Reference(Practitioner)	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
participant:healthcareService	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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(HealthcareServiceLiteSe)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Appointment.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Appointment.status	required	AppointmentStatus 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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:patient.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:location.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:primaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:secondaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:device.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:healthcareService.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitionerRole.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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:healthcareService	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

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements
Prohibited: 13 elements

Structures

This structure refers to these other structures:

• HealthcareServiceLiteSe (https://fhir.cambio.se/StructureDefinition/HealthcareServiceLiteSe/v1)

Extensions

This structure refers to these extensions:

• http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
• https://fhir.cambio.se/StructureDefinition/urlLabel/v1
• https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
• https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
• https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Appointment.supportingInformation
• The element 1 is sliced based on the value of Appointment.participant.type

Key Elements View

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:permittedPatientActions		0..*	Coding	Describes what actions the patient has permission for to do with the appointment. URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
extension:serviceProvider		0..1	Reference()	Organizational unit that is responsible for the appointment. URL: https://cambio.se/fhir/StructureDefinition/common-serviceProvider/v1
extension:url		0..1	url	Meeting URL for the appointment to which participants can connect. URL: http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
extension:urlLabel		0..1	string	Label of the meeting URL that can be displayed to the user. URL: https://fhir.cambio.se/StructureDefinition/urlLabel/v1
extension:urlNotAvailableMessage		0..1	string	Message explaining why the meeting URL is not available. URL: https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
extension:class		0..1	Coding	Code that defines what type of encounter the appointment is for. For example if the appointment is a video meeting, the class will have the code VIDEOCONF. URL: https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
extension:navigationInstruction		0..1	string	Instructions for navigating to the care unit where the appointment will be attended. URL: https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1
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.
Slices for supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:$this
supportingInformation:encounter		0..1	Reference(Encounter)	Additional information to support the appointment
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
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	Performing unit for the 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
Slices for type	Σ	0..*	CodeableConcept	Role of participant in the appointment Slice: Unordered, Open by value:coding.code Binding: ParticipantType (extensible): Role of participant in encounter.
type:primaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
type:secondaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
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
actor	Σ	0..1	Reference(HealthcareServiceLiteSe)	Person, Location/HealthcareService or Device
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.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Appointment.status	required	AppointmentStatus 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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:primaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:secondaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type 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:healthcareService	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 AppointmentCoreSe

Name	Flags	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)
Slices for extension				Content/Rules for all slices
extension:permittedPatientActions		0..*	CommonPermittedPatientActions	Describes what actions the patient has permission for to do with the appointment.
extension:serviceProvider		0..1	CommonServiceProvider	Organizational unit that is responsible for the appointment.
extension:url		0..*	url	Meeting URL for the appointment to which participants can connect. URL: http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
extension:urlLabel		0..1	string	Label of the meeting URL that can be displayed to the user. URL: https://fhir.cambio.se/StructureDefinition/urlLabel/v1
extension:urlNotAvailableMessage		0..1	string	Message explaining why the meeting URL is not available. URL: https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
extension:class		0..1	Coding	Code that defines what type of encounter the appointment is for. For example if the appointment is a video meeting, the class will have the code VIDEOCONF. URL: https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
extension:navigationInstruction		0..1	string	Instructions for navigating to the care unit where the appointment will be attended. URL: https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1
identifier		0..0
cancelationReason		0..0
specialty		0..0
appointmentType		0..0
reasonCode		0..0
reasonReference		0..0
Slices for supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:$this
supportingInformation:encounter		0..1	Reference(Encounter)	Additional information to support the appointment
minutesDuration		0..0
slot		0..0
created		0..0
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..0
Slices for participant				Content/Rules for all slices
participant:location		0..1	BackboneElement	Performing unit for the Appointment
participant:practitioner		0..*	BackboneElement	Participants involved in appointment
Slices for type		0..*	CodeableConcept	Role of participant in the appointment Slice: Unordered, Open by value:coding.code
type:primaryPerformer		0..*	CodeableConcept	Role of participant in the appointment
coding
code		1..1	code	The principal or primary performer of the appointment. Fixed Value: PPRF
type:secondaryPerformer		0..*	CodeableConcept	Role of participant in the appointment
coding
code		1..1	code	A secondary performer in the appointment. Fixed Value: SPRF
participant:device		0..0
participant:healthcareService		0..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(HealthcareServiceLiteSe)	Person, Location/HealthcareService or Device
participant:practitionerRole		0..0
requestedPeriod		0..0
Documentation for this format

Snapshot View

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	Σ	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:permittedPatientActions		0..*	Coding	Describes what actions the patient has permission for to do with the appointment. URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
extension:serviceProvider		0..1	Reference()	Organizational unit that is responsible for the appointment. URL: https://cambio.se/fhir/StructureDefinition/common-serviceProvider/v1
extension:url		0..1	url	Meeting URL for the appointment to which participants can connect. URL: http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
extension:urlLabel		0..1	string	Label of the meeting URL that can be displayed to the user. URL: https://fhir.cambio.se/StructureDefinition/urlLabel/v1
extension:urlNotAvailableMessage		0..1	string	Message explaining why the meeting URL is not available. URL: https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
extension:class		0..1	Coding	Code that defines what type of encounter the appointment is for. For example if the appointment is a video meeting, the class will have the code VIDEOCONF. URL: https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
extension:navigationInstruction		0..1	string	Instructions for navigating to the care unit where the appointment will be attended. URL: https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1
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.
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:$this
supportingInformation:encounter		0..1	Reference(Encounter)	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
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
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
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
participant:patient	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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)	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
participant:location	C	0..1	BackboneElement	Performing unit for the Appointment Constraints: app-1
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(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
participant:practitioner	C	0..*	BackboneElement	Participants involved in appointment Constraints: app-1
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
Slices for type	Σ	0..*	CodeableConcept	Role of participant in the appointment Slice: Unordered, Open by value:coding.code Binding: ParticipantType (extensible): Role of participant in encounter.
type:primaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	The principal or primary performer of the appointment. Fixed Value: PPRF
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
type:secondaryPerformer	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	A secondary performer in the appointment. Fixed Value: SPRF
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
actor	Σ	0..1	Reference(Practitioner)	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
participant:healthcareService	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
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(HealthcareServiceLiteSe)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Appointment.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Appointment.status	required	AppointmentStatus 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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:patient.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:location.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:primaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.type:secondaryPerformer	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitioner.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:device.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:healthcareService.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Appointment.participant:practitionerRole.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|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:healthcareService	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

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements
Prohibited: 13 elements

Structures

This structure refers to these other structures:

• HealthcareServiceLiteSe (https://fhir.cambio.se/StructureDefinition/HealthcareServiceLiteSe/v1)

Extensions

This structure refers to these extensions:

• http://cambio.se/fhir/StructureDefinition/appointment-Url/v1
• https://fhir.cambio.se/StructureDefinition/urlLabel/v1
• https://fhir.cambio.se/StructureDefinition/appointment-urlNotAvailableMessage/v1
• https://fhir.cambio.se/StructureDefinition/appointment-encounterClass/v1
• https://fhir.cambio.se/StructureDefinition/appointment-navigationInstruction/v1

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Appointment.supportingInformation
• The element 1 is sliced based on the value of Appointment.participant.type

Other representations of profile: CSV, Excel, Schematron