Appointment - FHIR v5.0.0-draft-final

R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

12.14.14 Resource Appointment - Search Parameters

Patient Administration icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Patient

Compartments: Device, Patient, Practitioner, RelatedPerson

Search parameters for the Resource Appointment - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/Appointment-actor

12.14.15 actor

Parameter actor:reference

Any one of the individuals participating in the appointment

Resource Appointment

Expression Appointment.participant.actor

Processing Mode Normal

Target Resources HealthcareService, CareTeam, Device, RelatedPerson, PractitionerRole, Group, Practitioner, Location, Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-appointment-type

12.14.16 appointment-type

Parameter appointment-type:token

The style of appointment or patient that has been booked in the slot (not service type)

Resource Appointment

Expression Appointment.appointmentType

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-based-on

12.14.17 based-on

Parameter based-on:reference

The service request this appointment is allocated to assess

Resource Appointment

Expression Appointment.basedOn

Processing Mode Normal

Target Resources DeviceRequest, ServiceRequest, CarePlan, MedicationRequest

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/clinical-date

This search parameter is part of the common search parameter clinical-date

12.14.18 date

Parameter date:date

Appointment: Appointment date/time.

Resource Appointment

Expression (start | requestedPeriod.start).first()

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Appointment-group

12.14.19 group

Parameter group:reference

One of the individuals of the appointment is this patient

Resource Appointment

Expression Appointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)

Processing Mode Normal

Target Resources Group

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/clinical-identifier

This search parameter is part of the common search parameter clinical-identifier

12.14.20 identifier

Parameter identifier:token

Appointment: An Identifier of the Appointment

Resource Appointment

Expression Appointment.identifier

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-location

12.14.21 location

Parameter location:reference

This location is listed in the participants of the appointment

Resource Appointment

Expression Appointment.participant.actor.where(resolve() is Location)

Processing Mode Normal

Target Resources Location

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-part-status

12.14.22 part-status

Parameter part-status:token

The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.

Resource Appointment

Expression Appointment.participant.status

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/clinical-patient

This search parameter is part of the common search parameter clinical-patient

12.14.23 patient

Parameter patient:reference

Appointment: One of the individuals of the appointment is this patient

Resource Appointment

Expression Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient)

Processing Mode Normal

Target Resources Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-practitioner

12.14.24 practitioner

Parameter practitioner:reference

One of the individuals of the appointment is this practitioner

Resource Appointment

Expression Appointment.participant.actor.where(resolve() is Practitioner)

Processing Mode Normal

Target Resources Practitioner

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-reason-code

12.14.25 reason-code

Parameter reason-code:token

Reference to a concept (by class)

Resource Appointment

Expression Appointment.reason.concept

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-reason-reference

12.14.26 reason-reference

Parameter reason-reference:reference

Reference to a resource (by instance)

Resource Appointment

Expression Appointment.reason.reference

Processing Mode Normal

Target Resources Procedure, Observation, ImmunizationRecommendation, Condition

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-requested-period

12.14.27 requested-period

Parameter requested-period:date

During what period was the Appointment requested to take place

Resource Appointment

Expression requestedPeriod

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Appointment-service-category

12.14.28 service-category

Parameter service-category:token

A broad categorization of the service that is to be performed during this appointment

Resource Appointment

Expression Appointment.serviceCategory

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-service-type

12.14.29 service-type

Parameter service-type:token

The specific service (by coding) that is to be performed during this appointment

Resource Appointment

Expression Appointment.serviceType.concept

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-service-type-reference

12.14.30 service-type-reference

Parameter service-type-reference:reference

The specific service (by HealthcareService) that is to be performed during this appointment

Resource Appointment

Expression Appointment.serviceType.reference

Processing Mode Normal

Target Resources HealthcareService

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-slot

12.14.31 slot

Parameter slot:reference

The slots that this appointment is filling

Resource Appointment

Expression Appointment.slot

Processing Mode Normal

Target Resources Slot

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-specialty

12.14.32 specialty

Parameter specialty:token

The specialty of a practitioner that would be required to perform the service requested in this appointment

Resource Appointment

Expression Appointment.specialty

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-status

12.14.33 status

Parameter status:token

The overall status of the appointment

Resource Appointment

Expression Appointment.status

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-subject

12.14.34 subject

Parameter subject:reference

One of the individuals of the appointment is this patient

Resource Appointment

Expression Appointment.subject

Processing Mode Normal

Target Resources Group, Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Appointment-supporting-info

12.14.35 supporting-info

Parameter supporting-info:reference

Additional information to support the appointment

Resource Appointment

Expression Appointment.supportingInformation

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values