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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Resource Profile: AppointmentAppointment

Appointment profile used in appointment booking.

Usages:

• Refer to this Profile: AppointmentProvenance

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..*	Appointment	Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4
Appointment.id	Σ This element is included in summaries.	0..1	id	Unique identifier of the appointment
Appointment.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Appointment.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentAppointment (no extensions allowed)
Appointment.meta.security	Σ This element is included in summaries.	0..*	Coding	Display of appointment information Binding: fipta-vs-visible (required)
Appointment.meta.security.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.meta.security.code	Σ This element is included in summaries.	1..1	code	Code value for information on disclosure of a minor's data to guardians
Appointment.meta.security.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		1..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Appointment.text		1..1	Narrative	Appointment information to be presented in display form This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Appointment.Slices for extension				Content/Rules for all slices
Appointment.Slices for extension.extension:remoteServiceURL		0..1	url	Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
Appointment.Slices for extension.extension:ServiceAdditionalInformation		0..1	string	Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
Appointment.Slices for extension.extension:AppointmentReason		0..1	(Complex)	Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
Appointment.Slices for extension.extension:CareplanIdentifier		0..1	Identifier	Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
Appointment.Slices for extension.extension:NotificationMedium		0..*	Coding	Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required)
Appointment.Slices for extension.extension:CustomerJourney		0..*	(Complex)	Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
Appointment.Slices for extension.extension:SelfServiceInfo		0..1	(Complex)	Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
Appointment.Slices for extension.extension:AppointmentMutabilityNotAfter		0..1	dateTime	Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
Appointment.Slices for extension.extension:QueueNo		0..1	string	Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
Appointment.Slices for extension.extension:TicketNo		0..1	string	Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
Appointment.Slices for extension.extension:ChildAppointment		0..*	Identifier	Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
Appointment.Slices for extension.extension:AdditionalInformationURL		0..*	url	Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
Appointment.Slices for extension.extension:PractitionerGender		0..1	Coding	Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required)
Appointment.Slices for extension.extension:BookingDeadline		0..1	dateTime	Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	Σ This element is included in summaries.	1..1	Identifier	Appointment identifier
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	Σ This element is included in summaries.	1..1	string	Appointment identifier Example General: 123456
Appointment.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required)
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (required)
Appointment.cancelationReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Appointment.cancelationReason.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.cancelationReason.coding.code	Σ This element is included in summaries.	1..1	code	Code value for the reason why the appointment was cancelled
Appointment.cancelationReason.coding.display	Σ This element is included in summaries.	1..1	string	Reason why the appointment was cancelled
Appointment.start	Σ This element is included in summaries.	0..1	instant	Start time of the appointment time interval
Appointment.end	Σ This element is included in summaries.	0..1	instant	End time of the appointment time interval
Appointment.comment		0..1	string	Additional information
Appointment.patientInstruction		0..1	string	Patient instruction
Appointment.patientInstruction.Slices for extension				Content/Rules for all slices
Appointment.patientInstruction.Slices for extension.extension:PatientInstructionURL		0..*	url	Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Appointment.basedOn		0..*	Reference(ServiceRequest)	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier	Σ This element is included in summaries.	1..1	Identifier	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.basedOn.identifier.value	Σ This element is included in summaries.	1..1	string	Referral or request identifier Example General: 123456
Appointment.Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Appointment.Slices for participant.participant:All Slices				Content/Rules for all slices
Appointment.Slices for participant.participant:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:All Slices.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.Slices for participant.participant:Patient	C	1..1	BackboneElement	Customer Constraints: app-1
Appointment.Slices for participant.participant:Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Patient.type	Σ This element is included in summaries.	1..1	CodeableConcept	Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Patient.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Patient.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Patient.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentPatient) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Patient.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Patient.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService	C	1..1	BackboneElement	Healthcare service Constraints: app-1
Appointment.Slices for participant.participant:HealthcareService.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:HealthcareService.type	Σ This element is included in summaries.	1..1	CodeableConcept	Healthcare service Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:HealthcareService.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:HealthcareService.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:HealthcareService.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentHealthcareService) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:HealthcareService.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:HealthcareService.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Location	C	0..1	BackboneElement	Service point location Constraints: app-1
Appointment.Slices for participant.participant:Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Location.type	Σ This element is included in summaries.	1..1	CodeableConcept	Service point location details Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Location.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Location.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Location.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentLocation) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Location.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Location.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	required	fipta-vs-visible	📦1.0.0	This IG
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	fipta-vs-appointmentstatus	📦1.0.0	This IG
Appointment.cancelationReason	Base	required	fipta-vs-cancelationreason	📦1.0.0	This IG
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:Patient.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:HealthcareService.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:HealthcareService.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:Location.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
PTA-APP-1	error	Appointment	The end time of the appointment cannot be before the start time of the appointment.	start.exists() implies start <= end
PTA-APP-2	error	Appointment	The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
PTA-APP-3	error	Appointment	The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
PTA-APP-4	error	Appointment	The appointment identifier (Appointment.identifier) exceeds the allowed maximum length.	Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
app-1	error	Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location	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 Appointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	Appointment information Constraints: PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4
Appointment.id		0..1	id	Unique identifier of the appointment
Appointment.meta		0..1	Meta	Metadata about the resource
Appointment.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentAppointment (no extensions allowed)
Appointment.meta.security		0..*	Coding	Display of appointment information Binding: fipta-vs-visible (required)
Appointment.meta.security.id		0..0		Unique id for inter-element referencing
Appointment.meta.security.system		1..1	uri	Identity of the terminology system
Appointment.meta.security.version		0..0		Version of the system - if relevant
Appointment.meta.security.code		1..1	code	Code value for information on disclosure of a minor's data to guardians
Appointment.meta.security.display		1..1	string	Representation defined by the system
Appointment.meta.security.userSelected		0..0		If this coding was chosen directly by the user
Appointment.language		1..1	code	Language of the resource content
Appointment.text		1..1	Narrative	Appointment information to be presented in display form
Appointment.Slices for extension				Content/Rules for all slices
Appointment.Slices for extension.extension:remoteServiceURL		0..1	url	Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
Appointment.Slices for extension.extension:ServiceAdditionalInformation		0..1	string	Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
Appointment.Slices for extension.extension:AppointmentReason		0..1	(Complex)	Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
Appointment.Slices for extension.extension:CareplanIdentifier		0..1	Identifier	Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
Appointment.Slices for extension.extension:NotificationMedium		0..*	Coding	Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required)
Appointment.Slices for extension.extension:CustomerJourney		0..*	(Complex)	Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
Appointment.Slices for extension.extension:SelfServiceInfo		0..1	(Complex)	Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
Appointment.Slices for extension.extension:AppointmentMutabilityNotAfter		0..1	dateTime	Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
Appointment.Slices for extension.extension:QueueNo		0..1	string	Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
Appointment.Slices for extension.extension:TicketNo		0..1	string	Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
Appointment.Slices for extension.extension:ChildAppointment		0..*	Identifier	Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
Appointment.Slices for extension.extension:AdditionalInformationURL		0..*	url	Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
Appointment.Slices for extension.extension:PractitionerGender		0..1	Coding	Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required)
Appointment.Slices for extension.extension:BookingDeadline		0..1	dateTime	Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
Appointment.identifier		1..1	Identifier	Appointment identifier
Appointment.identifier.id		0..0		Unique id for inter-element referencing
Appointment.identifier.use		0..0		usual | official | temp | secondary | old (If known)
Appointment.identifier.type		0..0		Description of identifier
Appointment.identifier.system		1..1	uri	Namespace defined by the organization
Appointment.identifier.value		1..1	string	Appointment identifier
Appointment.identifier.period		0..0		Time period when id is/was valid for use
Appointment.identifier.assigner		0..0		Organization that issued id (may be just text)
Appointment.status		1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required)
Appointment.cancelationReason		0..1	CodeableConcept	Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (required)
Appointment.cancelationReason.coding		1..1	Coding	Code defined by a terminology system
Appointment.cancelationReason.coding.system		1..1	uri	Identity of the terminology system
Appointment.cancelationReason.coding.version		0..0		Version of the system - if relevant
Appointment.cancelationReason.coding.code		1..1	code	Code value for the reason why the appointment was cancelled
Appointment.cancelationReason.coding.display		1..1	string	Reason why the appointment was cancelled
Appointment.cancelationReason.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.cancelationReason.text		0..0		Plain text representation of the concept
Appointment.serviceCategory		0..0		Service category
Appointment.serviceType		0..0		Service name
Appointment.specialty		0..0		The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType		0..0		The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode		0..0		Coded reason this appointment is scheduled
Appointment.reasonReference		0..0		Description of symptoms, the main reason for contact, and a description of the customer's risk information
Appointment.priority		0..0		Used to make informed decisions if needing to re-prioritize
Appointment.description		0..0		Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation		0..0		Additional information to support the appointment
Appointment.start		0..1	instant	Start time of the appointment time interval
Appointment.end		0..1	instant	End time of the appointment time interval
Appointment.minutesDuration		0..0		Can be less than start/end (e.g. estimate)
Appointment.slot		0..0		The slots that this appointment is filling
Appointment.created		0..0		The date that this appointment was initially created
Appointment.comment		0..1	string	Additional information
Appointment.patientInstruction		0..1	string	Patient instruction
Appointment.patientInstruction.Slices for extension				Content/Rules for all slices
Appointment.patientInstruction.Slices for extension.extension:PatientInstructionURL		0..*	url	Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Appointment.basedOn		0..*	Reference(ServiceRequest)	Identifier of the referral or request related to the appointment
Appointment.basedOn.reference		0..0		Literal reference, Relative, internal or absolute URL
Appointment.basedOn.type		0..0		Type the reference refers to (e.g. "Patient")
Appointment.basedOn.identifier		1..1	Identifier	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier.use		0..0		usual | official | temp | secondary | old (If known)
Appointment.basedOn.identifier.type		0..0		Description of identifier
Appointment.basedOn.identifier.system		1..1	uri	Namespace defined by the organization
Appointment.basedOn.identifier.value		1..1	string	Referral or request identifier
Appointment.basedOn.identifier.period		0..0		Time period when id is/was valid for use
Appointment.basedOn.identifier.assigner		0..0		Organization that issued id (may be just text)
Appointment.basedOn.display		0..0		Text alternative for the resource
Appointment.Slices for participant		1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Appointment.Slices for participant.participant:Patient		1..1	BackboneElement	Customer
Appointment.Slices for participant.participant:Patient.type		1..1	CodeableConcept	Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Patient.type.coding		1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Patient.type.coding.system		1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.version		0..0		Version of the system - if relevant
Appointment.Slices for participant.participant:Patient.type.coding.code		1..1	code	Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.display		1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Patient.type.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.Slices for participant.participant:Patient.type.text		0..0		Plain text representation of the concept
Appointment.Slices for participant.participant:Patient.actor		1..1	Reference(AppointmentPatient) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Patient.actor.reference		1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Patient.actor.identifier		0..0		Logical reference, when literal reference is not known
Appointment.Slices for participant.participant:Patient.actor.display		0..0		Text alternative for the resource
Appointment.Slices for participant.participant:Patient.required		0..0		required | optional | information-only
Appointment.Slices for participant.participant:Patient.status		1..1	code	accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Patient.period		0..0		Participation period of the actor
Appointment.Slices for participant.participant:HealthcareService		1..1	BackboneElement	Healthcare service
Appointment.Slices for participant.participant:HealthcareService.type		1..1	CodeableConcept	Healthcare service Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:HealthcareService.type.coding		1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:HealthcareService.type.coding.system		1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.version		0..0		Version of the system - if relevant
Appointment.Slices for participant.participant:HealthcareService.type.coding.code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.display		1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:HealthcareService.type.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.Slices for participant.participant:HealthcareService.type.text		0..0		Plain text representation of the concept
Appointment.Slices for participant.participant:HealthcareService.actor		1..1	Reference(AppointmentHealthcareService) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:HealthcareService.actor.reference		1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:HealthcareService.actor.identifier		0..0		Logical reference, when literal reference is not known
Appointment.Slices for participant.participant:HealthcareService.actor.display		0..0		Text alternative for the resource
Appointment.Slices for participant.participant:HealthcareService.required		0..0		required | optional | information-only
Appointment.Slices for participant.participant:HealthcareService.status		1..1	code	accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.period		0..0		Participation period of the actor
Appointment.Slices for participant.participant:Location		0..1	BackboneElement	Service point location
Appointment.Slices for participant.participant:Location.type		1..1	CodeableConcept	Service point location details Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Location.type.coding		1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Location.type.coding.system		1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.version		0..0		Version of the system - if relevant
Appointment.Slices for participant.participant:Location.type.coding.code		1..1	code	Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.display		1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Location.type.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.Slices for participant.participant:Location.type.text		0..0		Plain text representation of the concept
Appointment.Slices for participant.participant:Location.actor		1..1	Reference(AppointmentLocation) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Location.actor.reference		1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Location.actor.identifier		0..0		Logical reference, when literal reference is not known
Appointment.Slices for participant.participant:Location.actor.display		0..0		Text alternative for the resource
Appointment.Slices for participant.participant:Location.required		0..0		required | optional | information-only
Appointment.Slices for participant.participant:Location.status		1..1	code	accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Location.period		0..0		Participation period of the actor
Appointment.requestedPeriod		0..0		Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	required	fipta-vs-visible	📦1.0.0	This IG
Appointment.status	Base	required	fipta-vs-appointmentstatus	📦1.0.0	This IG
Appointment.cancelationReason	Base	required	fipta-vs-cancelationreason	📦1.0.0	This IG
Appointment.participant:Patient.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:HealthcareService.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Location.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
PTA-APP-1	error	Appointment	The end time of the appointment cannot be before the start time of the appointment.	start.exists() implies start <= end
PTA-APP-2	error	Appointment	The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
PTA-APP-3	error	Appointment	The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
PTA-APP-4	error	Appointment	The appointment identifier (Appointment.identifier) exceeds the allowed maximum length.	Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4
Appointment.id	Σ This element is included in summaries.	0..1	id	Unique identifier of the appointment
Appointment.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Appointment.meta.id		0..1	string	Unique id for inter-element referencing
Appointment.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Appointment.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Appointment.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
Appointment.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentAppointment (no extensions allowed)
Appointment.meta.security	Σ This element is included in summaries.	0..*	Coding	Display of appointment information Binding: fipta-vs-visible (required)
Appointment.meta.security.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.meta.security.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.meta.security.code	Σ This element is included in summaries.	1..1	code	Code value for information on disclosure of a minor's data to guardians
Appointment.meta.security.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.meta.tag	Σ This element is included in summaries.	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".
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		1..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Appointment.text		1..1	Narrative	Appointment information to be presented in display form This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Appointment.contained		0..*	Resource	Contained, inline Resources
Appointment.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:remoteServiceURL		0..1	url	Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
Appointment.Slices for extension.extension:ServiceAdditionalInformation		0..1	string	Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
Appointment.Slices for extension.extension:AppointmentReason		0..1	(Complex)	Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
Appointment.Slices for extension.extension:CareplanIdentifier		0..1	Identifier	Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
Appointment.Slices for extension.extension:NotificationMedium		0..*	Coding	Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required)
Appointment.Slices for extension.extension:CustomerJourney		0..*	(Complex)	Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
Appointment.Slices for extension.extension:SelfServiceInfo		0..1	(Complex)	Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
Appointment.Slices for extension.extension:AppointmentMutabilityNotAfter		0..1	dateTime	Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
Appointment.Slices for extension.extension:QueueNo		0..1	string	Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
Appointment.Slices for extension.extension:TicketNo		0..1	string	Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
Appointment.Slices for extension.extension:ChildAppointment		0..*	Identifier	Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
Appointment.Slices for extension.extension:AdditionalInformationURL		0..*	url	Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
Appointment.Slices for extension.extension:PractitionerGender		0..1	Coding	Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required)
Appointment.Slices for extension.extension:BookingDeadline		0..1	dateTime	Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	Σ This element is included in summaries.	1..1	Identifier	Appointment identifier
Appointment.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	Σ This element is included in summaries.	1..1	string	Appointment identifier Example General: 123456
Appointment.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required)
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (required)
Appointment.cancelationReason.id		0..1	string	Unique id for inter-element referencing
Appointment.cancelationReason.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.cancelationReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Appointment.cancelationReason.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.cancelationReason.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.cancelationReason.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.cancelationReason.coding.code	Σ This element is included in summaries.	1..1	code	Code value for the reason why the appointment was cancelled
Appointment.cancelationReason.coding.display	Σ This element is included in summaries.	1..1	string	Reason why the appointment was cancelled
Appointment.start	Σ This element is included in summaries.	0..1	instant	Start time of the appointment time interval
Appointment.end	Σ This element is included in summaries.	0..1	instant	End time of the appointment time interval
Appointment.comment		0..1	string	Additional information
Appointment.patientInstruction		0..1	string	Patient instruction
Appointment.patientInstruction.id		0..1	string	xml:id (or equivalent in JSON)
Appointment.patientInstruction.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Appointment.patientInstruction.Slices for extension.extension:PatientInstructionURL		0..*	url	Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Appointment.patientInstruction.value		0..1	string	Primitive value for string Max Length:1048576
Appointment.basedOn		0..*	Reference(ServiceRequest)	Identifier of the referral or request related to the appointment
Appointment.basedOn.id		0..1	string	Unique id for inter-element referencing
Appointment.basedOn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.basedOn.identifier	Σ This element is included in summaries.	1..1	Identifier	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier.id		0..1	string	Unique id for inter-element referencing
Appointment.basedOn.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.basedOn.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.basedOn.identifier.value	Σ This element is included in summaries.	1..1	string	Referral or request identifier Example General: 123456
Appointment.Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Appointment.Slices for participant.participant:All Slices				Content/Rules for all slices
Appointment.Slices for participant.participant:All Slices.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:All Slices.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:All Slices.type	Σ This element is included in summaries.	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
Appointment.Slices for participant.participant:All Slices.actor	Σ This element is included in summaries.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:All Slices.required	Σ This element is included in summaries.	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.Slices for participant.participant:All Slices.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.Slices for participant.participant:All Slices.period		0..1	Period	Participation period of the actor
Appointment.Slices for participant.participant:Patient	C	1..1	BackboneElement	Customer Constraints: app-1
Appointment.Slices for participant.participant:Patient.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Patient.type	Σ This element is included in summaries.	1..1	CodeableConcept	Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Patient.type.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Patient.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Patient.type.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Patient.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Patient.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentPatient) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Patient.actor.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.actor.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Patient.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Patient.actor.type	Σ This element is included in summaries.	0..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).
Appointment.Slices for participant.participant:Patient.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService	C	1..1	BackboneElement	Healthcare service Constraints: app-1
Appointment.Slices for participant.participant:HealthcareService.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:HealthcareService.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:HealthcareService.type	Σ This element is included in summaries.	1..1	CodeableConcept	Healthcare service Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:HealthcareService.type.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:HealthcareService.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:HealthcareService.type.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:HealthcareService.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:HealthcareService.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentHealthcareService) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:HealthcareService.actor.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.actor.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:HealthcareService.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:HealthcareService.actor.type	Σ This element is included in summaries.	0..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).
Appointment.Slices for participant.participant:HealthcareService.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Location	C	0..1	BackboneElement	Service point location Constraints: app-1
Appointment.Slices for participant.participant:Location.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Location.type	Σ This element is included in summaries.	1..1	CodeableConcept	Service point location details Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Location.type.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Location.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Location.type.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Location.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Location.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentLocation) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Location.actor.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.actor.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Location.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Location.actor.type	Σ This element is included in summaries.	0..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).
Appointment.Slices for participant.participant:Location.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	required	fipta-vs-visible	📦1.0.0	This IG
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	fipta-vs-appointmentstatus	📦1.0.0	This IG
Appointment.cancelationReason	Base	required	fipta-vs-cancelationreason	📦1.0.0	This IG
Appointment.reasonReference.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
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:Patient.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:Patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:HealthcareService.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
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:Location.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Location.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:Location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
PTA-APP-1	error	Appointment	The end time of the appointment cannot be before the start time of the appointment.	start.exists() implies start <= end
PTA-APP-2	error	Appointment	The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
PTA-APP-3	error	Appointment	The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
PTA-APP-4	error	Appointment	The appointment identifier (Appointment.identifier) exceeds the allowed maximum length.	Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
app-1	error	Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location	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 Appointment

Summary

Mandatory: 21 elements(22 nested mandatory elements)
Fixed: 11 elements
Prohibited: 55 elements

Structures

This structure refers to these other structures:

• AppointmentPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPatient)
• AppointmentHealthcareService (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentHealthcareService)
• AppointmentLocation (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentLocation)

Extensions

This structure refers to these extensions:

• https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
• https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
• https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
• https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
• https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium
• https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
• https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
• https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
• https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
• https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
• https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
• https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
• https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender
• https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
• https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4
Appointment.id	Σ This element is included in summaries.	0..1	id	Unique identifier of the appointment
Appointment.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Appointment.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentAppointment (no extensions allowed)
Appointment.meta.security	Σ This element is included in summaries.	0..*	Coding	Display of appointment information Binding: fipta-vs-visible (required)
Appointment.meta.security.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.meta.security.code	Σ This element is included in summaries.	1..1	code	Code value for information on disclosure of a minor's data to guardians
Appointment.meta.security.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		1..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Appointment.text		1..1	Narrative	Appointment information to be presented in display form This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Appointment.Slices for extension				Content/Rules for all slices
Appointment.Slices for extension.extension:remoteServiceURL		0..1	url	Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
Appointment.Slices for extension.extension:ServiceAdditionalInformation		0..1	string	Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
Appointment.Slices for extension.extension:AppointmentReason		0..1	(Complex)	Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
Appointment.Slices for extension.extension:CareplanIdentifier		0..1	Identifier	Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
Appointment.Slices for extension.extension:NotificationMedium		0..*	Coding	Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required)
Appointment.Slices for extension.extension:CustomerJourney		0..*	(Complex)	Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
Appointment.Slices for extension.extension:SelfServiceInfo		0..1	(Complex)	Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
Appointment.Slices for extension.extension:AppointmentMutabilityNotAfter		0..1	dateTime	Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
Appointment.Slices for extension.extension:QueueNo		0..1	string	Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
Appointment.Slices for extension.extension:TicketNo		0..1	string	Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
Appointment.Slices for extension.extension:ChildAppointment		0..*	Identifier	Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
Appointment.Slices for extension.extension:AdditionalInformationURL		0..*	url	Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
Appointment.Slices for extension.extension:PractitionerGender		0..1	Coding	Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required)
Appointment.Slices for extension.extension:BookingDeadline		0..1	dateTime	Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	Σ This element is included in summaries.	1..1	Identifier	Appointment identifier
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	Σ This element is included in summaries.	1..1	string	Appointment identifier Example General: 123456
Appointment.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required)
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (required)
Appointment.cancelationReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Appointment.cancelationReason.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.cancelationReason.coding.code	Σ This element is included in summaries.	1..1	code	Code value for the reason why the appointment was cancelled
Appointment.cancelationReason.coding.display	Σ This element is included in summaries.	1..1	string	Reason why the appointment was cancelled
Appointment.start	Σ This element is included in summaries.	0..1	instant	Start time of the appointment time interval
Appointment.end	Σ This element is included in summaries.	0..1	instant	End time of the appointment time interval
Appointment.comment		0..1	string	Additional information
Appointment.patientInstruction		0..1	string	Patient instruction
Appointment.patientInstruction.Slices for extension				Content/Rules for all slices
Appointment.patientInstruction.Slices for extension.extension:PatientInstructionURL		0..*	url	Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Appointment.basedOn		0..*	Reference(ServiceRequest)	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier	Σ This element is included in summaries.	1..1	Identifier	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.basedOn.identifier.value	Σ This element is included in summaries.	1..1	string	Referral or request identifier Example General: 123456
Appointment.Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Appointment.Slices for participant.participant:All Slices				Content/Rules for all slices
Appointment.Slices for participant.participant:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:All Slices.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.Slices for participant.participant:Patient	C	1..1	BackboneElement	Customer Constraints: app-1
Appointment.Slices for participant.participant:Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Patient.type	Σ This element is included in summaries.	1..1	CodeableConcept	Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Patient.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Patient.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Patient.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentPatient) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Patient.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Patient.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService	C	1..1	BackboneElement	Healthcare service Constraints: app-1
Appointment.Slices for participant.participant:HealthcareService.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:HealthcareService.type	Σ This element is included in summaries.	1..1	CodeableConcept	Healthcare service Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:HealthcareService.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:HealthcareService.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:HealthcareService.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentHealthcareService) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:HealthcareService.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:HealthcareService.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Location	C	0..1	BackboneElement	Service point location Constraints: app-1
Appointment.Slices for participant.participant:Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Location.type	Σ This element is included in summaries.	1..1	CodeableConcept	Service point location details Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Location.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Location.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Location.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentLocation) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Location.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Location.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	required	fipta-vs-visible	📦1.0.0	This IG
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	fipta-vs-appointmentstatus	📦1.0.0	This IG
Appointment.cancelationReason	Base	required	fipta-vs-cancelationreason	📦1.0.0	This IG
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:Patient.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:HealthcareService.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:HealthcareService.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:Location.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
PTA-APP-1	error	Appointment	The end time of the appointment cannot be before the start time of the appointment.	start.exists() implies start <= end
PTA-APP-2	error	Appointment	The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
PTA-APP-3	error	Appointment	The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
PTA-APP-4	error	Appointment	The appointment identifier (Appointment.identifier) exceeds the allowed maximum length.	Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
app-1	error	Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location	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 Appointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	Appointment information Constraints: PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4
Appointment.id		0..1	id	Unique identifier of the appointment
Appointment.meta		0..1	Meta	Metadata about the resource
Appointment.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentAppointment (no extensions allowed)
Appointment.meta.security		0..*	Coding	Display of appointment information Binding: fipta-vs-visible (required)
Appointment.meta.security.id		0..0		Unique id for inter-element referencing
Appointment.meta.security.system		1..1	uri	Identity of the terminology system
Appointment.meta.security.version		0..0		Version of the system - if relevant
Appointment.meta.security.code		1..1	code	Code value for information on disclosure of a minor's data to guardians
Appointment.meta.security.display		1..1	string	Representation defined by the system
Appointment.meta.security.userSelected		0..0		If this coding was chosen directly by the user
Appointment.language		1..1	code	Language of the resource content
Appointment.text		1..1	Narrative	Appointment information to be presented in display form
Appointment.Slices for extension				Content/Rules for all slices
Appointment.Slices for extension.extension:remoteServiceURL		0..1	url	Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
Appointment.Slices for extension.extension:ServiceAdditionalInformation		0..1	string	Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
Appointment.Slices for extension.extension:AppointmentReason		0..1	(Complex)	Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
Appointment.Slices for extension.extension:CareplanIdentifier		0..1	Identifier	Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
Appointment.Slices for extension.extension:NotificationMedium		0..*	Coding	Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required)
Appointment.Slices for extension.extension:CustomerJourney		0..*	(Complex)	Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
Appointment.Slices for extension.extension:SelfServiceInfo		0..1	(Complex)	Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
Appointment.Slices for extension.extension:AppointmentMutabilityNotAfter		0..1	dateTime	Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
Appointment.Slices for extension.extension:QueueNo		0..1	string	Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
Appointment.Slices for extension.extension:TicketNo		0..1	string	Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
Appointment.Slices for extension.extension:ChildAppointment		0..*	Identifier	Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
Appointment.Slices for extension.extension:AdditionalInformationURL		0..*	url	Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
Appointment.Slices for extension.extension:PractitionerGender		0..1	Coding	Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required)
Appointment.Slices for extension.extension:BookingDeadline		0..1	dateTime	Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
Appointment.identifier		1..1	Identifier	Appointment identifier
Appointment.identifier.id		0..0		Unique id for inter-element referencing
Appointment.identifier.use		0..0		usual | official | temp | secondary | old (If known)
Appointment.identifier.type		0..0		Description of identifier
Appointment.identifier.system		1..1	uri	Namespace defined by the organization
Appointment.identifier.value		1..1	string	Appointment identifier
Appointment.identifier.period		0..0		Time period when id is/was valid for use
Appointment.identifier.assigner		0..0		Organization that issued id (may be just text)
Appointment.status		1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required)
Appointment.cancelationReason		0..1	CodeableConcept	Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (required)
Appointment.cancelationReason.coding		1..1	Coding	Code defined by a terminology system
Appointment.cancelationReason.coding.system		1..1	uri	Identity of the terminology system
Appointment.cancelationReason.coding.version		0..0		Version of the system - if relevant
Appointment.cancelationReason.coding.code		1..1	code	Code value for the reason why the appointment was cancelled
Appointment.cancelationReason.coding.display		1..1	string	Reason why the appointment was cancelled
Appointment.cancelationReason.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.cancelationReason.text		0..0		Plain text representation of the concept
Appointment.serviceCategory		0..0		Service category
Appointment.serviceType		0..0		Service name
Appointment.specialty		0..0		The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType		0..0		The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode		0..0		Coded reason this appointment is scheduled
Appointment.reasonReference		0..0		Description of symptoms, the main reason for contact, and a description of the customer's risk information
Appointment.priority		0..0		Used to make informed decisions if needing to re-prioritize
Appointment.description		0..0		Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation		0..0		Additional information to support the appointment
Appointment.start		0..1	instant	Start time of the appointment time interval
Appointment.end		0..1	instant	End time of the appointment time interval
Appointment.minutesDuration		0..0		Can be less than start/end (e.g. estimate)
Appointment.slot		0..0		The slots that this appointment is filling
Appointment.created		0..0		The date that this appointment was initially created
Appointment.comment		0..1	string	Additional information
Appointment.patientInstruction		0..1	string	Patient instruction
Appointment.patientInstruction.Slices for extension				Content/Rules for all slices
Appointment.patientInstruction.Slices for extension.extension:PatientInstructionURL		0..*	url	Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Appointment.basedOn		0..*	Reference(ServiceRequest)	Identifier of the referral or request related to the appointment
Appointment.basedOn.reference		0..0		Literal reference, Relative, internal or absolute URL
Appointment.basedOn.type		0..0		Type the reference refers to (e.g. "Patient")
Appointment.basedOn.identifier		1..1	Identifier	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier.use		0..0		usual | official | temp | secondary | old (If known)
Appointment.basedOn.identifier.type		0..0		Description of identifier
Appointment.basedOn.identifier.system		1..1	uri	Namespace defined by the organization
Appointment.basedOn.identifier.value		1..1	string	Referral or request identifier
Appointment.basedOn.identifier.period		0..0		Time period when id is/was valid for use
Appointment.basedOn.identifier.assigner		0..0		Organization that issued id (may be just text)
Appointment.basedOn.display		0..0		Text alternative for the resource
Appointment.Slices for participant		1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Appointment.Slices for participant.participant:Patient		1..1	BackboneElement	Customer
Appointment.Slices for participant.participant:Patient.type		1..1	CodeableConcept	Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Patient.type.coding		1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Patient.type.coding.system		1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.version		0..0		Version of the system - if relevant
Appointment.Slices for participant.participant:Patient.type.coding.code		1..1	code	Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.display		1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Patient.type.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.Slices for participant.participant:Patient.type.text		0..0		Plain text representation of the concept
Appointment.Slices for participant.participant:Patient.actor		1..1	Reference(AppointmentPatient) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Patient.actor.reference		1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Patient.actor.identifier		0..0		Logical reference, when literal reference is not known
Appointment.Slices for participant.participant:Patient.actor.display		0..0		Text alternative for the resource
Appointment.Slices for participant.participant:Patient.required		0..0		required | optional | information-only
Appointment.Slices for participant.participant:Patient.status		1..1	code	accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Patient.period		0..0		Participation period of the actor
Appointment.Slices for participant.participant:HealthcareService		1..1	BackboneElement	Healthcare service
Appointment.Slices for participant.participant:HealthcareService.type		1..1	CodeableConcept	Healthcare service Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:HealthcareService.type.coding		1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:HealthcareService.type.coding.system		1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.version		0..0		Version of the system - if relevant
Appointment.Slices for participant.participant:HealthcareService.type.coding.code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.display		1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:HealthcareService.type.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.Slices for participant.participant:HealthcareService.type.text		0..0		Plain text representation of the concept
Appointment.Slices for participant.participant:HealthcareService.actor		1..1	Reference(AppointmentHealthcareService) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:HealthcareService.actor.reference		1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:HealthcareService.actor.identifier		0..0		Logical reference, when literal reference is not known
Appointment.Slices for participant.participant:HealthcareService.actor.display		0..0		Text alternative for the resource
Appointment.Slices for participant.participant:HealthcareService.required		0..0		required | optional | information-only
Appointment.Slices for participant.participant:HealthcareService.status		1..1	code	accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.period		0..0		Participation period of the actor
Appointment.Slices for participant.participant:Location		0..1	BackboneElement	Service point location
Appointment.Slices for participant.participant:Location.type		1..1	CodeableConcept	Service point location details Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Location.type.coding		1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Location.type.coding.system		1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.version		0..0		Version of the system - if relevant
Appointment.Slices for participant.participant:Location.type.coding.code		1..1	code	Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.display		1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Location.type.coding.userSelected		0..0		If this coding was chosen directly by the user
Appointment.Slices for participant.participant:Location.type.text		0..0		Plain text representation of the concept
Appointment.Slices for participant.participant:Location.actor		1..1	Reference(AppointmentLocation) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Location.actor.reference		1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Location.actor.identifier		0..0		Logical reference, when literal reference is not known
Appointment.Slices for participant.participant:Location.actor.display		0..0		Text alternative for the resource
Appointment.Slices for participant.participant:Location.required		0..0		required | optional | information-only
Appointment.Slices for participant.participant:Location.status		1..1	code	accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Location.period		0..0		Participation period of the actor
Appointment.requestedPeriod		0..0		Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	required	fipta-vs-visible	📦1.0.0	This IG
Appointment.status	Base	required	fipta-vs-appointmentstatus	📦1.0.0	This IG
Appointment.cancelationReason	Base	required	fipta-vs-cancelationreason	📦1.0.0	This IG
Appointment.participant:Patient.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:HealthcareService.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Location.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
PTA-APP-1	error	Appointment	The end time of the appointment cannot be before the start time of the appointment.	start.exists() implies start <= end
PTA-APP-2	error	Appointment	The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
PTA-APP-3	error	Appointment	The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
PTA-APP-4	error	Appointment	The appointment identifier (Appointment.identifier) exceeds the allowed maximum length.	Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	Appointment	Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4
Appointment.id	Σ This element is included in summaries.	0..1	id	Unique identifier of the appointment
Appointment.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Appointment.meta.id		0..1	string	Unique id for inter-element referencing
Appointment.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Appointment.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Appointment.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
Appointment.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentAppointment (no extensions allowed)
Appointment.meta.security	Σ This element is included in summaries.	0..*	Coding	Display of appointment information Binding: fipta-vs-visible (required)
Appointment.meta.security.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.meta.security.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.meta.security.code	Σ This element is included in summaries.	1..1	code	Code value for information on disclosure of a minor's data to guardians
Appointment.meta.security.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.meta.tag	Σ This element is included in summaries.	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".
Appointment.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		1..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Appointment.text		1..1	Narrative	Appointment information to be presented in display form This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Appointment.contained		0..*	Resource	Contained, inline Resources
Appointment.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Appointment.Slices for extension.extension:remoteServiceURL		0..1	url	Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
Appointment.Slices for extension.extension:ServiceAdditionalInformation		0..1	string	Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
Appointment.Slices for extension.extension:AppointmentReason		0..1	(Complex)	Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
Appointment.Slices for extension.extension:CareplanIdentifier		0..1	Identifier	Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
Appointment.Slices for extension.extension:NotificationMedium		0..*	Coding	Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required)
Appointment.Slices for extension.extension:CustomerJourney		0..*	(Complex)	Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
Appointment.Slices for extension.extension:SelfServiceInfo		0..1	(Complex)	Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
Appointment.Slices for extension.extension:AppointmentMutabilityNotAfter		0..1	dateTime	Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
Appointment.Slices for extension.extension:QueueNo		0..1	string	Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
Appointment.Slices for extension.extension:TicketNo		0..1	string	Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
Appointment.Slices for extension.extension:ChildAppointment		0..*	Identifier	Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
Appointment.Slices for extension.extension:AdditionalInformationURL		0..*	url	Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
Appointment.Slices for extension.extension:PractitionerGender		0..1	Coding	Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required)
Appointment.Slices for extension.extension:BookingDeadline		0..1	dateTime	Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	Σ This element is included in summaries.	1..1	Identifier	Appointment identifier
Appointment.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	Σ This element is included in summaries.	1..1	string	Appointment identifier Example General: 123456
Appointment.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required)
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (required)
Appointment.cancelationReason.id		0..1	string	Unique id for inter-element referencing
Appointment.cancelationReason.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.cancelationReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Appointment.cancelationReason.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.cancelationReason.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.cancelationReason.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Appointment.cancelationReason.coding.code	Σ This element is included in summaries.	1..1	code	Code value for the reason why the appointment was cancelled
Appointment.cancelationReason.coding.display	Σ This element is included in summaries.	1..1	string	Reason why the appointment was cancelled
Appointment.start	Σ This element is included in summaries.	0..1	instant	Start time of the appointment time interval
Appointment.end	Σ This element is included in summaries.	0..1	instant	End time of the appointment time interval
Appointment.comment		0..1	string	Additional information
Appointment.patientInstruction		0..1	string	Patient instruction
Appointment.patientInstruction.id		0..1	string	xml:id (or equivalent in JSON)
Appointment.patientInstruction.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Appointment.patientInstruction.Slices for extension.extension:PatientInstructionURL		0..*	url	Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Appointment.patientInstruction.value		0..1	string	Primitive value for string Max Length:1048576
Appointment.basedOn		0..*	Reference(ServiceRequest)	Identifier of the referral or request related to the appointment
Appointment.basedOn.id		0..1	string	Unique id for inter-element referencing
Appointment.basedOn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.basedOn.identifier	Σ This element is included in summaries.	1..1	Identifier	Identifier of the referral or request related to the appointment
Appointment.basedOn.identifier.id		0..1	string	Unique id for inter-element referencing
Appointment.basedOn.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.basedOn.identifier.system	Σ This element is included in summaries.	1..1	uri	Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient
Appointment.basedOn.identifier.value	Σ This element is included in summaries.	1..1	string	Referral or request identifier Example General: 123456
Appointment.Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Appointment.Slices for participant.participant:All Slices				Content/Rules for all slices
Appointment.Slices for participant.participant:All Slices.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:All Slices.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:All Slices.type	Σ This element is included in summaries.	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
Appointment.Slices for participant.participant:All Slices.actor	Σ This element is included in summaries.	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:All Slices.required	Σ This element is included in summaries.	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.Slices for participant.participant:All Slices.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.Slices for participant.participant:All Slices.period		0..1	Period	Participation period of the actor
Appointment.Slices for participant.participant:Patient	C	1..1	BackboneElement	Customer Constraints: app-1
Appointment.Slices for participant.participant:Patient.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Patient.type	Σ This element is included in summaries.	1..1	CodeableConcept	Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Patient.type.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Patient.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Patient.type.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Patient.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed)
Appointment.Slices for participant.participant:Patient.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Patient.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentPatient) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Patient.actor.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Patient.actor.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Patient.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Patient.actor.type	Σ This element is included in summaries.	0..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).
Appointment.Slices for participant.participant:Patient.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService	C	1..1	BackboneElement	Healthcare service Constraints: app-1
Appointment.Slices for participant.participant:HealthcareService.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:HealthcareService.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:HealthcareService.type	Σ This element is included in summaries.	1..1	CodeableConcept	Healthcare service Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:HealthcareService.type.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:HealthcareService.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:HealthcareService.type.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:HealthcareService.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed)
Appointment.Slices for participant.participant:HealthcareService.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:HealthcareService.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentHealthcareService) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:HealthcareService.actor.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:HealthcareService.actor.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:HealthcareService.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:HealthcareService.actor.type	Σ This element is included in summaries.	0..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).
Appointment.Slices for participant.participant:HealthcareService.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Appointment.Slices for participant.participant:Location	C	0..1	BackboneElement	Service point location Constraints: app-1
Appointment.Slices for participant.participant:Location.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.extension		0..*	Extension	Additional content defined by implementations
Appointment.Slices for participant.participant:Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.Slices for participant.participant:Location.type	Σ This element is included in summaries.	1..1	CodeableConcept	Service point location details Binding: fipta-vs-appointmenttypecategory (required)
Appointment.Slices for participant.participant:Location.type.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Location.type.coding	Σ This element is included in summaries.	1..1	Coding	Role in appointment
Appointment.Slices for participant.participant:Location.type.coding.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Location.type.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed)
Appointment.Slices for participant.participant:Location.type.coding.display	Σ This element is included in summaries.	1..1	string	Representation defined by the system
Appointment.Slices for participant.participant:Location.actor	Σ This element is included in summaries.	1..1	Reference(AppointmentLocation) {c}	Person, Location/HealthcareService or Device
Appointment.Slices for participant.participant:Location.actor.id		0..1	string	Unique id for inter-element referencing
Appointment.Slices for participant.participant:Location.actor.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.Slices for participant.participant:Location.actor.reference	Σ This element is included in summaries. C	1..1	string	Reference to the resource to be used
Appointment.Slices for participant.participant:Location.actor.type	Σ This element is included in summaries.	0..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).
Appointment.Slices for participant.participant:Location.status	Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	required	fipta-vs-visible	📦1.0.0	This IG
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Appointment.status	Base	required	fipta-vs-appointmentstatus	📦1.0.0	This IG
Appointment.cancelationReason	Base	required	fipta-vs-cancelationreason	📦1.0.0	This IG
Appointment.reasonReference.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
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:Patient.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Patient.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:Patient.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.
Appointment.participant:HealthcareService.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
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:Location.​type	Base	required	fipta-vs-appointmenttypecategory	📦1.0.0	This IG
Appointment.participant:Location.​actor.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Appointment.participant:Location.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
PTA-APP-1	error	Appointment	The end time of the appointment cannot be before the start time of the appointment.	start.exists() implies start <= end
PTA-APP-2	error	Appointment	The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
PTA-APP-3	error	Appointment	The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.	Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
PTA-APP-4	error	Appointment	The appointment identifier (Appointment.identifier) exceeds the allowed maximum length.	Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
app-1	error	Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location	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 Appointment

Summary

Mandatory: 21 elements(22 nested mandatory elements)
Fixed: 11 elements
Prohibited: 55 elements

Structures

This structure refers to these other structures:

• AppointmentPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPatient)
• AppointmentHealthcareService (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentHealthcareService)
• AppointmentLocation (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentLocation)

Extensions

This structure refers to these extensions:

• https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
• https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
• https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
• https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
• https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium
• https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
• https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
• https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
• https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
• https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
• https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
• https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
• https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender
• https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
• https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL

Slices

This structure defines the following Slices:

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