MED - Local Development build (v0.1.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: AppointmentMED

Appointment Profile, for Medicaia interoperability scenarios, based on the International CORE Appointment Profile defined by HL7.

Usage:

• Use this Resource Profile: BundleOutpatientEncounterMED
• Refer to this Resource Profile: DocumentReferenceMED and EncounterMED
• Examples for this Resource Profile: Appointment/AppointmentExample001

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			Appointment
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Extension_AttentionType		1..1	code	The specific appointment type: V = 'Virtual' | P = 'Presencial' URL: https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType Binding: Attention Type (required)
identifier		1..*	Identifier	External Ids for this item
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
assigner		1..1	Reference(OrganizationMED)	Organization that issued id (may be just text)
cancelationReason		0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppCancellationReasonCS
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
serviceCategory		1..1	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Service Category (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/ServiceCategoryCS
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
serviceType		0..0
appointmentType		1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppointmentTypeCS
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
reasonCode		1..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Reason Codes (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
start		1..1	instant	When appointment is to take place
created		1..1	dateTime	The date that this appointment was initially created
participant
type		0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (required): Role of participant in encounter.
actor		0..1	Reference(PatientMED | PractitionerRoleMED | HealthcareServiceMED)	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.cancelationReason	required	AppCancellationReasonVS (a valid code from Appointment Cancellation Reason) https://fhir.medicaia.ar/ValueSet/AppCancellationReasonVS from this IG
Appointment.serviceCategory	required	ServiceCategoryVS (a valid code from Service Category) https://fhir.medicaia.ar/ValueSet/ServiceCategoryVS from this IG
Appointment.appointmentType	required	AppointmentTypeVS (a valid code from Appointment Type) https://fhir.medicaia.ar/ValueSet/AppointmentTypeVS from this IG
Appointment.reasonCode	required	ReasonCodeVS https://fhir.medicaia.ar/ValueSet/ReasonCodeVS from this IG
Appointment.participant.type	required	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard

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		1..*	Extension	Extension Slice: Unordered, Open by value:url
Extension_AttentionType	S	1..1	code	The specific appointment type: V = 'Virtual' | P = 'Presencial' URL: https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType Binding: Attention Type (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External Ids for this item
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	1..1	Reference(OrganizationMED)	Organization that issued id (may be just text)
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: Appointment Cancellation Reason (required)
serviceCategory	Σ	1..1	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Service Category (required)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type (required)
reasonCode	Σ	1..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Reason Codes (required)
start	Σ	1..1	instant	When appointment is to take place
created		1..1	dateTime	The date that this appointment was initially created
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
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (required): Role of participant in encounter.
actor	Σ	0..1	Reference(PatientMED | PractitionerRoleMED | HealthcareServiceMED)	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.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	required	AppCancellationReasonVS (a valid code from Appointment Cancellation Reason) https://fhir.medicaia.ar/ValueSet/AppCancellationReasonVS from this IG
Appointment.serviceCategory	required	ServiceCategoryVS (a valid code from Service Category) https://fhir.medicaia.ar/ValueSet/ServiceCategoryVS from this IG
Appointment.appointmentType	required	AppointmentTypeVS (a valid code from Appointment Type) https://fhir.medicaia.ar/ValueSet/AppointmentTypeVS from this IG
Appointment.reasonCode	required	ReasonCodeVS https://fhir.medicaia.ar/ValueSet/ReasonCodeVS from this IG
Appointment.participant.type	required	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type 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()

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Extension_AttentionType	S	1..1	code	The specific appointment type: V = 'Virtual' | P = 'Presencial' URL: https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType Binding: Attention Type (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(OrganizationMED)	Organization that issued id (may be just text)
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: Appointment Cancellation Reason (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppCancellationReasonCS
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
serviceCategory	Σ	1..1	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Service Category (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/ServiceCategoryCS
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppointmentTypeCS
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
reasonCode	Σ	1..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Reason Codes (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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	Σ	1..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(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
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 (required): Role of participant in encounter.
actor	Σ	0..1	Reference(PatientMED | PractitionerRoleMED | HealthcareServiceMED)	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.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Appointment.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Appointment.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	required	AppCancellationReasonVS (a valid code from Appointment Cancellation Reason) https://fhir.medicaia.ar/ValueSet/AppCancellationReasonVS from this IG
Appointment.serviceCategory	required	ServiceCategoryVS (a valid code from Service Category) https://fhir.medicaia.ar/ValueSet/ServiceCategoryVS from this IG
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	required	AppointmentTypeVS (a valid code from Appointment Type) https://fhir.medicaia.ar/ValueSet/AppointmentTypeVS from this IG
Appointment.reasonCode	required	ReasonCodeVS https://fhir.medicaia.ar/ValueSet/ReasonCodeVS from this IG
Appointment.participant.type	required	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

Mandatory: 11 elements(12 nested mandatory elements)
Fixed: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• OrganizationMED (https://fhir.medicaia.ar/StructureDefinition/OrganizationMED)
• PatientMED (https://fhir.medicaia.ar/StructureDefinition/PatientMED)
• PractitionerRoleMED (https://fhir.medicaia.ar/StructureDefinition/PractitionerRoleMED)
• HealthcareServiceMED (https://fhir.medicaia.ar/StructureDefinition/HealthcareServiceMED)

Extensions

This structure refers to these extensions:

• https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType

Differential View

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
Appointment			Appointment
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Extension_AttentionType		1..1	code	The specific appointment type: V = 'Virtual' | P = 'Presencial' URL: https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType Binding: Attention Type (required)
identifier		1..*	Identifier	External Ids for this item
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
assigner		1..1	Reference(OrganizationMED)	Organization that issued id (may be just text)
cancelationReason		0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppCancellationReasonCS
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
serviceCategory		1..1	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Service Category (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/ServiceCategoryCS
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
serviceType		0..0
appointmentType		1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppointmentTypeCS
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
reasonCode		1..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Reason Codes (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
start		1..1	instant	When appointment is to take place
created		1..1	dateTime	The date that this appointment was initially created
participant
type		0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (required): Role of participant in encounter.
actor		0..1	Reference(PatientMED | PractitionerRoleMED | HealthcareServiceMED)	Person, Location/HealthcareService or Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.cancelationReason	required	AppCancellationReasonVS (a valid code from Appointment Cancellation Reason) https://fhir.medicaia.ar/ValueSet/AppCancellationReasonVS from this IG
Appointment.serviceCategory	required	ServiceCategoryVS (a valid code from Service Category) https://fhir.medicaia.ar/ValueSet/ServiceCategoryVS from this IG
Appointment.appointmentType	required	AppointmentTypeVS (a valid code from Appointment Type) https://fhir.medicaia.ar/ValueSet/AppointmentTypeVS from this IG
Appointment.reasonCode	required	ReasonCodeVS https://fhir.medicaia.ar/ValueSet/ReasonCodeVS from this IG
Appointment.participant.type	required	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard

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		1..*	Extension	Extension Slice: Unordered, Open by value:url
Extension_AttentionType	S	1..1	code	The specific appointment type: V = 'Virtual' | P = 'Presencial' URL: https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType Binding: Attention Type (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External Ids for this item
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	1..1	Reference(OrganizationMED)	Organization that issued id (may be just text)
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: Appointment Cancellation Reason (required)
serviceCategory	Σ	1..1	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Service Category (required)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type (required)
reasonCode	Σ	1..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Reason Codes (required)
start	Σ	1..1	instant	When appointment is to take place
created		1..1	dateTime	The date that this appointment was initially created
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
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (required): Role of participant in encounter.
actor	Σ	0..1	Reference(PatientMED | PractitionerRoleMED | HealthcareServiceMED)	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.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	required	AppCancellationReasonVS (a valid code from Appointment Cancellation Reason) https://fhir.medicaia.ar/ValueSet/AppCancellationReasonVS from this IG
Appointment.serviceCategory	required	ServiceCategoryVS (a valid code from Service Category) https://fhir.medicaia.ar/ValueSet/ServiceCategoryVS from this IG
Appointment.appointmentType	required	AppointmentTypeVS (a valid code from Appointment Type) https://fhir.medicaia.ar/ValueSet/AppointmentTypeVS from this IG
Appointment.reasonCode	required	ReasonCodeVS https://fhir.medicaia.ar/ValueSet/ReasonCodeVS from this IG
Appointment.participant.type	required	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type 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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Appointment	C	0..*	Appointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Extension_AttentionType	S	1..1	code	The specific appointment type: V = 'Virtual' | P = 'Presencial' URL: https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType Binding: Attention Type (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(OrganizationMED)	Organization that issued id (may be just text)
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: Appointment Cancellation Reason (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppCancellationReasonCS
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
serviceCategory	Σ	1..1	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: Service Category (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/ServiceCategoryCS
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType	Σ	1..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: Appointment Type (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.medicaia.ar/CodeSystem/AppointmentTypeCS
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
reasonCode	Σ	1..1	CodeableConcept	Coded reason this appointment is scheduled Binding: Reason Codes (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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	Σ	1..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(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
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 (required): Role of participant in encounter.
actor	Σ	0..1	Reference(PatientMED | PractitionerRoleMED | HealthcareServiceMED)	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.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Appointment.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Appointment.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	required	AppCancellationReasonVS (a valid code from Appointment Cancellation Reason) https://fhir.medicaia.ar/ValueSet/AppCancellationReasonVS from this IG
Appointment.serviceCategory	required	ServiceCategoryVS (a valid code from Service Category) https://fhir.medicaia.ar/ValueSet/ServiceCategoryVS from this IG
Appointment.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
Appointment.appointmentType	required	AppointmentTypeVS (a valid code from Appointment Type) https://fhir.medicaia.ar/ValueSet/AppointmentTypeVS from this IG
Appointment.reasonCode	required	ReasonCodeVS https://fhir.medicaia.ar/ValueSet/ReasonCodeVS from this IG
Appointment.participant.type	required	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

Mandatory: 11 elements(12 nested mandatory elements)
Fixed: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• OrganizationMED (https://fhir.medicaia.ar/StructureDefinition/OrganizationMED)
• PatientMED (https://fhir.medicaia.ar/StructureDefinition/PatientMED)
• PractitionerRoleMED (https://fhir.medicaia.ar/StructureDefinition/PractitionerRoleMED)
• HealthcareServiceMED (https://fhir.medicaia.ar/StructureDefinition/HealthcareServiceMED)

Extensions

This structure refers to these extensions:

• https://fhir.medicaia.ar/StructureDefinition/Extension-AttentionType

Other representations of profile: CSV, Excel, Schematron