Skip to main content

Appointment

PropertyValue
Publisher
NameAppointment
URLhttp://hl7.org/fhir/StructureDefinition/Appointment
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Appointment0..*AppointmentA 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).
Appointment.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Appointment.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Appointment.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Appointment.language0..1codeThe base language in which the resource is written.
Appointment.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Appointment.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Appointment.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Appointment.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Appointment.identifier0..*IdentifierThis records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Appointment.status1..1codeThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
Appointment.cancelationReason0..1CodeableConceptThe coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
Appointment.serviceCategory0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment.
Appointment.serviceType0..*CodeableConceptThe specific service that is to be performed during this appointment.
Appointment.specialty0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment.
Appointment.appointmentType0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type).
Appointment.reasonCode0..*CodeableConceptThe coded reason that this appointment is being scheduled. This is more clinical than administrative.
Appointment.reasonReference0..*ReferenceReason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Appointment.priority0..1unsignedIntThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
Appointment.description0..1stringThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
Appointment.supportingInformation0..*ReferenceAdditional information to support the appointment provided when making the appointment.
Appointment.start0..1instantDate/Time that the appointment is to take place.
Appointment.end0..1instantDate/Time that the appointment is to conclude.
Appointment.minutesDuration0..1positiveIntNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
Appointment.slot0..*ReferenceThe slots from the participants' schedules that will be filled by the appointment.
Appointment.created0..1dateTimeThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
Appointment.comment0..1stringAdditional comments about the appointment.
Appointment.patientInstruction0..1stringWhile Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
Appointment.basedOn0..*ReferenceThe service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Appointment.participant1..*BackboneElementList of participants involved in the appointment.
Appointment.participant.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Appointment.participant.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Appointment.participant.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Appointment.participant.type0..*CodeableConceptRole of participant in the appointment.
Appointment.participant.actor0..1ReferenceA Person, Location/HealthcareService or Device that is participating in the appointment.
Appointment.participant.required0..1codeWhether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
Appointment.participant.status1..1codeParticipation status of the actor.
Appointment.participant.period0..1PeriodParticipation period of the actor.
Appointment.requestedPeriod0..*PeriodA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
actorreferenceAny one of the individuals participating in the appointmentAppointment.participant.actor
appointment-typetokenThe style of appointment or patient that has been booked in the slot (not service type)Appointment.appointmentType
based-onreferenceThe service request this appointment is allocated to assessAppointment.basedOn
datedateAppointment date/time.Appointment.start
identifiertokenAn Identifier of the AppointmentAppointment.identifier
locationreferenceThis location is listed in the participants of the appointmentAppointment.participant.actor.where(resolve() is Location)
part-statustokenThe Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.Appointment.participant.status
patientreferenceOne of the individuals of the appointment is this patientAppointment.participant.actor.where(resolve() is Patient)
practitionerreferenceOne of the individuals of the appointment is this practitionerAppointment.participant.actor.where(resolve() is Practitioner)
reason-codetokenCoded reason this appointment is scheduledAppointment.reasonCode
reason-referencereferenceReason the appointment is to take place (resource)Appointment.reasonReference
service-categorytokenA broad categorization of the service that is to be performed during this appointmentAppointment.serviceCategory
service-typetokenThe specific service that is to be performed during this appointmentAppointment.serviceType
slotreferenceThe slots that this appointment is fillingAppointment.slot
specialtytokenThe specialty of a practitioner that would be required to perform the service requested in this appointmentAppointment.specialty
statustokenThe overall status of the appointmentAppointment.status
supporting-inforeferenceAdditional information to support the appointmentAppointment.supportingInformation
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value