Skip to main content

AppointmentResponse

ResourceBase · WorkflowTrial useMaturity 3

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
7 of 7 parameters tested

Structure​

ElementCard.TypeDescription
identifierΣ
0..*IdentifierExternal Ids for this item
appointmentRequiredΣ
1..1Reference(Appointment)Appointment this response relates to
start
0..1instantTime from appointment, or requested new start time
end
0..1instantTime from appointment, or requested new end time
participantTypeΣ
0..*CodeableConceptRole of participant in the appointmentBinding (extensible): encounter-participant-type
actorΣ
0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)Person, Location, HealthcareService, or Device
participantStatusRequired?!Σ
1..1codeaccepted | declined | tentative | needs-actionBinding (required): participationstatus
comment
0..1stringAdditional comments

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/AppointmentResponse?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
actorreference

The Person, Location/HealthcareService or Device that this appointment response replies for

AppointmentResponse.actor
appointmentreference

The appointment that the response is attached to

AppointmentResponse.appointment
identifiertoken

An Identifier in this appointment response

AppointmentResponse.identifier
locationreference

This Response is for this Location

AppointmentResponse.actor.where(resolve() is Location)
part-statustoken

The participants acceptance status for this appointment

AppointmentResponse.participantStatus
patientreference

This Response is for this Patient

AppointmentResponse.actor.where(resolve() is Patient)
practitionerreference

This Response is for this Practitioner

AppointmentResponse.actor.where(resolve() is Practitioner)

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition