This page is part of the HL7 FHIR Implementation Guide: Public Health IG Release 1 - BE Realm | STU1 (v1.0.3: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: Population Screening Appointment ( Experimental )

Appointment Profile for population screening

Usage:

• Refer to this Resource Profile: Population Screening Encounter and PopulationScreening Plan
• Examples for this Resource Profile: Appointment/BK-2-invitation-example-invitation, Appointment/BK-3-invitation-participation-negative-example-appointment, Appointment/BK-5-example-invitation, Appointment/BreastCancerScreeningAppointment... Show 3 more, Appointment/CervicalCancerScreeningAppointment, Appointment/ColonCancerScreeningAppointment and Appointment/example-with-pseudonymization

Formal Views of Profile Content

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

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

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
Appointment		0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
identifier	S	0..*	Identifier	External Ids for this item
start	S	1..1	instant	When appointment is to take place
end	S	0..1	instant	The end of the appointment period. See full description and comments for details.
Slices for participant		1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
participant:All Slices				Content/Rules for all slices
actor
type		1..1	uri	Type the reference refers to (e.g. "Patient")
participant:patient	S	1..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(Patient core BE profile(2.0.0))	Person, Location/HealthcareService or Device
type		0..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
participant:location	S	0..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(Location)	Person, Location/HealthcareService or Device
type		0..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Location
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	0..1	instant	The end of the appointment period. See full description and comments for details.
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Patient core BE profile(2.0.0))	Person, Location/HealthcareService or Device
type	Σ	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). Required Pattern: Patient
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:location	SC	0..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
type	Σ	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). Required Pattern: Location
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:patient.actor.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:patient.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:location.actor.type	extensible	Pattern: Location http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:location.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, Appointment.participant:patient, Appointment.participant:location	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()

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
reasonCode	Σ	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	0..1	instant	The end of the appointment period. See full description and comments for details.
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified
participant:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Patient core BE profile(2.0.0))	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	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). Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:location	SC	0..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	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). Required Pattern: Location
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	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		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	example	AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard
Appointment.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Appointment.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Appointment.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant.actor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:patient.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:patient.actor.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:patient.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant:patient.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:location.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:location.actor.type	extensible	Pattern: Location http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:location.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant:location.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, Appointment.participant:patient, 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: 2 elements(1 nested mandatory element)
Must-Support: 5 elements

Structures

This structure refers to these other structures:

• Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)

Slices

This structure defines the following Slices:

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

Maturity: 1

Differential View

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
Appointment		0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
identifier	S	0..*	Identifier	External Ids for this item
start	S	1..1	instant	When appointment is to take place
end	S	0..1	instant	The end of the appointment period. See full description and comments for details.
Slices for participant		1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
participant:All Slices				Content/Rules for all slices
actor
type		1..1	uri	Type the reference refers to (e.g. "Patient")
participant:patient	S	1..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(Patient core BE profile(2.0.0))	Person, Location/HealthcareService or Device
type		0..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
participant:location	S	0..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(Location)	Person, Location/HealthcareService or Device
type		0..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Location
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	0..1	instant	The end of the appointment period. See full description and comments for details.
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Patient core BE profile(2.0.0))	Person, Location/HealthcareService or Device
type	Σ	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). Required Pattern: Patient
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
participant:location	SC	0..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
type	Σ	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). Required Pattern: Location
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:patient.actor.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:patient.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:location.actor.type	extensible	Pattern: Location http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:location.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, Appointment.participant:patient, Appointment.participant:location	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	External Ids for this item
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
reasonCode	Σ	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference		0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
start	SΣ	1..1	instant	When appointment is to take place
end	SΣ	0..1	instant	The end of the appointment period. See full description and comments for details.
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified
participant:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:patient	SC	1..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Patient core BE profile(2.0.0))	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	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). Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period		0..1	Period	Participation period of the actor
participant:location	SC	0..1	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	Σ	0..1	Reference(Location)	Person, Location/HealthcareService or Device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	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). Required Pattern: Location
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
required	Σ	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	Σ	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		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	example	AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard
Appointment.serviceCategory	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
Appointment.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Appointment.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant.actor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:patient.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:patient.actor.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:patient.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant:patient.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard
Appointment.participant:location.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Appointment.participant:location.actor.type	extensible	Pattern: Location http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Appointment.participant:location.required	required	ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard
Appointment.participant:location.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, Appointment.participant:patient, 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: 2 elements(1 nested mandatory element)
Must-Support: 5 elements

Structures

This structure refers to these other structures:

• Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)

Slices

This structure defines the following Slices:

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

Maturity: 1

Other representations of profile: CSV, Excel, Schematron