Skip to content

Appointment Profile

Canonical../StructureDefinition/nexus-emr-core-appointment
Statusdraft · 1.26.0
BaseAppointment (constraint)
SourceFSH · JSON

Minimal Nexus EMR profile for Appointment resources, primarily for mapping status, start date (Last Visit Date), and required patient/practitioner participants. Assumes filtering for status='fulfilled' happens during data retrieval/processing. Contains embedded aliases and invariants.

Salient fields

The profile's synthesized-accessor contract: fields TypedFhir surfaces as first-class typed properties, each computed from the instance by a restricted FHIRPath expression. See Salient Fields for what they are, how they shape LLM contexts, and how to declare them.

Key Type Expression Rendered as Description
status code status Where the appointment is in its lifecycle i
start dateTime start When appointment is to take place - Maps to A12_Last Visit Date i
end dateTime end When appointment is to conclude
appointment_type coded appointmentType Appointment type with raw code support i
service_type coded serviceType Service type with raw code support i
reason_code coded reasonCode Appointment reason with raw code support i
description string description Shown on a subject line in a meeting request, or appointment list
cancelation_reason coded cancelationReason The coded reason for the appointment being cancelled

status

Short Where the appointment is in its lifecycle
Definition The overall status of the Appointment. Indicates confirmation status and attendance.
Comments Not all EMRs support a 'fulfilled' status. In those cases we will only have a 'booked', 'arrived' or 'checked in' status. For those consumers of FHIR data that are depending on this (including CPAR), a reasonable workaround is checking for fulfilled || ((booked || arrived || checked in) && before yesterday)
Expression status
Type code
Prose inherited from Appointment.status

start

Short When appointment is to take place - Maps to A12_Last Visit Date
Definition Date/Time that the appointment is scheduled to start.
Comments This is the scheduled start time, not necessarily when the patient was actually seen.
Expression start
Type dateTime
Prose inherited from Appointment.start

end

Short When appointment is to conclude
Definition Date/Time that the appointment is to conclude.
Expression end
Type dateTime
Prose inherited from Appointment.end

appointment_type

Short Appointment type with raw code support
Definition The style of appointment or patient that has been booked (e.g., routine, walk-in, checkup). RECOMMENDED: v2 Appointment Reason Codes or other standard terminology when available OPTIONAL: Raw EMR codes for source system preservation
Comments Where this code was mapped from a source system's own vocabulary, carry the raw coding alongside the mapped one, flagged userSelected = true. See Carrying the raw code.
Expression appointmentType
Type coded
Prose inherited from Appointment.appointmentType

service_type

Short Service type with raw code support
Definition The specific service that is to be performed during this appointment. RECOMMENDED: Standard terminology codes when available OPTIONAL: Raw EMR codes for source system preservation Where this code was mapped from a source system's own vocabulary, carry the raw coding alongside the mapped one, flagged userSelected = true. See Carrying the raw code.
Comments For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
Expression serviceType
Type coded
Prose inherited from Appointment.serviceType

reason_code

Short Appointment reason with raw code support
Definition Coded reason this appointment is scheduled. RECOMMENDED: Encounter Reason Codes or other standard terminology when available OPTIONAL: Raw EMR codes for source system preservation
Comments Where this code was mapped from a source system's own vocabulary, carry the raw coding alongside the mapped one, flagged userSelected = true. See Carrying the raw code.
Expression reasonCode
Type coded
Prose inherited from Appointment.reasonCode

description

Short Shown on a subject line in a meeting request, or appointment list
Definition 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.
Expression description
Type string
Prose inherited from Appointment.description

cancelation_reason

Short The coded reason for the appointment being cancelled
Definition 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.
Expression cancelationReason
Type coded
Prose inherited from Appointment.cancelationReason