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 / Snapshot
The full effective definition: base Appointment with this profile's constraints applied.
| 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 |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| versionId | 0..1 | id | Version specific identifier i Invariants: ele-1 |
|
| lastUpdated | 0..1 | instant | When the resource version last changed i Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| profile | 0..* | canonical | Profiles this resource claims to conform to i Invariants: ele-1 |
|
| security | 0..* | Coding | Security Labels applied to this resource i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| tag | 0..* | Coding | Tags applied to this resource i Binding: common-tags ( example)Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | S | 0..1 | Narrative | Narrative i Invariants: ele-1 |
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| identifier | S | 0..* | Identifier | Business identifier(s) for appointment i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| type | 0..1 | CodeableConcept | Description of identifier i Binding: identifier-type ( extensible)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 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) i Invariants: ele-1 |
|
| status | S ?! | 1..1 | code | Where the appointment is in its lifecycle i Binding: appointmentstatus ( required)Invariants: ele-1 |
| cancelationReason | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: appointment-cancellation-reason ( example)Invariants: ele-1 |
|
| serviceCategory | S | 0..* | CodeableConcept | Service category with raw code support i Binding: service-category ( example)Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 0..* | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Invariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| serviceType | S | 0..* | CodeableConcept | Service type with raw code support i Binding: service-type ( example)Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 0..* | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Invariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| specialty | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: c80-practice-codes ( preferred)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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 0..* | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Standard terminology URI, or ../NamingSystem/<instance-id>-appointment-reasoncode-raw-code iInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) Invariants: ele-1 |
|
| priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize i Invariants: ele-1 |
|
| description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list Invariants: ele-1 |
|
| supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment Invariants: ele-1 |
|
| start | S | 1..1 | instant | When appointment is to take place - Maps to A12_Last Visit Date i Invariants: ele-1 |
| end | 0..1 | instant | When appointment is to conclude Invariants: ele-1 |
|
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) 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 |
| comment | 0..1 | string | Additional comments i Invariants: ele-1 |
|
| patientInstruction | 0..1 | string | Detailed information and instructions for the patient Invariants: ele-1 |
|
| basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess Invariants: ele-1 |
|
| participant | S | 1..* | BackboneElement | Participants involved in appointment i Invariants: app-1, ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-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 |
| required | 0..1 | code | required | optional | information-only Binding: participantrequired ( required)Invariants: ele-1 |
|
| status | 1..1 | code | accepted | declined | tentative | needs-action Binding: participationstatus ( required)Invariants: ele-1 |
|
| period | 0..1 | Period | Participation period of the actor Invariants: ele-1 |
|
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| start | S | 0..1 | dateTime | Requested date/time for appointment i Invariants: ele-1 |
| end | 0..1 | dateTime | End time with inclusive boundary, if not ongoing i Invariants: ele-1 |