This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Invitation Appointment

Profile to hold information about appointments related to an invitation

Usage:

• Use this Resource Profile: Communication Parameters
• Refer to this Resource Profile: Invitation CommunicationRequest
• Examples for this Resource Profile: Appointment/15f86208-17c7-441e-adae-8797c5183c82, Appointment/6bc62e41-bf1a-40a4-baf1-8d3f6a9f9d32, Appointment/InvitationAppointment, Appointment/MaximalInvitationAppointment... Show 8 more, Appointment/MaximalInvitationAppointmentCancel, Appointment/MaximalOldAppointment, Appointment/MinimalInvitationAppointment, Appointment/OldAppointment, Appointment/ReferredInvitationAppointment, Appointment/RescheduleInvitationAppointment, Appointment/TemplateInvitationAppointment and Appointment/bf88424f-4423-4f39-975b-2fffbd6b3090

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
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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management must-have-healthcareservice: There must be a participant.actor reference to HealthCareService
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
CareServiceCode		1..1	(Complex)	Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service code ele-1: All FHIR elements must have a @value or children
CareServiceArea		1..1	(Complex)	Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service area ele-1: All FHIR elements must have a @value or children
IndividualChoice		0..*	(Complex)	Individual choices URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:id		0..1	Extension	Id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"id"
extension:body		0..1	Extension	Body ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"body"
extension:type		0..1	Extension	Type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
Link		0..*	(Complex)	Link URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"name"
extension:url		0..1	Extension	Link Url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"url"
extension:readable_text		0..1	Extension	Readable text ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"readable_text"
extension:type		0..1	Extension	Link type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice"
Prep		0..*	(Complex)	Preps in the invitation template URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:type		0..1	Extension	Type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
extension:header		0..1	Extension	Header ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"header"
extension:printheader		0..1	Extension	Printheader ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"printheader"
extension:sortIndex		0..*	Extension	SortIndex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"sortIndex"
PrepItem		0..*	(Complex)	Prep Item URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:id		0..1	Extension	PrepItem Sectiontext Id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"id"
extension:body		0..1	Extension	PrepItem Body ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"body"
extension:sortIndex		0..1	Extension	PrepItem Sort Index ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"sortIndex"
Link		0..*	(Complex)	PrepItem Links URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"name"
extension:url		0..1	Extension	Link Url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"url"
extension:readable_text		0..1	Extension	Readable text ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"readable_text"
extension:type		0..1	Extension	Link type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	PrepItem Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep"
ReferralReference		0..1	(Complex)	Extension to hold information about the HealthcareService the referral applies to URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:healthcareService		1..1	Extension	Reference to the HealthcareService the referral applies. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"healthcareService"
Slices for value[x]		1..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueReference	S	1..1	Reference(HealthCareService)	Reference to the HealthcareService the referral applies. ele-1: All FHIR elements must have a @value or children
extension:gapDays		0..1	Extension	Gap Days. Days between the referral and the appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"gapDays"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueInteger		0..1	integer	Gap Days. Number of days between the referral and the appointment. Integer ele-1: All FHIR elements must have a @value or children
extension:receiveCorrespondence		0..1	Extension	Should referred HealthcareService receive correspondence. Otherwise only sending to inhabitant ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"receiveCorrespondence"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueBoolean		0..1	boolean	Should receive correspondance. In those cases a template is not defined in kalla for the referral correspondence, only a communication to the inhabitant will be sent. ele-1: All FHIR elements must have a @value or children
url	S	1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference"
ReschedulingReason		0..1	string	Rescheduling Reason URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason Binding: Kalla Rescheduling Reasons (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
SelfCheckin		0..1	boolean	Extension to flag if Self service checkin is enabled for the appointment URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
VisitType		0..1	code	Visit Type. Value from ValueSet VisitTypes NEW|FOLLOWUP URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType Binding: Kalla Visit Types (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	Identifier	AppointmentId ele-1: All FHIR elements must have a @value or children
status	?!ΣC	1..1	code	Status of the apppointment. Used to distinguish bookings from rescedulings. Use 'booked' or 'proposed' Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children
cancellationReason	ΣC	0..1	CodeableConcept	Reason for cancelling Binding: Kalla Cancellation Reasons (required) ele-1: All FHIR elements must have a @value or children
appointmentType	Σ	1..1	CodeableConcept	Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) ele-1: All FHIR elements must have a @value or children
replaces		0..1	Reference(Appointment)	Reference to Appointment that was rescheduled ele-1: All FHIR elements must have a @value or children
start	ΣC	0..1	instant	Appointment start time ele-1: All FHIR elements must have a @value or children
end	ΣC	0..1	instant	Apponintment end time ele-1: All FHIR elements must have a @value or children
minutesDuration		0..1	positiveInt	Duration in minutes ele-1: All FHIR elements must have a @value or children
Slices for participant	C	1..2	BackboneElement	Participant slices Slice: Unordered, Open by value:$this.type app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
participant:healthcareservice	C	1..1	BackboneElement	HealthcareServices involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
actor	ΣC	1..1	Reference(HealthcareService)	The individual, device, location, or service participating in the appointment ele-1: All FHIR elements must have a @value or children
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
participant:practitioner	C	0..1	BackboneElement	Practitioner involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ATND
actor	ΣC	0..1	Reference(Practitioner)	Reference to Practitioner ele-1: All FHIR elements must have a @value or children
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Constraints

Path	Conformance	ValueSet / Code	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 from the FHIR Standard
Appointment.cancellationReason	required	KallaCancellationReason http://bki.skane.se/invanartjanster/fhir/ValueSet/cancellation-reason from this IG
Appointment.appointmentType	required	KallaAppointmentType http://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-type from this IG
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:healthcareservice.type	extensible	Pattern: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:healthcareservice.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:practitioner.type	extensible	Pattern: ATND http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:practitioner.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard

Id	Grade	Path(s)	Details	Requirements
must-have-healthcareservice	error	Appointment	There must be a participant.actor reference to HealthCareService : participant[0].actor.reference.matches('HealthcareService.*')

This structure is derived from Appointment

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) must-have-healthcareservice: There must be a participant.actor reference to HealthCareService
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
CareServiceCode		1..1	(Complex)	Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service code
coding
system		0..1	uri	Code System
code		1..1	code	Code
display		0..1	string	Display value
CareServiceArea		1..1	(Complex)	Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service area
coding
system		0..1	uri	Code System
code		1..1	code	Code
display		0..1	string	Display value
IndividualChoice		0..*	(Complex)	Individual choices URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice
Slices for extension				Content/Rules for all slices
extension:Link		0..*	Link	Link
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name
extension:url		0..1	Extension	Link Url
extension:Placeholder		0..*	Placeholder	Placeholder
Prep		0..*	(Complex)	Preps in the invitation template URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep
Slices for extension				Content/Rules for all slices
extension:PrepItem		0..*	PrepItem	Prep Item
Slices for extension				Content/Rules for all slices
extension:id		0..1	Extension	PrepItem Sectiontext Id
extension:body		0..1	Extension	PrepItem Body
extension:sortIndex		0..1	Extension	PrepItem Sort Index
extension:Link		0..*	Link	PrepItem Links
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name
extension:url		0..1	Extension	Link Url
extension:Placeholder		0..*	Placeholder	PrepItem Placeholder
ReferralReference		0..1	(Complex)	Extension to hold information about the HealthcareService the referral applies to URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference
Slices for extension				Content/Rules for all slices
extension:healthcareService		1..1	Extension	Reference to the HealthcareService the referral applies.
extension:gapDays		0..1	Extension	Gap Days. Days between the referral and the appointment
extension:receiveCorrespondence		0..1	Extension	Should referred HealthcareService receive correspondence. Otherwise only sending to inhabitant
ReschedulingReason		0..1	string	Rescheduling Reason URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason Binding: Kalla Rescheduling Reasons (required)
SelfCheckin		0..1	boolean	Extension to flag if Self service checkin is enabled for the appointment URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin
VisitType		0..1	code	Visit Type. Value from ValueSet VisitTypes NEW|FOLLOWUP URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType Binding: Kalla Visit Types (required)
identifier		1..1	Identifier	AppointmentId
status		1..1	code	Status of the apppointment. Used to distinguish bookings from rescedulings. Use 'booked' or 'proposed'
cancellationReason		0..1	CodeableConcept	Reason for cancelling Binding: Kalla Cancellation Reasons (required)
appointmentType		1..1	CodeableConcept	Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required)
replaces		0..1	Reference(Appointment)	Reference to Appointment that was rescheduled
start		0..1	instant	Appointment start time
end		0..1	instant	Apponintment end time
minutesDuration		0..1	positiveInt	Duration in minutes
Slices for participant		1..2	BackboneElement	Participant slices Slice: Unordered, Open by value:$this.type
participant:healthcareservice		1..1	BackboneElement	HealthcareServices involved in appointment
type		1..1	CodeableConcept	Role of participant in the appointment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
actor		1..1	Reference(HealthcareService)	The individual, device, location, or service participating in the appointment
status		1..1	code	Status not used by AddCommunication API
participant:practitioner		0..1	BackboneElement	Practitioner involved in appointment
type		1..1	CodeableConcept	Role of participant in the appointment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ATND
actor		0..1	Reference(Practitioner)	Reference to Practitioner
status		1..1	code	Status not used by AddCommunication API
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.cancellationReason	required	KallaCancellationReason http://bki.skane.se/invanartjanster/fhir/ValueSet/cancellation-reason from this IG
Appointment.appointmentType	required	KallaAppointmentType http://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
must-have-healthcareservice	error	Appointment	There must be a participant.actor reference to HealthCareService : participant[0].actor.reference.matches('HealthcareService.*')

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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow must-have-healthcareservice: There must be a participant.actor reference to HealthCareService
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
CareServiceCode		1..1	(Complex)	Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service code
id		0..1	id	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	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Code System
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	1..1	code	Code
display	ΣC	0..1	string	Display value
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
CareServiceArea		1..1	(Complex)	Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service area
id		0..1	id	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	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Code System
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	1..1	code	Code Binding: https://tirs.skane.se/sdv-millennium/id/codevalueset/34 (required)
display	ΣC	0..1	string	Display value
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
IndividualChoice		0..*	(Complex)	Individual choices URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:id		0..1	Extension	Id
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"id"
value[x]		0..1	integer	Value of extension
extension:body		0..1	Extension	Body
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"body"
value[x]		0..1	string	Value of extension
extension:type		0..1	Extension	Type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
Link		0..*	(Complex)	Link URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:name		0..1	Extension	Link name
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"name"
value[x]		0..1	string	Value of extension
extension:url		0..1	Extension	Link Url
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"url"
value[x]		0..1	string	Value of extension
extension:readable_text		0..1	Extension	Readable text
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"readable_text"
value[x]		0..1	string	Value of extension
extension:type		0..1	Extension	Link type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice"
Prep		0..*	(Complex)	Preps in the invitation template URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:type		0..1	Extension	Type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
extension:header		0..1	Extension	Header
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"header"
value[x]		0..1	string	Value of extension
extension:printheader		0..1	Extension	Printheader
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"printheader"
value[x]		0..1	boolean	Value of extension
extension:sortIndex		0..*	Extension	SortIndex
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"sortIndex"
value[x]		0..1	integer	Value of extension
PrepItem		0..*	(Complex)	Prep Item URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:id		0..1	Extension	PrepItem Sectiontext Id
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"id"
value[x]		0..1	integer	Value of extension
extension:body		0..1	Extension	PrepItem Body
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"body"
value[x]		0..1	string	Value of extension
extension:sortIndex		0..1	Extension	PrepItem Sort Index
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"sortIndex"
value[x]		0..1	integer	Value of extension
Link		0..*	(Complex)	PrepItem Links URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:name		0..1	Extension	Link name
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"name"
value[x]		0..1	string	Value of extension
extension:url		0..1	Extension	Link Url
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"url"
value[x]		0..1	string	Value of extension
extension:readable_text		0..1	Extension	Readable text
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"readable_text"
value[x]		0..1	string	Value of extension
extension:type		0..1	Extension	Link type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	PrepItem Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep"
ReferralReference		0..1	(Complex)	Extension to hold information about the HealthcareService the referral applies to URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference
id		0..1	id	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:healthcareService		1..1	Extension	Reference to the HealthcareService the referral applies.
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"healthcareService"
Slices for value[x]		1..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference	S	1..1	Reference(HealthCareService)	Reference to the HealthcareService the referral applies.
extension:gapDays		0..1	Extension	Gap Days. Days between the referral and the appointment
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"gapDays"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueInteger		0..1	integer	Gap Days. Number of days between the referral and the appointment. Integer
extension:receiveCorrespondence		0..1	Extension	Should referred HealthcareService receive correspondence. Otherwise only sending to inhabitant
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"receiveCorrespondence"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueBoolean		0..1	boolean	Should receive correspondance. In those cases a template is not defined in kalla for the referral correspondence, only a communication to the inhabitant will be sent.
url	S	1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference"
ReschedulingReason		0..1	string	Rescheduling Reason URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason Binding: Kalla Rescheduling Reasons (required)
SelfCheckin		0..1	boolean	Extension to flag if Self service checkin is enabled for the appointment URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin
VisitType		0..1	code	Visit Type. Value from ValueSet VisitTypes NEW|FOLLOWUP URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType Binding: Kalla Visit Types (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	AppointmentId
status	?!ΣC	1..1	code	Status of the apppointment. Used to distinguish bookings from rescedulings. Use 'booked' or 'proposed' Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancellationReason	ΣC	0..1	CodeableConcept	Reason for cancelling Binding: Kalla Cancellation Reasons (required)
class	Σ	0..*	CodeableConcept	​Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter.
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableReference(HealthcareService)	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	Σ	1..1	CodeableConcept	Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required)
reason	Σ	0..*	CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
priority		0..1	CodeableConcept	Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment.
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
replaces		0..1	Reference(Appointment)	Reference to Appointment that was rescheduled
virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
previousAppointment		0..1	Reference(Appointment)	The previous appointment in a series
originatingAppointment	C	0..1	Reference(Appointment)	The originating appointment in a recurring set of appointments
start	ΣC	0..1	instant	Appointment start time
end	ΣC	0..1	instant	Apponintment end time
minutesDuration		0..1	positiveInt	Duration in minutes
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
slot		0..*	Reference(Slot)	The slots that this appointment is filling
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Appointment
created		0..1	dateTime	The date that this appointment was initially created
cancellationDate	C	0..1	dateTime	When the appointment was cancelled
note		0..*	Annotation	Additional comments
patientInstruction		0..*	CodeableReference(DocumentReference | Binary | Communication)	Detailed information and instructions for the patient
basedOn		0..*	Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest)	The request this appointment is allocated to assess
subject	Σ	0..1	Reference(Patient | Group)	The patient or group associated with the appointment
Slices for participant	C	1..2	BackboneElement	Participant slices Slice: Unordered, Open by value:$this.type app-1: Either the type or actor on the participant SHALL be specified
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	ΣC	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Participation period of the actor
actor	ΣC	0..1	Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location)	The individual, device, location, or service participating in the appointment
required	Σ	0..1	boolean	The participant is required to attend (optional when false)
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:healthcareservice	C	1..1	BackboneElement	HealthcareServices involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
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
period		0..1	Period	Participation period of the actor
actor	ΣC	1..1	Reference(HealthcareService)	The individual, device, location, or service participating in the appointment
required	Σ	0..1	boolean	The participant is required to attend (optional when false)
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:practitioner	C	0..1	BackboneElement	Practitioner involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ATND
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
period		0..1	Period	Participation period of the actor
actor	ΣC	0..1	Reference(Practitioner)	Reference to Practitioner
required	Σ	0..1	boolean	The participant is required to attend (optional when false)
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment.
recurrenceId		0..1	positiveInt	The sequence number in the recurrence
occurrenceChanged		0..1	boolean	Indicates that this appointment varies from a recurrence pattern
recurrenceTemplate	C	0..*	BackboneElement	Details of the recurrence pattern/template used to generate occurrences
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
timezone		0..1	CodeableConcept	The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175)
recurrenceType		1..1	CodeableConcept	The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175)
lastOccurrenceDate		0..1	date	The date when the recurrence should end
occurrenceCount		0..1	positiveInt	The number of planned occurrences
occurrenceDate		0..*	date	Specific dates for a recurring set of appointments (no template)
weeklyTemplate		0..1	BackboneElement	Information about weekly recurring appointments
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
monday		0..1	boolean	Recurs on Mondays
tuesday		0..1	boolean	Recurs on Tuesday
wednesday		0..1	boolean	Recurs on Wednesday
thursday		0..1	boolean	Recurs on Thursday
friday		0..1	boolean	Recurs on Friday
saturday		0..1	boolean	Recurs on Saturday
sunday		0..1	boolean	Recurs on Sunday
weekInterval		0..1	positiveInt	Recurs every nth week
monthlyTemplate		0..1	BackboneElement	Information about monthly recurring appointments
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
dayOfMonth		0..1	positiveInt	Recurs on a specific day of the month
nthWeekOfMonth		0..1	Coding	Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month.
dayOfWeek		0..1	Coding	Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week.
monthInterval		1..1	positiveInt	Recurs every nth month
yearlyTemplate		0..1	BackboneElement	Information about yearly recurring appointments
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
yearInterval		1..1	positiveInt	Recurs every nth year
excludingDate		0..*	date	Any dates that should be excluded from the series
excludingRecurrenceId		0..*	positiveInt	Any recurrence IDs that should be excluded from the recurrence
Documentation for this format

Terminology Bindings

Constraints

Path	Conformance	ValueSet / Code	URI
Appointment.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Appointment.extension:CareServiceArea.value[x]:valueCodeableConcept.coding.code	required	https://tirs.skane.se/sdv-millennium/id/codevalueset/34 https://tirs.skane.se/sdv-millennium/id/codevalueset/34
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 from the FHIR Standard
Appointment.cancellationReason	required	KallaCancellationReason http://bki.skane.se/invanartjanster/fhir/ValueSet/cancellation-reason from this IG
Appointment.class	preferred	​http://terminology.hl7.org/ValueSet/EncounterClass http://terminology.hl7.org/ValueSet/EncounterClass
Appointment.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Appointment.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	required	KallaAppointmentType http://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-type from this IG
Appointment.reason	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Appointment.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Appointment.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:healthcareservice.type	extensible	Pattern: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:healthcareservice.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:practitioner.type	extensible	Pattern: ATND http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:practitioner.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.recurrenceTemplate.timezone	required	IANATimezones http://hl7.org/fhir/ValueSet/timezones|5.0.0 from the FHIR Standard
Appointment.recurrenceTemplate.recurrenceType	preferred	AppointmentRecurrenceType http://hl7.org/fhir/ValueSet/appointment-recurrrence-type from the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth	required	WeekOfMonth http://hl7.org/fhir/ValueSet/week-of-month|5.0.0 from the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|5.0.0 from the FHIR Standard

Id	Grade	Path(s)	Details	Requirements
must-have-healthcareservice	error	Appointment	There must be a participant.actor reference to HealthCareService : participant[0].actor.reference.matches('HealthcareService.*')

This structure is derived from Appointment

Summary

Mandatory: 7 elements(1 nested mandatory element)

Extensions

This structure refers to these extensions:

• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType

Slices

This structure defines the following Slices:

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

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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management must-have-healthcareservice: There must be a participant.actor reference to HealthCareService
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
CareServiceCode		1..1	(Complex)	Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service code ele-1: All FHIR elements must have a @value or children
CareServiceArea		1..1	(Complex)	Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service area ele-1: All FHIR elements must have a @value or children
IndividualChoice		0..*	(Complex)	Individual choices URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:id		0..1	Extension	Id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"id"
extension:body		0..1	Extension	Body ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"body"
extension:type		0..1	Extension	Type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
Link		0..*	(Complex)	Link URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"name"
extension:url		0..1	Extension	Link Url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"url"
extension:readable_text		0..1	Extension	Readable text ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"readable_text"
extension:type		0..1	Extension	Link type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice"
Prep		0..*	(Complex)	Preps in the invitation template URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:type		0..1	Extension	Type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
extension:header		0..1	Extension	Header ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"header"
extension:printheader		0..1	Extension	Printheader ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"printheader"
extension:sortIndex		0..*	Extension	SortIndex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"sortIndex"
PrepItem		0..*	(Complex)	Prep Item URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:id		0..1	Extension	PrepItem Sectiontext Id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"id"
extension:body		0..1	Extension	PrepItem Body ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"body"
extension:sortIndex		0..1	Extension	PrepItem Sort Index ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"sortIndex"
Link		0..*	(Complex)	PrepItem Links URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"name"
extension:url		0..1	Extension	Link Url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"url"
extension:readable_text		0..1	Extension	Readable text ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"readable_text"
extension:type		0..1	Extension	Link type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"type"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	PrepItem Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep"
ReferralReference		0..1	(Complex)	Extension to hold information about the HealthcareService the referral applies to URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:healthcareService		1..1	Extension	Reference to the HealthcareService the referral applies. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"healthcareService"
Slices for value[x]		1..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueReference	S	1..1	Reference(HealthCareService)	Reference to the HealthcareService the referral applies. ele-1: All FHIR elements must have a @value or children
extension:gapDays		0..1	Extension	Gap Days. Days between the referral and the appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"gapDays"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueInteger		0..1	integer	Gap Days. Number of days between the referral and the appointment. Integer ele-1: All FHIR elements must have a @value or children
extension:receiveCorrespondence		0..1	Extension	Should referred HealthcareService receive correspondence. Otherwise only sending to inhabitant ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"receiveCorrespondence"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueBoolean		0..1	boolean	Should receive correspondance. In those cases a template is not defined in kalla for the referral correspondence, only a communication to the inhabitant will be sent. ele-1: All FHIR elements must have a @value or children
url	S	1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference"
ReschedulingReason		0..1	string	Rescheduling Reason URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason Binding: Kalla Rescheduling Reasons (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
SelfCheckin		0..1	boolean	Extension to flag if Self service checkin is enabled for the appointment URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
VisitType		0..1	code	Visit Type. Value from ValueSet VisitTypes NEW|FOLLOWUP URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType Binding: Kalla Visit Types (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	Identifier	AppointmentId ele-1: All FHIR elements must have a @value or children
status	?!ΣC	1..1	code	Status of the apppointment. Used to distinguish bookings from rescedulings. Use 'booked' or 'proposed' Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children
cancellationReason	ΣC	0..1	CodeableConcept	Reason for cancelling Binding: Kalla Cancellation Reasons (required) ele-1: All FHIR elements must have a @value or children
appointmentType	Σ	1..1	CodeableConcept	Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) ele-1: All FHIR elements must have a @value or children
replaces		0..1	Reference(Appointment)	Reference to Appointment that was rescheduled ele-1: All FHIR elements must have a @value or children
start	ΣC	0..1	instant	Appointment start time ele-1: All FHIR elements must have a @value or children
end	ΣC	0..1	instant	Apponintment end time ele-1: All FHIR elements must have a @value or children
minutesDuration		0..1	positiveInt	Duration in minutes ele-1: All FHIR elements must have a @value or children
Slices for participant	C	1..2	BackboneElement	Participant slices Slice: Unordered, Open by value:$this.type app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
participant:healthcareservice	C	1..1	BackboneElement	HealthcareServices involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
actor	ΣC	1..1	Reference(HealthcareService)	The individual, device, location, or service participating in the appointment ele-1: All FHIR elements must have a @value or children
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
participant:practitioner	C	0..1	BackboneElement	Practitioner involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ATND
actor	ΣC	0..1	Reference(Practitioner)	Reference to Practitioner ele-1: All FHIR elements must have a @value or children
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Constraints

Path	Conformance	ValueSet / Code	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 from the FHIR Standard
Appointment.cancellationReason	required	KallaCancellationReason http://bki.skane.se/invanartjanster/fhir/ValueSet/cancellation-reason from this IG
Appointment.appointmentType	required	KallaAppointmentType http://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-type from this IG
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:healthcareservice.type	extensible	Pattern: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:healthcareservice.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:practitioner.type	extensible	Pattern: ATND http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:practitioner.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard

Id	Grade	Path(s)	Details	Requirements
must-have-healthcareservice	error	Appointment	There must be a participant.actor reference to HealthCareService : participant[0].actor.reference.matches('HealthcareService.*')

Differential View

This structure is derived from Appointment

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) must-have-healthcareservice: There must be a participant.actor reference to HealthCareService
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
CareServiceCode		1..1	(Complex)	Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service code
coding
system		0..1	uri	Code System
code		1..1	code	Code
display		0..1	string	Display value
CareServiceArea		1..1	(Complex)	Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service area
coding
system		0..1	uri	Code System
code		1..1	code	Code
display		0..1	string	Display value
IndividualChoice		0..*	(Complex)	Individual choices URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice
Slices for extension				Content/Rules for all slices
extension:Link		0..*	Link	Link
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name
extension:url		0..1	Extension	Link Url
extension:Placeholder		0..*	Placeholder	Placeholder
Prep		0..*	(Complex)	Preps in the invitation template URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep
Slices for extension				Content/Rules for all slices
extension:PrepItem		0..*	PrepItem	Prep Item
Slices for extension				Content/Rules for all slices
extension:id		0..1	Extension	PrepItem Sectiontext Id
extension:body		0..1	Extension	PrepItem Body
extension:sortIndex		0..1	Extension	PrepItem Sort Index
extension:Link		0..*	Link	PrepItem Links
Slices for extension				Content/Rules for all slices
extension:name		0..1	Extension	Link name
extension:url		0..1	Extension	Link Url
extension:Placeholder		0..*	Placeholder	PrepItem Placeholder
ReferralReference		0..1	(Complex)	Extension to hold information about the HealthcareService the referral applies to URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference
Slices for extension				Content/Rules for all slices
extension:healthcareService		1..1	Extension	Reference to the HealthcareService the referral applies.
extension:gapDays		0..1	Extension	Gap Days. Days between the referral and the appointment
extension:receiveCorrespondence		0..1	Extension	Should referred HealthcareService receive correspondence. Otherwise only sending to inhabitant
ReschedulingReason		0..1	string	Rescheduling Reason URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason Binding: Kalla Rescheduling Reasons (required)
SelfCheckin		0..1	boolean	Extension to flag if Self service checkin is enabled for the appointment URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin
VisitType		0..1	code	Visit Type. Value from ValueSet VisitTypes NEW|FOLLOWUP URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType Binding: Kalla Visit Types (required)
identifier		1..1	Identifier	AppointmentId
status		1..1	code	Status of the apppointment. Used to distinguish bookings from rescedulings. Use 'booked' or 'proposed'
cancellationReason		0..1	CodeableConcept	Reason for cancelling Binding: Kalla Cancellation Reasons (required)
appointmentType		1..1	CodeableConcept	Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required)
replaces		0..1	Reference(Appointment)	Reference to Appointment that was rescheduled
start		0..1	instant	Appointment start time
end		0..1	instant	Apponintment end time
minutesDuration		0..1	positiveInt	Duration in minutes
Slices for participant		1..2	BackboneElement	Participant slices Slice: Unordered, Open by value:$this.type
participant:healthcareservice		1..1	BackboneElement	HealthcareServices involved in appointment
type		1..1	CodeableConcept	Role of participant in the appointment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
actor		1..1	Reference(HealthcareService)	The individual, device, location, or service participating in the appointment
status		1..1	code	Status not used by AddCommunication API
participant:practitioner		0..1	BackboneElement	Practitioner involved in appointment
type		1..1	CodeableConcept	Role of participant in the appointment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ATND
actor		0..1	Reference(Practitioner)	Reference to Practitioner
status		1..1	code	Status not used by AddCommunication API
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.cancellationReason	required	KallaCancellationReason http://bki.skane.se/invanartjanster/fhir/ValueSet/cancellation-reason from this IG
Appointment.appointmentType	required	KallaAppointmentType http://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
must-have-healthcareservice	error	Appointment	There must be a participant.actor reference to HealthCareService : participant[0].actor.reference.matches('HealthcareService.*')

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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow must-have-healthcareservice: There must be a participant.actor reference to HealthCareService
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
CareServiceCode		1..1	(Complex)	Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service code
id		0..1	id	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	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Code System
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	1..1	code	Code
display	ΣC	0..1	string	Display value
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
CareServiceArea		1..1	(Complex)	Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Codable concept for Care service area
id		0..1	id	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	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Code System
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	1..1	code	Code Binding: https://tirs.skane.se/sdv-millennium/id/codevalueset/34 (required)
display	ΣC	0..1	string	Display value
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
IndividualChoice		0..*	(Complex)	Individual choices URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:id		0..1	Extension	Id
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"id"
value[x]		0..1	integer	Value of extension
extension:body		0..1	Extension	Body
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"body"
value[x]		0..1	string	Value of extension
extension:type		0..1	Extension	Type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
Link		0..*	(Complex)	Link URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:name		0..1	Extension	Link name
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"name"
value[x]		0..1	string	Value of extension
extension:url		0..1	Extension	Link Url
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"url"
value[x]		0..1	string	Value of extension
extension:readable_text		0..1	Extension	Readable text
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"readable_text"
value[x]		0..1	string	Value of extension
extension:type		0..1	Extension	Link type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice"
Prep		0..*	(Complex)	Preps in the invitation template URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:type		0..1	Extension	Type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
extension:header		0..1	Extension	Header
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"header"
value[x]		0..1	string	Value of extension
extension:printheader		0..1	Extension	Printheader
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"printheader"
value[x]		0..1	boolean	Value of extension
extension:sortIndex		0..*	Extension	SortIndex
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"sortIndex"
value[x]		0..1	integer	Value of extension
PrepItem		0..*	(Complex)	Prep Item URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:id		0..1	Extension	PrepItem Sectiontext Id
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"id"
value[x]		0..1	integer	Value of extension
extension:body		0..1	Extension	PrepItem Body
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"body"
value[x]		0..1	string	Value of extension
extension:sortIndex		0..1	Extension	PrepItem Sort Index
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"sortIndex"
value[x]		0..1	integer	Value of extension
Link		0..*	(Complex)	PrepItem Links URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:name		0..1	Extension	Link name
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"name"
value[x]		0..1	string	Value of extension
extension:url		0..1	Extension	Link Url
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"url"
value[x]		0..1	string	Value of extension
extension:readable_text		0..1	Extension	Readable text
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"readable_text"
value[x]		0..1	string	Value of extension
extension:type		0..1	Extension	Link type
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"type"
value[x]		0..1	string	Value of extension
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extLink"
Placeholder		0..*	(Complex)	PrepItem Placeholder URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPlaceholder
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrepItem"
url		1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep"
ReferralReference		0..1	(Complex)	Extension to hold information about the HealthcareService the referral applies to URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference
id		0..1	id	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:healthcareService		1..1	Extension	Reference to the HealthcareService the referral applies.
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"healthcareService"
Slices for value[x]		1..1	Reference()	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference	S	1..1	Reference(HealthCareService)	Reference to the HealthcareService the referral applies.
extension:gapDays		0..1	Extension	Gap Days. Days between the referral and the appointment
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"gapDays"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueInteger		0..1	integer	Gap Days. Number of days between the referral and the appointment. Integer
extension:receiveCorrespondence		0..1	Extension	Should referred HealthcareService receive correspondence. Otherwise only sending to inhabitant
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"receiveCorrespondence"
Slices for value[x]		0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
value[x]:valueBoolean		0..1	boolean	Should receive correspondance. In those cases a template is not defined in kalla for the referral correspondence, only a communication to the inhabitant will be sent.
url	S	1..1	uri	"http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference"
ReschedulingReason		0..1	string	Rescheduling Reason URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason Binding: Kalla Rescheduling Reasons (required)
SelfCheckin		0..1	boolean	Extension to flag if Self service checkin is enabled for the appointment URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin
VisitType		0..1	code	Visit Type. Value from ValueSet VisitTypes NEW|FOLLOWUP URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType Binding: Kalla Visit Types (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	AppointmentId
status	?!ΣC	1..1	code	Status of the apppointment. Used to distinguish bookings from rescedulings. Use 'booked' or 'proposed' Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancellationReason	ΣC	0..1	CodeableConcept	Reason for cancelling Binding: Kalla Cancellation Reasons (required)
class	Σ	0..*	CodeableConcept	​Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter.
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableReference(HealthcareService)	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	Σ	1..1	CodeableConcept	Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required)
reason	Σ	0..*	CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
priority		0..1	CodeableConcept	Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment.
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
replaces		0..1	Reference(Appointment)	Reference to Appointment that was rescheduled
virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
previousAppointment		0..1	Reference(Appointment)	The previous appointment in a series
originatingAppointment	C	0..1	Reference(Appointment)	The originating appointment in a recurring set of appointments
start	ΣC	0..1	instant	Appointment start time
end	ΣC	0..1	instant	Apponintment end time
minutesDuration		0..1	positiveInt	Duration in minutes
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
slot		0..*	Reference(Slot)	The slots that this appointment is filling
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Appointment
created		0..1	dateTime	The date that this appointment was initially created
cancellationDate	C	0..1	dateTime	When the appointment was cancelled
note		0..*	Annotation	Additional comments
patientInstruction		0..*	CodeableReference(DocumentReference | Binary | Communication)	Detailed information and instructions for the patient
basedOn		0..*	Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest)	The request this appointment is allocated to assess
subject	Σ	0..1	Reference(Patient | Group)	The patient or group associated with the appointment
Slices for participant	C	1..2	BackboneElement	Participant slices Slice: Unordered, Open by value:$this.type app-1: Either the type or actor on the participant SHALL be specified
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	ΣC	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Participation period of the actor
actor	ΣC	0..1	Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location)	The individual, device, location, or service participating in the appointment
required	Σ	0..1	boolean	The participant is required to attend (optional when false)
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:healthcareservice	C	1..1	BackboneElement	HealthcareServices involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
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
period		0..1	Period	Participation period of the actor
actor	ΣC	1..1	Reference(HealthcareService)	The individual, device, location, or service participating in the appointment
required	Σ	0..1	boolean	The participant is required to attend (optional when false)
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:practitioner	C	0..1	BackboneElement	Practitioner involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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	ΣC	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ATND
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
period		0..1	Period	Participation period of the actor
actor	ΣC	0..1	Reference(Practitioner)	Reference to Practitioner
required	Σ	0..1	boolean	The participant is required to attend (optional when false)
status	Σ	1..1	code	Status not used by AddCommunication API Binding: ParticipationStatus (required): The Participation status of an appointment.
recurrenceId		0..1	positiveInt	The sequence number in the recurrence
occurrenceChanged		0..1	boolean	Indicates that this appointment varies from a recurrence pattern
recurrenceTemplate	C	0..*	BackboneElement	Details of the recurrence pattern/template used to generate occurrences
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
timezone		0..1	CodeableConcept	The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175)
recurrenceType		1..1	CodeableConcept	The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175)
lastOccurrenceDate		0..1	date	The date when the recurrence should end
occurrenceCount		0..1	positiveInt	The number of planned occurrences
occurrenceDate		0..*	date	Specific dates for a recurring set of appointments (no template)
weeklyTemplate		0..1	BackboneElement	Information about weekly recurring appointments
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
monday		0..1	boolean	Recurs on Mondays
tuesday		0..1	boolean	Recurs on Tuesday
wednesday		0..1	boolean	Recurs on Wednesday
thursday		0..1	boolean	Recurs on Thursday
friday		0..1	boolean	Recurs on Friday
saturday		0..1	boolean	Recurs on Saturday
sunday		0..1	boolean	Recurs on Sunday
weekInterval		0..1	positiveInt	Recurs every nth week
monthlyTemplate		0..1	BackboneElement	Information about monthly recurring appointments
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
dayOfMonth		0..1	positiveInt	Recurs on a specific day of the month
nthWeekOfMonth		0..1	Coding	Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month.
dayOfWeek		0..1	Coding	Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week.
monthInterval		1..1	positiveInt	Recurs every nth month
yearlyTemplate		0..1	BackboneElement	Information about yearly recurring appointments
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
yearInterval		1..1	positiveInt	Recurs every nth year
excludingDate		0..*	date	Any dates that should be excluded from the series
excludingRecurrenceId		0..*	positiveInt	Any recurrence IDs that should be excluded from the recurrence
Documentation for this format

Terminology Bindings

Constraints

Path	Conformance	ValueSet / Code	URI
Appointment.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Appointment.extension:CareServiceArea.value[x]:valueCodeableConcept.coding.code	required	https://tirs.skane.se/sdv-millennium/id/codevalueset/34 https://tirs.skane.se/sdv-millennium/id/codevalueset/34
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 from the FHIR Standard
Appointment.cancellationReason	required	KallaCancellationReason http://bki.skane.se/invanartjanster/fhir/ValueSet/cancellation-reason from this IG
Appointment.class	preferred	​http://terminology.hl7.org/ValueSet/EncounterClass http://terminology.hl7.org/ValueSet/EncounterClass
Appointment.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Appointment.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	required	KallaAppointmentType http://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-type from this IG
Appointment.reason	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Appointment.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Appointment.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:healthcareservice.type	extensible	Pattern: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:healthcareservice.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.participant:practitioner.type	extensible	Pattern: ATND http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:practitioner.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 from the FHIR Standard
Appointment.recurrenceTemplate.timezone	required	IANATimezones http://hl7.org/fhir/ValueSet/timezones|5.0.0 from the FHIR Standard
Appointment.recurrenceTemplate.recurrenceType	preferred	AppointmentRecurrenceType http://hl7.org/fhir/ValueSet/appointment-recurrrence-type from the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth	required	WeekOfMonth http://hl7.org/fhir/ValueSet/week-of-month|5.0.0 from the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|5.0.0 from the FHIR Standard

Id	Grade	Path(s)	Details	Requirements
must-have-healthcareservice	error	Appointment	There must be a participant.actor reference to HealthCareService : participant[0].actor.reference.matches('HealthcareService.*')

This structure is derived from Appointment

Summary

Mandatory: 7 elements(1 nested mandatory element)

Extensions

This structure refers to these extensions:

• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extIndividualChoice
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extPrep
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReferralReference
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extReschedulingReason
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extSelfCheckin
• http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extVisitType

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

IG © 2023+ Region Skåne. Package communication#2.2 based on FHIR 5.0.0. Generated 2025-02-04
Links: Table of Contents | QA Report