This page is part of the Guide d'implémentation FHIR - Gestion d'Agendas Partagés (v3.0.0-ballot: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

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

Resource Profile: GAP_FrAppointment

Usage:

• Examples for this Resource Profile: Appointment/example-req-appointment

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 FrAppointment

Name	Flags	Card.	Type	Description & Constraints
Appointment		0..*	FrAppointment	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)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	FrAppointment	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)
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
appointmentOperator	N	0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator
url		1..1	uri	"http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator"
Slices for value[x]	N	0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
value[x]:valueReference	N	0..1	Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson)	Value of extension
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
status	?!ΣN	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.
participant	CN	1..*	BackboneElement	Participants involved in appointment
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	ΣN	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
Appointment.status	required	AppointmentStatus
Appointment.participant.status	required	ParticipationStatus

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** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	FrAppointment	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)
id	Σ	0..1	id	Logical id of this artifact
meta	ΣN	0..1	Meta	Metadata about the resource
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
language	N	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	N	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
appointmentOperator	N	0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator"
Slices for value[x]	N	0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
value[x]:valueReference	N	0..1	Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson)	Value of extension
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	ΣN	0..*	Identifier	External Ids for this item
status	?!ΣN	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	ΣN	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	ΣN	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	ΣN	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	ΣN	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: fr-practitioner-specialty (required)
appointmentType	ΣN	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
reasonCode	ΣN	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference	CN	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority	N	0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description	N	0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation	CN	0..*	Reference(Resource)	Additional information to support the appointment
start	ΣN	0..1	instant	When appointment is to take place
end	ΣN	0..1	instant	When appointment is to conclude
minutesDuration	N	0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot	CN	0..*	Reference(FrSlot)	The slots that this appointment is filling
created	N	0..1	dateTime	The date that this appointment was initially created
comment	N	0..1	string	Additional comments
patientInstruction	N	0..1	string	Detailed information and instructions for the patient
basedOn	CN	0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
participant	CN	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	ΣN	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	ΣCN	0..1	Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrPractitioner | FrPatient | FrLocation)	Person, Location/HealthcareService or Device
required	ΣN	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	ΣN	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period	CN	0..1	Period	Participation period of the actor
requestedPeriod	CN	0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	example	AppointmentCancellationReason
Appointment.serviceCategory	example	ServiceCategory
Appointment.serviceType	example	ServiceType
Appointment.specialty	required	fr-practitioner-specialty (a valid code from https://mos.esante.gouv.fr/NOS/TRE_R38-SpecialiteOrdinale/FHIR/TRE-R38-SpecialiteOrdinale)
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes
Appointment.reasonCode	preferred	EncounterReasonCodes
Appointment.participant.type	extensible	ParticipantType
Appointment.participant.required	required	ParticipantRequired
Appointment.participant.status	required	ParticipationStatus

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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Appointment.participant.period, Appointment.requestedPeriod	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Appointment.reasonReference, Appointment.supportingInformation, Appointment.slot, Appointment.basedOn, Appointment.participant.actor	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from FrAppointment

Summary

Differential View

This structure is derived from FrAppointment

Name	Flags	Card.	Type	Description & Constraints
Appointment		0..*	FrAppointment	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)
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	FrAppointment	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)
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
appointmentOperator	N	0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator
url		1..1	uri	"http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator"
Slices for value[x]	N	0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
value[x]:valueReference	N	0..1	Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson)	Value of extension
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
status	?!ΣN	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.
participant	CN	1..*	BackboneElement	Participants involved in appointment
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	ΣN	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
Appointment.status	required	AppointmentStatus
Appointment.participant.status	required	ParticipationStatus

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** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	FrAppointment	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)
id	Σ	0..1	id	Logical id of this artifact
meta	ΣN	0..1	Meta	Metadata about the resource
implicitRules	?!ΣN	0..1	uri	A set of rules under which this content was created
language	N	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text	N	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
appointmentOperator	N	0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator"
Slices for value[x]	N	0..1		Value of extension Slice: Unordered, Open by type:$this
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
value[x]:valueReference	N	0..1	Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson)	Value of extension
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	ΣN	0..*	Identifier	External Ids for this item
status	?!ΣN	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	ΣN	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
serviceCategory	ΣN	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
serviceType	ΣN	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example)
specialty	ΣN	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: fr-practitioner-specialty (required)
appointmentType	ΣN	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
reasonCode	ΣN	0..*	CodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonReference	CN	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority	N	0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description	N	0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation	CN	0..*	Reference(Resource)	Additional information to support the appointment
start	ΣN	0..1	instant	When appointment is to take place
end	ΣN	0..1	instant	When appointment is to conclude
minutesDuration	N	0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot	CN	0..*	Reference(FrSlot)	The slots that this appointment is filling
created	N	0..1	dateTime	The date that this appointment was initially created
comment	N	0..1	string	Additional comments
patientInstruction	N	0..1	string	Detailed information and instructions for the patient
basedOn	CN	0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
participant	CN	1..*	BackboneElement	Participants involved in appointment
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	ΣN	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	ΣCN	0..1	Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrPractitioner | FrPatient | FrLocation)	Person, Location/HealthcareService or Device
required	ΣN	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
status	ΣN	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
period	CN	0..1	Period	Participation period of the actor
requestedPeriod	CN	0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	example	AppointmentCancellationReason
Appointment.serviceCategory	example	ServiceCategory
Appointment.serviceType	example	ServiceType
Appointment.specialty	required	fr-practitioner-specialty (a valid code from https://mos.esante.gouv.fr/NOS/TRE_R38-SpecialiteOrdinale/FHIR/TRE-R38-SpecialiteOrdinale)
Appointment.appointmentType	preferred	Hl7VSAppointmentReasonCodes
Appointment.reasonCode	preferred	EncounterReasonCodes
Appointment.participant.type	extensible	ParticipantType
Appointment.participant.required	required	ParticipantRequired
Appointment.participant.status	required	ParticipationStatus

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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Appointment.participant.period, Appointment.requestedPeriod	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Appointment.reasonReference, Appointment.supportingInformation, Appointment.slot, Appointment.basedOn, Appointment.participant.actor	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from FrAppointment

Summary

Other representations of profile: CSV, Excel, Schematron