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)
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
accidentIndicator		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/AccidentIndicator Binding: BRIndicadorAcidente (required)
encounterClass		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required)
newbornCare		1..1	boolean	Extension URL: https://ancode.app/fhir/StructureDefinition/NewbornCare
outpatientType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/OutpatientType Binding: OutpatientType (required)
hospitalizationType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/HospitalizationType Binding: BRTipoInternacao (required)
chemotherapyIndicator		0..1	boolean	Extension URL: https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator
cancelationReason		0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (required)
specialty		1..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required)
appointmentType		1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: EncounterType (required)
priority		1..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		1..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:type
supportingInformation:schedule		1..1	Reference(Schedule)	Additional information to support the appointment
supportingInformation:coverage		0..1	Reference(Coverage)	Additional information to support the appointment
slot		0..1	Reference(Slot)	The slots that this appointment is filling
created		1..1	dateTime	The date that this appointment was initially created
Slices for participant		1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
participant:location		1..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(Location)	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Appointment.cancelationReason	required	AppointmentCancellationReason
Appointment.specialty	required	CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
Appointment.appointmentType	required	EncounterType

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)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
accidentIndicator		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/AccidentIndicator Binding: BRIndicadorAcidente (required)
encounterClass		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required)
newbornCare		1..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/NewbornCare
outpatientType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/OutpatientType Binding: OutpatientType (required)
hospitalizationType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/HospitalizationType Binding: BRTipoInternacao (required)
chemotherapyIndicator		0..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator
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.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (required)
specialty	Σ	1..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: EncounterType (required)
priority		1..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		1..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:type
supportingInformation:schedule		1..1	Reference(Schedule)	Additional information to support the appointment
supportingInformation:coverage		0..1	Reference(Coverage)	Additional information to support the appointment
slot		0..1	Reference(Slot)	The slots that this appointment is filling
created		1..1	dateTime	The date that this appointment was initially created
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
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:location	C	1..1	BackboneElement	Participants involved in appointment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Location)	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
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	required	AppointmentCancellationReason
Appointment.specialty	required	CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
Appointment.appointmentType	required	EncounterType
Appointment.participant.status	required	ParticipationStatus
Appointment.participant:location.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, 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.exists() and ('#'+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(uri) = '#').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)
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): IETF language tag 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		3..*	Extension	Extension Slice: Unordered, Open by value:url
accidentIndicator		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/AccidentIndicator Binding: BRIndicadorAcidente (required)
encounterClass		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required)
newbornCare		1..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/NewbornCare
outpatientType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/OutpatientType Binding: OutpatientType (required)
hospitalizationType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/HospitalizationType Binding: BRTipoInternacao (required)
chemotherapyIndicator		0..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator
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 (required)
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	Σ	1..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: EncounterType (required)
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		1..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		1..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:type
supportingInformation:schedule		1..1	Reference(Schedule)	Additional information to support the appointment
supportingInformation:coverage		0..1	Reference(Coverage)	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..1	Reference(Slot)	The slots that this appointment is filling
created		1..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
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
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	C	1..1	BackboneElement	Participants involved in appointment
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
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
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	required	AppointmentCancellationReason
Appointment.serviceCategory	example	ServiceCategory
Appointment.serviceType	example	ServiceType
Appointment.specialty	required	CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
Appointment.appointmentType	required	EncounterType
Appointment.reasonCode	preferred	EncounterReasonCodes
Appointment.participant.type	extensible	ParticipantType
Appointment.participant.required	required	ParticipantRequired
Appointment.participant.status	required	ParticipationStatus
Appointment.participant:location.type	extensible	ParticipantType
Appointment.participant:location.required	required	ParticipantRequired
Appointment.participant:location.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, Appointment.participant:location	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
dom-r4b	warning	Appointment.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

Summary

Mandatory: 11 elements

Structures

This structure refers to these other structures:

• Schedule (https://ancode.app/fhir/StructureDefinition/Schedule)
• Coverage (https://ancode.app/fhir/StructureDefinition/Coverage)
• Location (https://ancode.app/fhir/StructureDefinition/Location)

Extensions

This structure refers to these extensions:

• https://ancode.app/fhir/StructureDefinition/AccidentIndicator
• https://ancode.app/fhir/StructureDefinition/EncounterClass
• https://ancode.app/fhir/StructureDefinition/NewbornCare
• https://ancode.app/fhir/StructureDefinition/OutpatientType
• https://ancode.app/fhir/StructureDefinition/HospitalizationType
• https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator

Slices

This structure defines the following Slices:

• The element Appointment.supportingInformation is sliced based on the value of type:type
• The element Appointment.participant is sliced based on the value of value:actor.type

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)
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
accidentIndicator		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/AccidentIndicator Binding: BRIndicadorAcidente (required)
encounterClass		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required)
newbornCare		1..1	boolean	Extension URL: https://ancode.app/fhir/StructureDefinition/NewbornCare
outpatientType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/OutpatientType Binding: OutpatientType (required)
hospitalizationType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/HospitalizationType Binding: BRTipoInternacao (required)
chemotherapyIndicator		0..1	boolean	Extension URL: https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator
cancelationReason		0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (required)
specialty		1..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required)
appointmentType		1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: EncounterType (required)
priority		1..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		1..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:type
supportingInformation:schedule		1..1	Reference(Schedule)	Additional information to support the appointment
supportingInformation:coverage		0..1	Reference(Coverage)	Additional information to support the appointment
slot		0..1	Reference(Slot)	The slots that this appointment is filling
created		1..1	dateTime	The date that this appointment was initially created
Slices for participant		1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
participant:location		1..1	BackboneElement	Participants involved in appointment
actor		0..1	Reference(Location)	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Appointment.cancelationReason	required	AppointmentCancellationReason
Appointment.specialty	required	CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
Appointment.appointmentType	required	EncounterType

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)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
accidentIndicator		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/AccidentIndicator Binding: BRIndicadorAcidente (required)
encounterClass		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required)
newbornCare		1..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/NewbornCare
outpatientType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/OutpatientType Binding: OutpatientType (required)
hospitalizationType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/HospitalizationType Binding: BRTipoInternacao (required)
chemotherapyIndicator		0..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator
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.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (required)
specialty	Σ	1..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: EncounterType (required)
priority		1..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		1..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:type
supportingInformation:schedule		1..1	Reference(Schedule)	Additional information to support the appointment
supportingInformation:coverage		0..1	Reference(Coverage)	Additional information to support the appointment
slot		0..1	Reference(Slot)	The slots that this appointment is filling
created		1..1	dateTime	The date that this appointment was initially created
Slices for participant	C	1..*	BackboneElement	Participants involved in appointment Slice: Unordered, Open by value:actor.type
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:location	C	1..1	BackboneElement	Participants involved in appointment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	0..1	Reference(Location)	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
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	required	AppointmentCancellationReason
Appointment.specialty	required	CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
Appointment.appointmentType	required	EncounterType
Appointment.participant.status	required	ParticipationStatus
Appointment.participant:location.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, 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.exists() and ('#'+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(uri) = '#').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)
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): IETF language tag 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		3..*	Extension	Extension Slice: Unordered, Open by value:url
accidentIndicator		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/AccidentIndicator Binding: BRIndicadorAcidente (required)
encounterClass		1..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required)
newbornCare		1..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/NewbornCare
outpatientType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/OutpatientType Binding: OutpatientType (required)
hospitalizationType		0..1	CodeableConcept	Extension URL: https://ancode.app/fhir/StructureDefinition/HospitalizationType Binding: BRTipoInternacao (required)
chemotherapyIndicator		0..1	boolean	Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator
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 (required)
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	Σ	1..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: EncounterType (required)
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		1..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Slices for supportingInformation		1..*	Reference(Resource)	Additional information to support the appointment Slice: Unordered, Open by type:type
supportingInformation:schedule		1..1	Reference(Schedule)	Additional information to support the appointment
supportingInformation:coverage		0..1	Reference(Coverage)	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..1	Reference(Slot)	The slots that this appointment is filling
created		1..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
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
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	C	1..1	BackboneElement	Participants involved in appointment
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
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
Appointment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus
Appointment.cancelationReason	required	AppointmentCancellationReason
Appointment.serviceCategory	example	ServiceCategory
Appointment.serviceType	example	ServiceType
Appointment.specialty	required	CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
Appointment.appointmentType	required	EncounterType
Appointment.reasonCode	preferred	EncounterReasonCodes
Appointment.participant.type	extensible	ParticipantType
Appointment.participant.required	required	ParticipantRequired
Appointment.participant.status	required	ParticipationStatus
Appointment.participant:location.type	extensible	ParticipantType
Appointment.participant:location.required	required	ParticipantRequired
Appointment.participant:location.status	required	ParticipationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
app-1	error	Appointment.participant, Appointment.participant:location	Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists()
dom-r4b	warning	Appointment.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

Summary

Mandatory: 11 elements

Structures

This structure refers to these other structures:

• Schedule (https://ancode.app/fhir/StructureDefinition/Schedule)
• Coverage (https://ancode.app/fhir/StructureDefinition/Coverage)
• Location (https://ancode.app/fhir/StructureDefinition/Location)

Extensions

This structure refers to these extensions:

• https://ancode.app/fhir/StructureDefinition/AccidentIndicator
• https://ancode.app/fhir/StructureDefinition/EncounterClass
• https://ancode.app/fhir/StructureDefinition/NewbornCare
• https://ancode.app/fhir/StructureDefinition/OutpatientType
• https://ancode.app/fhir/StructureDefinition/HospitalizationType
• https://ancode.app/fhir/StructureDefinition/ChemotherapyIndicator

Slices

This structure defines the following Slices:

• The element Appointment.supportingInformation is sliced based on the value of type:type
• The element Appointment.participant is sliced based on the value of value:actor.type