Appointment Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-appointment |
|---|---|
| Status | draft · 1.26.0 |
| Base | Appointment (constraint) |
| Source | FSH · 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.
Elements / Key elements
The working view: must-support, required, modifier and sliced elements from the effective (snapshot) definition.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | 0..* | Nexus EMR Appointment Core Invariants: app-2, app-3, app-4, dom-2, dom-3, dom-4, dom-5, dom-6, appointment-participant-location, appointment-participant-patient, appointment-participant-practitioner |
||
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| text | S | 0..1 | Narrative | Narrative i Invariants: ele-1 |
| extension:modality | S | 0..1 | Extension(Appointment Modality Extension) | How the appointment is delivered i Invariants: ele-1, ext-1 |
| extension:createdBy | S | 0..1 | Extension(Appointment Created By Extension) | Who/what created the appointment (authoring user / system / self-booking patient) i Invariants: ele-1, ext-1 |
| identifier | S | 0..* | Identifier | Business identifier(s) for appointment i Invariants: ele-1 |
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| system | 1..1 | uri | The namespace for the identifier value i Invariants: ele-1 |
|
| value | 1..1 | string | The value that is unique i Invariants: ele-1 |
|
| status | S ?! | 1..1 | code | Where the appointment is in its lifecycle i Binding: appointmentstatus ( required)Invariants: ele-1 |
| serviceCategory | S | 0..* | CodeableConcept | Service category with raw code support i Binding: service-category ( example)Invariants: ele-1 |
| coding | 0..* | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| serviceType | S | 0..* | CodeableConcept | Service type with raw code support i Binding: service-type ( example)Invariants: ele-1 |
| coding | 0..* | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| appointmentType | S | 0..1 | CodeableConcept | Appointment type with raw code support i Binding: v2-0276 ( preferred)Invariants: ele-1 |
| reasonCode | S | 0..* | CodeableConcept | Appointment reason with raw code support i Binding: encounter-reason ( preferred)Invariants: ele-1 |
| coding | 0..* | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| system | 1..1 | uri | Standard terminology URI, or ../NamingSystem/<instance-id>-appointment-reasoncode-raw-code iInvariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| start | S | 1..1 | instant | When appointment is to take place - Maps to A12_Last Visit Date i Invariants: ele-1 |
| slot | S | 0..* | Reference(Slot Profile) | Slot(s) this appointment was booked into Invariants: ele-1 |
| created | S | 0..1 | dateTime | When the appointment record was initially created i Invariants: ele-1 |
| participant | S | 1..* | BackboneElement | Participants involved in appointment i Invariants: app-1, ele-1 |
| type | S | 0..* | CodeableConcept | Role the actor plays in this appointment i Binding: encounter-participant-type ( extensible)Invariants: ele-1 |
| actor | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device Invariants: ele-1 |
| status | 1..1 | code | accepted | declined | tentative | needs-action Binding: participationstatus ( required)Invariants: ele-1 |
|
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within i Invariants: ele-1 |
|
| start | S | 0..1 | dateTime | Requested date/time for appointment i Invariants: ele-1 |