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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Resource Profile: Wof Base Appointment ( Abstract )

Base profile of wof Appointment. Inherits IHE Scheduling Appointment.

Usages:

• Derived from this Profile: Appointment Portal and Available Appointment Portal

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..*	IHE_ITI_Appointment_Profile	This is an abstract profile. Child profiles: PortalAvailableAppointment, PortalAppointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for extension				Content/Rules for all slices
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
identifier	SΣ	1..*	Identifier	External Ids for this item
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	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 IHE_ITI_Appointment_Profile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	IHE_ITI_Appointment_Profile	This is an abstract profile. Child profiles: PortalAvailableAppointment, PortalAppointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
meta
versionId	SO	0..1	id	Server-managed resource version Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
profile	SO	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
implicitRules		0..0		A set of rules under which this content was created
text		0..0		Text summary of the resource, for human interpretation
contained		0..0		Contained, inline Resources
modifierExtension		0..0		Extension
identifier		1..*	Identifier	External Ids for this item
cancelationReason		0..0		The coded reason for the appointment being cancelled
specialty		0..0		The specialty of a practitioner that would be required to perform the service requested in this appointment
appointmentType		0..0		The style of appointment or patient that has been booked in the slot (not service type)
reasonReference		0..0		Reason the appointment is to take place (resource)
priority		0..0		Used to make informed decisions if needing to re-prioritize
description		0..0		Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..0		Additional information to support the appointment
minutesDuration		0..0		Can be less than start/end (e.g. estimate)
slot		0..0		The slots that this appointment is filling
created		0..0		The date that this appointment was initially created
comment	S	0..1	string	Additional comments
patientInstruction		0..0		Detailed information and instructions for the patient
basedOn		0..0		The service request this appointment is allocated to assess
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	IHE_ITI_Appointment_Profile	This is an abstract profile. Child profiles: PortalAvailableAppointment, PortalAppointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
identifier	SΣ	1..*	Identifier	External Ids for this item
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
reasonCode	Σ	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceCategory	Base	example	Service category	📦4.0.1	FHIR Std.
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📦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.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	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 IHE_ITI_Appointment_Profile

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 3 elements
Prohibited: 16 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	IHE_ITI_Appointment_Profile	This is an abstract profile. Child profiles: PortalAvailableAppointment, PortalAppointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
Slices for extension				Content/Rules for all slices
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
identifier	SΣ	1..*	Identifier	External Ids for this item
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	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 IHE_ITI_Appointment_Profile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment		0..*	IHE_ITI_Appointment_Profile	This is an abstract profile. Child profiles: PortalAvailableAppointment, PortalAppointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
meta
versionId	SO	0..1	id	Server-managed resource version Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
profile	SO	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
implicitRules		0..0		A set of rules under which this content was created
text		0..0		Text summary of the resource, for human interpretation
contained		0..0		Contained, inline Resources
modifierExtension		0..0		Extension
identifier		1..*	Identifier	External Ids for this item
cancelationReason		0..0		The coded reason for the appointment being cancelled
specialty		0..0		The specialty of a practitioner that would be required to perform the service requested in this appointment
appointmentType		0..0		The style of appointment or patient that has been booked in the slot (not service type)
reasonReference		0..0		Reason the appointment is to take place (resource)
priority		0..0		Used to make informed decisions if needing to re-prioritize
description		0..0		Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..0		Additional information to support the appointment
minutesDuration		0..0		Can be less than start/end (e.g. estimate)
slot		0..0		The slots that this appointment is filling
created		0..0		The date that this appointment was initially created
comment	S	0..1	string	Additional comments
patientInstruction		0..0		Detailed information and instructions for the patient
basedOn		0..0		The service request this appointment is allocated to assess
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Appointment	C	0..*	IHE_ITI_Appointment_Profile	This is an abstract profile. Child profiles: PortalAvailableAppointment, PortalAppointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SOΣ	0..1	id	Server-managed resource version Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SOΣ	1..*	canonical(StructureDefinition)	Profile declaration for this portal resource Obligations Actor SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:status-reason-extension	S	0..1	CodeableConcept	Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment
identifier	SΣ	1..*	Identifier	External Ids for this item
status	?!SΣ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	SΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible)
reasonCode	Σ	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	1..1	instant	When appointment is to conclude
comment	S	0..1	string	Additional comments
participant	C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	1..1	Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	SΣ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
requestedPeriod	S	1..1	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Appointment.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Appointment.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.0.1	FHIR Std.
Appointment.serviceCategory	Base	example	Service category	📦4.0.1	FHIR Std.
Appointment.serviceType	Base	extensible	IHE ITI Scheduling Snomed CT Services	📦1.0.0	Scheduling v1.0
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📦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.

Constraints

Id	Grade	Path(s)	Description	Expression
app-1	error	Appointment.participant	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 IHE_ITI_Appointment_Profile

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 3 elements
Prohibited: 16 elements

Other representations of profile: CSV, Excel, Schematron