Skip to content

Appointment Response Profile

Canonical../StructureDefinition/nexus-appointment-response
Statusdraft · 1.26.0
BaseAppointmentResponse (constraint)
SourceFSH · JSON

A participant's answer to a booking: whether the person an appointment is for has accepted it, is still deciding, or has declined. Written by an integrating system outside the EMR and read wherever a booking's confirmation state is displayed, which is derived from participantStatus rather than from Appointment.status. An answer supersedes an earlier answer rather than amending it, and the latest one describes where the booking stands.

Elements / Snapshot

The full effective definition: base AppointmentResponse with this profile's constraints applied.

Element Flags Card. Type Description & Constraints
AppointmentResponse 0..* A participant's answer to a booking
Invariants: apr-1, dom-2, dom-3, dom-4, dom-5, dom-6
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
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 the answer i
Invariants: ele-1
appointment S 1..1 Reference(Appointment Profile) The appointment this answers
Invariants: ele-1
start 0..1 instant Time from appointment, or requested new start time i
Invariants: ele-1
end 0..1 instant Time from appointment, or requested new end time
Invariants: ele-1
participantType 0..* CodeableConcept Role of participant in the appointment i
Binding: encounter-participant-type (extensible)
Invariants: ele-1
actor S 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) The party whose answer this is i
Invariants: ele-1
participantStatus S ?! 1..1 code accepted | declined | tentative | needs-action i
Binding: participationstatus (required)
Invariants: ele-1
comment 0..1 string Additional comments i
Invariants: ele-1