ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Resource Profile: Appointment Portal

The public API model for 'Portal Appointment
Appointment representation of a booked visit. Inherits IHE Scheduling Appointment.

This profile is to be used in a patient context and where the appointment status is anything other than '#proposed'.

Usages:

• CapabilityStatements using this Profile: WOF Portal Capability Statement
• This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	WofBaseAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
Slices for extension				Content/Rules for all slices
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
extension:characteristic		0..1	(Complex)	Service and booking characteristics URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:scheduling		0..1	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:childPatientThreshold	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"childPatientThreshold"
value[x]		0..1	integer	Upper age limit (in years) for booking as a child patient.
extension:minChangeHours	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"minChangeHours"
extension:webReschedulingCountAllowed	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"webReschedulingCountAllowed"
extension:schedulingAvailability	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"schedulingAvailability"
value[x]		1..1	CodeableConcept	Clinic-level scheduling capabilities, such as cancellation and rescheduling availability.
extension:bookingConfirmation	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"bookingConfirmation"
value[x]		0..1	Coding	Booking confirmation method
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://canonical.fhir.link/servicewell/wof-base/CodeSystem/wc-characteristic
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: WOF-Base Booking Confirmation Characteristic (required)
url		1..1	uri	"scheduling"
extension:workflow		0..1	Extension	Workflow capability container
Slices for extension				Content/Rules for all slices
extension:deviceBookingAvailable		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"deviceBookingAvailable"
value[x]		1..1	boolean	Indicates that devices (e.g., dental chairs) are directly bookable resources.
extension:healthcareServiceAvailable		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"healthcareServiceAvailable"
value[x]		1..1	boolean	Indicates whether the source PMS provides first-class HealthcareService entities with booking rules.
url		1..1	uri	"workflow"
extension:security		0..1	Extension	Security capability container
Slices for extension				Content/Rules for all slices
extension:requiresNativeIdPLogin		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"requiresNativeIdPLogin"
url		1..1	uri	"security"
url		1..1	uri	"http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic"
extension:appointmentUpdate		0..1	(Complex)	Current appointment update status URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
extension:activityDefinitionReference	O	0..1	Reference(ActivityDefinitionPortal)	Reference to related activity definition URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
extension:consentToMarketing	SO	0..1	boolean	Patient consent to marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for identifier	SΣ	1..*	Identifier	External Ids for this item Slice: Unordered, Open by value:type.text
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	OΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
identifier:sourceSystemIdentifier	SΣ	1..1	Identifier	External Ids for this item
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Source systems identifier for the appointment Example General: 123456
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: Booked Appointment Statuses (required)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
Slices for participant	C	3..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:healthcareService	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(HealthcareServicePortal)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:practitionerRole	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(PractitionerRolePortal)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:patient	C	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Portal Patient)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	Patient pnr identifier system | SHOULD be an identifier system from a national FHIR Patient profile. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	personalnumber as reference to the Patient Example General: 123456
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.extension:characteristic.​extension:scheduling.​extension:bookingConfirmation.​value[x].code	Base	required	WOF-Base Booking Confirmation Characteristic	📦1.0.1	This IG
Appointment.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.identifier:sourceSystemIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.status	Base	required	Booked Appointment Statuses	📦1.0.1	This IG
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole, Appointment.participant:patient	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from WofBaseAppointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	WofBaseAppointment	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)
meta
versionId		0..1	id	Server-managed resource version
profile		1..*	canonical(StructureDefinition)	Profile declaration for this portal resource
Slices for extension				Content/Rules for all slices
extension:characteristic		0..1	(Complex)	Service and booking characteristics URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
Slices for extension				Content/Rules for all slices
extension:scheduling		0..1	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:childPatientThreshold	S	0..1	Extension	Extension
extension:minChangeHours	S	0..1	Extension	Extension
extension:webReschedulingCountAllowed	S	0..1	Extension	Extension
extension:schedulingAvailability	S	0..1	Extension	Extension
extension:bookingConfirmation	S	0..1	Extension	Extension
value[x]
code	S	0..1	code	Symbol in syntax defined by the system
extension:appointmentUpdate		0..1	(Complex)	Current appointment update status URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
extension:activityDefinitionReference	O	0..1	Reference(ActivityDefinitionPortal)	Reference to related activity definition URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
extension:consentToMarketing	SO	0..1	boolean	Patient consent to marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for identifier		1..*	Identifier	External Ids for this item Slice: Unordered, Open by value:type.text
identifier:All Slices				Content/Rules for all slices
type	O	0..1	CodeableConcept	Description of identifier Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
identifier:sourceSystemIdentifier	S	1..1	Identifier	External Ids for this item
type
text		1..1	string	Plain text representation of the concept Required Pattern: source systems appointment concept
system	S	1..1	uri	Identifier-based reference to the Appointment concept in the source system.
value	S	1..1	string	Source systems identifier for the appointment
status		1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: Booked Appointment Statuses (required)
serviceCategory		0..0		A broad categorization of the service that is to be performed during this appointment
reasonCode		0..0		Coded reason this appointment is scheduled
Slices for participant		3..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
participant:healthcareService		0..1	BackboneElement	Participants involved in appointment
actor		1..1	Reference(HealthcareServicePortal)	Person, Location/HealthcareService or Device
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: HealthcareService
participant:practitionerRole		0..1	BackboneElement	Participants involved in appointment
actor		1..1	Reference(PractitionerRolePortal)	Person, Location/HealthcareService or Device
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: PractitionerRole
participant:patient		1..1	BackboneElement	Participants involved in appointment
actor		1..1	Reference(Portal Patient)	Person, Location/HealthcareService or Device
reference	S	0..0		Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system	S	1..1	uri	Patient pnr identifier system | SHOULD be an identifier system from a national FHIR Patient profile.
value	S	1..1	string	personalnumber as reference to the Patient
status		1..1	code	accepted | declined | tentative | needs-action Required Pattern: accepted
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	Booked Appointment Statuses	📦1.0.1	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	WofBaseAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
extension:characteristic		0..1	(Complex)	Service and booking characteristics URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:scheduling		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:childPatientThreshold	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"childPatientThreshold"
value[x]		0..1	integer	Upper age limit (in years) for booking as a child patient.
extension:minChangeHours	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"minChangeHours"
value[x]		0..1	integer	Number of hours before appointment start after which changes are no longer allowed.
extension:webReschedulingCountAllowed	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"webReschedulingCountAllowed"
value[x]		0..1	integer	Number of allowed reschedulings for this appointment.
extension:schedulingAvailability	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"schedulingAvailability"
value[x]		1..1	CodeableConcept	Clinic-level scheduling capabilities, such as cancellation and rescheduling availability.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://canonical.fhir.link/servicewell/wof-base/CodeSystem/wc-characteristic
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Binding: WOF-Base ScheduleCharacteristic (required)
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
extension:bookingConfirmation	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"bookingConfirmation"
value[x]		0..1	Coding	Booking confirmation method
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://canonical.fhir.link/servicewell/wof-base/CodeSystem/wc-characteristic
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: WOF-Base Booking Confirmation Characteristic (required)
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
url		1..1	uri	"scheduling"
extension:workflow		0..1	Extension	Workflow capability container
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:deviceBookingAvailable		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"deviceBookingAvailable"
value[x]		1..1	boolean	Indicates that devices (e.g., dental chairs) are directly bookable resources.
extension:healthcareServiceAvailable		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"healthcareServiceAvailable"
value[x]		1..1	boolean	Indicates whether the source PMS provides first-class HealthcareService entities with booking rules.
url		1..1	uri	"workflow"
extension:security		0..1	Extension	Security capability container
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:requiresNativeIdPLogin		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"requiresNativeIdPLogin"
value[x]		0..1	boolean	Identity provider used for patient login (e.g., BankID).
url		1..1	uri	"security"
url		1..1	uri	"http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic"
extension:appointmentUpdate		0..1	(Complex)	Current appointment update status URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
extension:activityDefinitionReference	O	0..1	Reference(ActivityDefinitionPortal)	Reference to related activity definition URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
extension:consentToMarketing	SO	0..1	boolean	Patient consent to marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for identifier	SΣ	1..*	Identifier	External Ids for this item Slice: Unordered, Open by value:type.text
identifier: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 Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	OΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:sourceSystemIdentifier	SΣ	1..1	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	OΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	1..1	string	Plain text representation of the concept Required Pattern: source systems appointment concept
system	SΣ	1..1	uri	Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Source systems identifier for the appointment Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: Booked Appointment Statuses (required)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
Slices for participant	C	3..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:healthcareService	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(HealthcareServicePortal)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:practitionerRole	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(PractitionerRolePortal)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:patient	C	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(Portal Patient)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	Patient pnr identifier system | SHOULD be an identifier system from a national FHIR Patient profile. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	personalnumber as reference to the Patient Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Appointment.extension:characteristic.​extension:scheduling.​extension:schedulingAvailability.​value[x].coding.code	Base	required	WOF-Base ScheduleCharacteristic	📦1.0.1	This IG
Appointment.extension:characteristic.​extension:scheduling.​extension:bookingConfirmation.​value[x].code	Base	required	WOF-Base Booking Confirmation Characteristic	📦1.0.1	This IG
Appointment.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.identifier:sourceSystemIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.identifier:sourceSystemIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.status	Base	required	Booked Appointment Statuses	📦1.0.1	This IG
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.participant.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant:healthcareService.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:patient.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant:patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole, Appointment.participant:patient	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from WofBaseAppointment

Summary

Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

• HealthcareServicePortal (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/healthcare-service-portal)
• PractitionerRolePortal (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/practitioner-role-portal)
• Portal Patient (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-patient)

Extensions

This structure refers to these extensions:

• http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
• http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
• https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
• http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	WofBaseAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
Slices for extension				Content/Rules for all slices
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
extension:characteristic		0..1	(Complex)	Service and booking characteristics URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:scheduling		0..1	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:childPatientThreshold	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"childPatientThreshold"
value[x]		0..1	integer	Upper age limit (in years) for booking as a child patient.
extension:minChangeHours	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"minChangeHours"
extension:webReschedulingCountAllowed	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"webReschedulingCountAllowed"
extension:schedulingAvailability	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"schedulingAvailability"
value[x]		1..1	CodeableConcept	Clinic-level scheduling capabilities, such as cancellation and rescheduling availability.
extension:bookingConfirmation	S	0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"bookingConfirmation"
value[x]		0..1	Coding	Booking confirmation method
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://canonical.fhir.link/servicewell/wof-base/CodeSystem/wc-characteristic
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: WOF-Base Booking Confirmation Characteristic (required)
url		1..1	uri	"scheduling"
extension:workflow		0..1	Extension	Workflow capability container
Slices for extension				Content/Rules for all slices
extension:deviceBookingAvailable		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"deviceBookingAvailable"
value[x]		1..1	boolean	Indicates that devices (e.g., dental chairs) are directly bookable resources.
extension:healthcareServiceAvailable		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"healthcareServiceAvailable"
value[x]		1..1	boolean	Indicates whether the source PMS provides first-class HealthcareService entities with booking rules.
url		1..1	uri	"workflow"
extension:security		0..1	Extension	Security capability container
Slices for extension				Content/Rules for all slices
extension:requiresNativeIdPLogin		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"requiresNativeIdPLogin"
url		1..1	uri	"security"
url		1..1	uri	"http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic"
extension:appointmentUpdate		0..1	(Complex)	Current appointment update status URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
extension:activityDefinitionReference	O	0..1	Reference(ActivityDefinitionPortal)	Reference to related activity definition URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
extension:consentToMarketing	SO	0..1	boolean	Patient consent to marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for identifier	SΣ	1..*	Identifier	External Ids for this item Slice: Unordered, Open by value:type.text
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	OΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
identifier:sourceSystemIdentifier	SΣ	1..1	Identifier	External Ids for this item
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Source systems identifier for the appointment Example General: 123456
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: Booked Appointment Statuses (required)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
Slices for participant	C	3..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:healthcareService	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(HealthcareServicePortal)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:practitionerRole	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(PractitionerRolePortal)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:patient	C	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Portal Patient)	Person, Location/HealthcareService or Device
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	Patient pnr identifier system | SHOULD be an identifier system from a national FHIR Patient profile. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	personalnumber as reference to the Patient Example General: 123456
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.extension:characteristic.​extension:scheduling.​extension:bookingConfirmation.​value[x].code	Base	required	WOF-Base Booking Confirmation Characteristic	📦1.0.1	This IG
Appointment.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.identifier:sourceSystemIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.status	Base	required	Booked Appointment Statuses	📦1.0.1	This IG
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole, Appointment.participant:patient	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from WofBaseAppointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	WofBaseAppointment	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)
meta
versionId		0..1	id	Server-managed resource version
profile		1..*	canonical(StructureDefinition)	Profile declaration for this portal resource
Slices for extension				Content/Rules for all slices
extension:characteristic		0..1	(Complex)	Service and booking characteristics URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
Slices for extension				Content/Rules for all slices
extension:scheduling		0..1	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:childPatientThreshold	S	0..1	Extension	Extension
extension:minChangeHours	S	0..1	Extension	Extension
extension:webReschedulingCountAllowed	S	0..1	Extension	Extension
extension:schedulingAvailability	S	0..1	Extension	Extension
extension:bookingConfirmation	S	0..1	Extension	Extension
value[x]
code	S	0..1	code	Symbol in syntax defined by the system
extension:appointmentUpdate		0..1	(Complex)	Current appointment update status URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
extension:activityDefinitionReference	O	0..1	Reference(ActivityDefinitionPortal)	Reference to related activity definition URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
extension:consentToMarketing	SO	0..1	boolean	Patient consent to marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for identifier		1..*	Identifier	External Ids for this item Slice: Unordered, Open by value:type.text
identifier:All Slices				Content/Rules for all slices
type	O	0..1	CodeableConcept	Description of identifier Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
identifier:sourceSystemIdentifier	S	1..1	Identifier	External Ids for this item
type
text		1..1	string	Plain text representation of the concept Required Pattern: source systems appointment concept
system	S	1..1	uri	Identifier-based reference to the Appointment concept in the source system.
value	S	1..1	string	Source systems identifier for the appointment
status		1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: Booked Appointment Statuses (required)
serviceCategory		0..0		A broad categorization of the service that is to be performed during this appointment
reasonCode		0..0		Coded reason this appointment is scheduled
Slices for participant		3..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
participant:healthcareService		0..1	BackboneElement	Participants involved in appointment
actor		1..1	Reference(HealthcareServicePortal)	Person, Location/HealthcareService or Device
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: HealthcareService
participant:practitionerRole		0..1	BackboneElement	Participants involved in appointment
actor		1..1	Reference(PractitionerRolePortal)	Person, Location/HealthcareService or Device
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: PractitionerRole
participant:patient		1..1	BackboneElement	Participants involved in appointment
actor		1..1	Reference(Portal Patient)	Person, Location/HealthcareService or Device
reference	S	0..0		Literal reference, Relative, internal or absolute URL
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system	S	1..1	uri	Patient pnr identifier system | SHOULD be an identifier system from a national FHIR Patient profile.
value	S	1..1	string	personalnumber as reference to the Patient
status		1..1	code	accepted | declined | tentative | needs-action Required Pattern: accepted
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	Booked Appointment Statuses	📦1.0.1	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	WofBaseAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor Source SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
extension:characteristic		0..1	(Complex)	Service and booking characteristics URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:scheduling		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:childPatientThreshold	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"childPatientThreshold"
value[x]		0..1	integer	Upper age limit (in years) for booking as a child patient.
extension:minChangeHours	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"minChangeHours"
value[x]		0..1	integer	Number of hours before appointment start after which changes are no longer allowed.
extension:webReschedulingCountAllowed	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"webReschedulingCountAllowed"
value[x]		0..1	integer	Number of allowed reschedulings for this appointment.
extension:schedulingAvailability	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"schedulingAvailability"
value[x]		1..1	CodeableConcept	Clinic-level scheduling capabilities, such as cancellation and rescheduling availability.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://canonical.fhir.link/servicewell/wof-base/CodeSystem/wc-characteristic
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Binding: WOF-Base ScheduleCharacteristic (required)
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
extension:bookingConfirmation	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"bookingConfirmation"
value[x]		0..1	Coding	Booking confirmation method
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://canonical.fhir.link/servicewell/wof-base/CodeSystem/wc-characteristic
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	0..1	code	Symbol in syntax defined by the system Binding: WOF-Base Booking Confirmation Characteristic (required)
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
url		1..1	uri	"scheduling"
extension:workflow		0..1	Extension	Workflow capability container
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:deviceBookingAvailable		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"deviceBookingAvailable"
value[x]		1..1	boolean	Indicates that devices (e.g., dental chairs) are directly bookable resources.
extension:healthcareServiceAvailable		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"healthcareServiceAvailable"
value[x]		1..1	boolean	Indicates whether the source PMS provides first-class HealthcareService entities with booking rules.
url		1..1	uri	"workflow"
extension:security		0..1	Extension	Security capability container
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:requiresNativeIdPLogin		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"requiresNativeIdPLogin"
value[x]		0..1	boolean	Identity provider used for patient login (e.g., BankID).
url		1..1	uri	"security"
url		1..1	uri	"http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic"
extension:appointmentUpdate		0..1	(Complex)	Current appointment update status URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
extension:activityDefinitionReference	O	0..1	Reference(ActivityDefinitionPortal)	Reference to related activity definition URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
extension:consentToMarketing	SO	0..1	boolean	Patient consent to marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing Obligations Actor SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for identifier	SΣ	1..*	Identifier	External Ids for this item Slice: Unordered, Open by value:type.text
identifier: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 Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	OΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:sourceSystemIdentifier	SΣ	1..1	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	OΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Obligations Actor SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	1..1	string	Plain text representation of the concept Required Pattern: source systems appointment concept
system	SΣ	1..1	uri	Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	Source systems identifier for the appointment Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: Booked Appointment Statuses (required)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
Slices for participant	C	3..3	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type Constraints: app-1
participant:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:healthcareService	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(HealthcareServicePortal)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:practitionerRole	C	0..1	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(PractitionerRolePortal)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:patient	C	1..1	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(Portal Patient)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	Patient pnr identifier system | SHOULD be an identifier system from a national FHIR Patient profile. Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	personalnumber as reference to the Patient Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted
period		0..1	Period	Participation period of the actor
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Appointment.extension:characteristic.​extension:scheduling.​extension:schedulingAvailability.​value[x].coding.code	Base	required	WOF-Base ScheduleCharacteristic	📦1.0.1	This IG
Appointment.extension:characteristic.​extension:scheduling.​extension:bookingConfirmation.​value[x].code	Base	required	WOF-Base Booking Confirmation Characteristic	📦1.0.1	This IG
Appointment.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.identifier:sourceSystemIdentifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.identifier:sourceSystemIdentifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.status	Base	required	Booked Appointment Statuses	📦1.0.1	This IG
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.participant.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant:healthcareService.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:healthcareService.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:practitionerRole.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:patient.​type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Appointment.participant:patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Appointment.participant:patient.​actor.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Appointment.participant:patient.​required	Base	required	ParticipantRequired	📍4.0.1	FHIR Std.
Appointment.participant:patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole, Appointment.participant:patient	Either the type or actor on the participant SHALL be specified	type.exists() or actor.exists()
app-2	error	Appointment	Either start and end are specified, or neither	start.exists() = end.exists()
app-3	error	Appointment	Only proposed or cancelled appointments can be missing start/end dates	(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Appointment	Cancelation reason is only used for appointments that have been cancelled, or no-show	Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2	error	Appointment	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Appointment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Appointment	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Appointment	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from WofBaseAppointment

Summary

Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

• HealthcareServicePortal (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/healthcare-service-portal)
• PractitionerRolePortal (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/practitioner-role-portal)
• Portal Patient (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-patient)

Extensions

This structure refers to these extensions:

• http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-characteristic
• http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wofconnect-appointment-update
• https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
• http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing

Slices

This structure defines the following Slices:

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