Appointment class
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).
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Appointment({@Default(R5ResourceType.Appointment) @JsonKey(unknownEnumValue: R5ResourceType.Appointment) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? cancellationReason, @JsonKey(name: 'class') List<CodeableConcept> ? class_, List<CodeableConcept> ? serviceCategory, List<CodeableReference> ? serviceType, List<CodeableConcept> ? specialty, CodeableConcept? appointmentType, List<CodeableReference> ? reason, CodeableConcept? priority, String? description, @JsonKey(name: '_description') Element? descriptionElement, List<Reference> ? replaces, List<VirtualServiceDetail> ? virtualService, List<Reference> ? supportingInformation, Reference? previousAppointment, Reference? originatingAppointment, FhirInstant? start, @JsonKey(name: '_start') Element? startElement, FhirInstant? end, @JsonKey(name: '_end') Element? endElement, FhirPositiveInt? minutesDuration, @JsonKey(name: '_minutesDuration') Element? minutesDurationElement, List<Period> ? requestedPeriod, List<Reference> ? slot, List<Reference> ? account, FhirDateTime? created, @JsonKey(name: '_created') Element? createdElement, FhirDateTime? cancellationDate, @JsonKey(name: '_cancellationDate') Element? cancellationDateElement, List<Annotation> ? note, List<CodeableReference> ? patientInstruction, List<Reference> ? basedOn, Reference? subject, required List<AppointmentParticipant> participant, FhirPositiveInt? recurrenceId, @JsonKey(name: '_recurrenceId') Element? recurrenceIdElement, FhirBoolean? occurrenceChanged, @JsonKey(name: '_occurrenceChanged') Element? occurrenceChangedElement, List<AppointmentRecurrenceTemplate> ? recurrenceTemplate}) -
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).
constfactory
-
Appointment.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Appointment.fromJsonString(String source)
-
Acts like a constructor, returns a Appointment, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Appointment.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
account
→ List<
Reference> ? -
account The set of accounts that is expected to be used for billing
the activities that result from this Appointment.
no setterinherited
- appointmentType → CodeableConcept?
-
appointmentType The style of appointment or patient that has been
booked in the slot (not service type).
no setterinherited
-
basedOn
→ List<
Reference> ? -
basedOn The request this appointment is allocated to assess (e.g.
incoming referral or procedure request).
no setterinherited
- cancellationDate → FhirDateTime?
-
cancellationDate The date/time describing when the appointment was
cancelled.
no setterinherited
- cancellationDateElement → Element?
-
cancellationDateElement ("_cancellationDate") Extensions for
cancellationDate
no setterinherited
- cancellationReason → CodeableConcept?
-
cancellationReason The 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.
no setterinherited
-
class_
→ List<
CodeableConcept> ? -
class_ ("class") Concepts representing classification of patient
encounter such as ambulatory (outpatient), inpatient, emergency, home
health or others due to local variations.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $AppointmentCopyWith<
Appointment> -
no setterinherited
- created → FhirDateTime?
-
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.
no setterinherited
- createdElement → Element?
-
createdElement ("_created") Extensions for created
no setterinherited
- dbId → int?
-
no setterinherited
- description → String?
-
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 note field.
no setterinherited
- descriptionElement → Element?
-
descriptionElement ("_description") Extensions for description
no setterinherited
- end → FhirInstant?
-
end Date/Time that the appointment is to conclude.
no setterinherited
- endElement → Element?
-
endElement ("_end") Extensions for end
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") May 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 managable, 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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
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).
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A 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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- meta → FhirMeta?
-
meta The 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.
no setterinherited
- minutesDuration → FhirPositiveInt?
-
minutesDuration Number 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.
no setterinherited
- minutesDurationElement → Element?
-
minutesDurationElement ("_minutesDuration") Extensions for
minutesDuration
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May 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 managable, 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).
no setterinherited
-
note
→ List<
Annotation> ? -
note Additional notes/comments about the appointment.
no setterinherited
- occurrenceChanged → FhirBoolean?
-
occurrenceChanged This appointment varies from the recurring pattern.
no setterinherited
- occurrenceChangedElement → Element?
-
occurrenceChangedElement ("_occurrenceChanged") Extensions for
occurrenceChanged
no setterinherited
- originatingAppointment → Reference?
-
originatingAppointment The originating appointment in a recurring set
of related appointments.
no setterinherited
-
participant
→ List<
AppointmentParticipant> -
participant List of participants involved in the appointment.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
patientInstruction
→ List<
CodeableReference> ? -
patientInstruction While Appointment.note 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).
no setterinherited
- previousAppointment → Reference?
-
previousAppointment The previous appointment in a series of related
appointments.
no setterinherited
- priority → CodeableConcept?
-
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).
no setterinherited
-
reason
→ List<
CodeableReference> ? -
reason The reason that this appointment is being scheduled. This is
more clinical than administrative. This can be coded, or 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.
no setterinherited
- recurrenceId → FhirPositiveInt?
-
recurrenceId The sequence number that identifies a specific
appointment in a recurring pattern.
no setterinherited
- recurrenceIdElement → Element?
-
recurrenceIdElement ("_recurrenceId") Extensions for recurrenceId
no setterinherited
-
recurrenceTemplate
→ List<
AppointmentRecurrenceTemplate> ? -
recurrenceTemplate The details of the recurrence pattern or template
that is used to generate recurring appointments.
no setterinherited
-
replaces
→ List<
Reference> ? -
replaces Appointment replaced by this Appointment in cases where
there is a cancellation, the details of the cancellation can be found
in the cancellationReason property (on the referenced resource).
no setterinherited
-
requestedPeriod
→ List<
Period> ? -
requestedPeriod A 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.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a Appointment resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serviceCategory
→ List<
CodeableConcept> ? -
serviceCategory A broad categorization of the service that is to be
performed during this appointment.
no setterinherited
-
serviceType
→ List<
CodeableReference> ? -
serviceType The specific service that is to be performed during this
appointment.
no setterinherited
-
slot
→ List<
Reference> ? -
slot The slots from the participants' schedules that will be filled
by the appointment.
no setterinherited
-
specialty
→ List<
CodeableConcept> ? -
specialty The specialty of a practitioner that would be required to
perform the service requested in this appointment.
no setterinherited
- start → FhirInstant?
-
start Date/Time that the appointment is to take place.
no setterinherited
- startElement → Element?
-
startElement ("_start") Extensions for start
no setterinherited
- status → FhirCode?
-
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.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- subject → Reference?
-
subject The patient or group associated with the appointment, if they
are to be present (usually) then they should also be included in the
participant backbone element.
no setterinherited
-
supportingInformation
→ List<
Reference> ? -
supportingInformation Additional information to support the
appointment provided when making the appointment.
no setterinherited
- text → Narrative?
-
text A 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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
-
virtualService
→ List<
VirtualServiceDetail> ? -
virtualService Connection details of a virtual service (e.g.
conference call).
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited