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.

TypedFhir API / Python

The typed accessor surface Appointment exposes for Appointment — generated from this IG's compiled profile; each typed accessor has a validating raw-FHIR twin (xRaw) where marked. The three ports are parity-enforced.

class Appointment(ClinicalResource)generated source

Accessor Type Access Notes
effective_date FuzzyDate | None read-only The resource's effective date — the first present of this profile's date elements (precedence), normalized to the canonical FuzzyDatetime f…
display str | None read-only The resource's human headline — a coded concept's label, else a title / name, else undefined.
status str | None read/write Where the appointment is in its lifecycle
cancelation_reason Concept | None read/write · raw twin The coded reason for the appointment being cancelled
service_category Concepts read/write · raw twin Service category with raw code support
service_type Concepts read/write · raw twin Service type with raw code support
specialty Concepts read/write · raw twin The specialty of a practitioner that would be required to perform the service requested in this appointment
appointment_type Concept | None read/write · raw twin Appointment type with raw code support
reason_code Concepts read/write · raw twin Appointment reason with raw code support
start FuzzyDate | None read/write When appointment is to take place - Maps to A12_Last Visit Date
slot References read/write · raw twin Slot(s) this appointment was booked into
created FuzzyDate | None read/write When the appointment record was initially created
participant dict[] | None read/write Participants involved in appointment