Appointment class

Appointment A booking of a healthcare event among patient(s),

Mixed in types

• Resource

Annotations

• @freezed

Constructors

Appointment({@Default(R4ResourceType.Appointment) @JsonKey(unknownEnumValue: R4ResourceType.Appointment) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? 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? cancelationReason, List<CodeableConcept>? serviceCategory, List<CodeableConcept>? serviceType, List<CodeableConcept>? specialty, CodeableConcept? appointmentType, List<CodeableConcept>? reasonCode, List<Reference>? reasonReference, FhirUnsignedInt? priority, @JsonKey(name: '_priority') Element? priorityElement, String? description, @JsonKey(name: '_description') Element? descriptionElement, List<Reference>? supportingInformation, FhirInstant? start, @JsonKey(name: '_start') Element? startElement, FhirInstant? end, @JsonKey(name: '_end') Element? endElement, FhirPositiveInt? minutesDuration, @JsonKey(name: '_minutesDuration') Element? minutesDurationElement, List<Reference>? slot, FhirDateTime? created, @JsonKey(name: '_created') Element? createdElement, String? comment, @JsonKey(name: '_comment') Element? commentElement, String? patientInstruction, @JsonKey(name: '_patientInstruction') Element? patientInstructionElement, List<Reference>? basedOn, required List<AppointmentParticipant> participant, List<Period>? requestedPeriod})

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).

const

factory

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

appointmentType → CodeableConcept?

appointmentType The style of appointment or patient that has been booked in the slot (not service type).

no setter, inherited

basedOn → List<Reference>?

basedOn The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

no setter, inherited

cancelationReason → CodeableConcept?

cancelationReason 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 setter, inherited

comment → String?

comment Additional comments about the appointment.

no setter, inherited

commentElement → Element?

commentElement Extensions for comment

no setter, inherited

contained → List<Resource>?

contained These 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.

no setter, inherited

copyWith → $AppointmentCopyWith<Appointment>

no setter, inherited

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 setter, inherited

createdElement → Element?

createdElement Extensions for created

no setter, inherited

dbId → int?

no setter, inherited

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 comment field.

no setter, inherited

descriptionElement → Element?

descriptionElement Extensions for description

no setter, inherited

end → FhirInstant?

end Date/Time that the appointment is to conclude.

no setter, inherited

endElement → Element?

endElement Extensions for end

no setter, inherited

extension_ → List<FhirExtension>?

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 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.

no setter, inherited

fhirId → String?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

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 setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

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 setter, inherited

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 setter, inherited

minutesDurationElement → Element?

minutesDurationElement Extensions for minutesDuration

no setter, inherited

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 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).

no setter, inherited

participant → List<AppointmentParticipant>

participant List of participants involved in the appointment.

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

patientInstruction → String?

patientInstruction While 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).

no setter, inherited

patientInstructionElement → Element?

patientInstructionElement Extensions for patientInstruction

no setter, inherited

priority → FhirUnsignedInt?

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 setter, inherited

priorityElement → Element?

priorityElement Extensions for priority

no setter, inherited

reasonCode → List<CodeableConcept>?

reasonCode The coded reason that this appointment is being scheduled. This is more clinical than administrative.

no setter, inherited

reasonReference → List<Reference>?

reasonReference 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.

no setter, inherited

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 setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceCategory → List<CodeableConcept>?

serviceCategory A broad categorization of the service that is to be performed during this appointment.

no setter, inherited

serviceType → List<CodeableConcept>?

serviceType The specific service that is to be performed during this appointment.

no setter, inherited

slot → List<Reference>?

slot The slots from the participants' schedules that will be filled by the appointment.

no setter, inherited

specialty → List<CodeableConcept>?

specialty The specialty of a practitioner that would be required to perform the service requested in this appointment.

no setter, inherited

start → FhirInstant?

start Date/Time that the appointment is to take place.

no setter, inherited

startElement → Element?

startElement Extensions for start

no setter, inherited

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 setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

supportingInformation → List<Reference>?

supportingInformation Additional information to support the appointment provided when making the appointment.

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

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

inherited

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