Cardea
cardea.fhir.
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).
resourceType – This is a Appointment resource
identifier – This 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).
status – The 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.
serviceCategory – A broad categorisation of the service that is to be performed during this appointment.
serviceType – The specific service that is to be performed during this appointment.
specialty – The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentType – The style of appointment or patient that has been booked in the slot (not service type).
reason – The reason that this appointment is being scheduled. This is more clinical than administrative.
indication – Reason 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.
priority – The 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).
description – The 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.
supportingInformation – Additional information to support the appointment provided when making the appointment.
start – Date/Time that the appointment is to take place.
end – Date/Time that the appointment is to conclude.
minutesDuration – Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
slot – The slots from the participants’ schedules that will be filled by the appointment.
created – The 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.
comment – Additional comments about the appointment.
incomingReferral – The referral request this appointment is allocated to assess (incoming referral).
participant – List of participants involved in the appointment.
requestedPeriod – A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.
__init__
Initialize self. See help(type(self)) for accurate signature.
Methods
__init__([dict_values])
Initialize self.
assert_type()
assert_type
Checks class values follow set possible enumerations.
get_dataframe()
get_dataframe
Returns dataframe from class attribute values.
get_eligible_relationships()
get_eligible_relationships
Returns class relationships for attributes that are used.
get_id()
get_id
Returns fhir class identifier.
get_relationships()
get_relationships
Returns class relationships.
set_attributes(dict_values)
set_attributes
Sets values to class attributes.