Interface: Appointment

SCH-derived appointment entry (SIU scheduling breadth). Surfaces the appointment identifiers, filler status (SCH-25, Table 0278), SCH-11 start/end timing, and the AI* resource groups. NOT a scheduling-workflow state machine.

Example

import type { Appointment } from "@cosyte/hl7";
const appt: Appointment = {
  fillerAppointmentId: "A1001",
  fillerStatusCode: { identifier: "Booked" },
  resources: [],
};

Properties

endDateTime?

readonly optional endDateTime?: DtmParts

Appointment end date/time: SCH-11 TQ.5 (fidelity TS).

---

fillerAppointmentId?

readonly optional fillerAppointmentId?: string

SCH-2 filler appointment ID (EI first component, verbatim).

---

fillerStatusCode?

readonly optional fillerStatusCode?: CWE

SCH-25 filler status code (HL7 Table 0278): the appointment status, verbatim/provenance-only.

---

placerAppointmentId?

readonly optional placerAppointmentId?: string

SCH-1 placer appointment ID (EI first component, verbatim).

---

resources

readonly resources: readonly AppointmentResource[]

AIS/AIG/AIL/AIP resources grouped under this SCH. Always present (possibly empty).

---

startDateTime?

readonly optional startDateTime?: DtmParts

Appointment start date/time: SCH-11 TQ.4 (fidelity TS).