This page is part of the Guide d'implémentation Fr Core (v2.1.0-ballot: trial-use Ballot 6) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions

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

Resource Profile: FR Core Appointment Profile

Profile of the Appointment resource for France. This profile adds the operator who created/updated/canceled the appointment. It also allows to possibly reference an appointment canceled and a document associated with the appointment.

Profil de la ressource Appointment pour la France. Ce profil ajoute l’opérateur qui a créé/modifié/annulé le RDV. Il permet également de référencer éventuellement un RDV annulé et/ou un document lié au RDV.

Usage:

• Refer to this Resource Profile: FR Core Encounter Profile
• Examples for this Resource Profile: Appointment/FRCoreAppointmentExample

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)
meta
Slices for profile		0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:fr-canonical		0..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment
Slices for extension				Content/Rules for all slices
appointmentOperator		0..1	Reference(FR Core Organization Profile | FR Core Practitioner Profile | FR Core Patient Profile | RelatedPerson)	FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
specialty		0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FR Core ValueSet Practitioner specialty (required)
slot		0..*	Reference(FR Core Slot Profile)	The slots that this appointment is filling
participant
actor		0..1	Reference(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Practitioner Profile | FR Core Patient Profile | FR Core Location Profile)	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.specialty	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG

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
Slices for extension				Content/Rules for all slices
appointmentOperator		0..1	Reference(FR Core Organization Profile | FR Core Practitioner Profile | FR Core Patient Profile | RelatedPerson)	FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FR Core ValueSet Practitioner specialty (required)
slot		0..*	Reference(FR Core Slot Profile)	The slots that this appointment is filling
participant	C	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(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Practitioner Profile | FR Core Patient Profile | FR Core Location Profile)	Person, Location/HealthcareService or Device
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	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.specialty	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG
Appointment.participant.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	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
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	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
Slices for profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:fr-canonical	Σ	0..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
appointmentOperator		0..1	Reference(FR Core Organization Profile | FR Core Practitioner Profile | FR Core Patient Profile | RelatedPerson)	FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	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: FR Core ValueSet Practitioner specialty (required)
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	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(FR Core Slot Profile)	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
participant	C	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(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Practitioner Profile | FR Core Patient Profile | FR Core Location Profile)	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	Σ	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	URI
Appointment.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Appointment.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
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	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG
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.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

Constraints

Id	Grade	Path(s)	Details	Requirements
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 Appointment

Summary

Structures

This structure refers to these other structures:

• FR Core Slot Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot)
• FR Core Related Person Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person)
• FR Core Healthcare Service Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service)
• FR Core Practitioner Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-practitioner)
• FR Core Patient Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient)
• FR Core Location Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location)

Extensions

This structure refers to these extensions:

• https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator

Slices

This structure defines the following Slices:

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

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)
meta
Slices for profile		0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:fr-canonical		0..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment
Slices for extension				Content/Rules for all slices
appointmentOperator		0..1	Reference(FR Core Organization Profile | FR Core Practitioner Profile | FR Core Patient Profile | RelatedPerson)	FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
specialty		0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FR Core ValueSet Practitioner specialty (required)
slot		0..*	Reference(FR Core Slot Profile)	The slots that this appointment is filling
participant
actor		0..1	Reference(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Practitioner Profile | FR Core Patient Profile | FR Core Location Profile)	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.specialty	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG

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
Slices for extension				Content/Rules for all slices
appointmentOperator		0..1	Reference(FR Core Organization Profile | FR Core Practitioner Profile | FR Core Patient Profile | RelatedPerson)	FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: FR Core ValueSet Practitioner specialty (required)
slot		0..*	Reference(FR Core Slot Profile)	The slots that this appointment is filling
participant	C	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(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Practitioner Profile | FR Core Patient Profile | FR Core Location Profile)	Person, Location/HealthcareService or Device
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	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.specialty	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG
Appointment.participant.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	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
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	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
Slices for profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
profile:fr-canonical	Σ	0..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
appointmentOperator		0..1	Reference(FR Core Organization Profile | FR Core Practitioner Profile | FR Core Patient Profile | RelatedPerson)	FR Core Appointment Operator Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	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: FR Core ValueSet Practitioner specialty (required)
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	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference(FR Core Slot Profile)	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
participant	C	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(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Practitioner Profile | FR Core Patient Profile | FR Core Location Profile)	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	Σ	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	URI
Appointment.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Appointment.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
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	required	FRCoreValueSetPractitionerSpecialty https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG
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.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

Constraints

Id	Grade	Path(s)	Details	Requirements
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 Appointment

Summary

Structures

This structure refers to these other structures:

• FR Core Slot Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot)
• FR Core Related Person Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person)
• FR Core Healthcare Service Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service)
• FR Core Practitioner Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-practitioner)
• FR Core Patient Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient)
• FR Core Location Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location)

Extensions

This structure refers to these extensions:

• https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment-operator

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron