FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Administration icon Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Patient Compartments: Device, Patient, Practitioner, RelatedPerson

Search Parameter Registry for the appointment resource

Search parameter list for 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

Parameter actor:reference

Any one of the individuals participating in the appointment

ResourceAppointment
ExpressionAppointment.participant.actor
Target ResourcesPractitioner, Group, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-appointment-type

Parameter appointment-type:token

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

ResourceAppointment
ExpressionAppointment.appointmentType
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-based-on

Parameter based-on:reference

The service request this appointment is allocated to assess

ResourceAppointment
ExpressionAppointment.basedOn
Target ResourcesCarePlan, MedicationRequest, DeviceRequest, ServiceRequest
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-date

Parameter date:date

Appointment date/time.

ResourceAppointment
Expression(start | requestedPeriod.start).first()
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Appointment-group

Parameter group:reference

One of the individuals of the appointment is this patient

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)
Target ResourcesGroup
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-identifier

Parameter identifier:token

An Identifier of the Appointment

ResourceAppointment
ExpressionAppointment.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-location

Parameter location:reference

This location is listed in the participants of the appointment

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Location)
Target ResourcesLocation
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-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.

ResourceAppointment
ExpressionAppointment.participant.status
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-patient

Parameter patient:reference

One of the individuals of the appointment is this patient

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient)
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-practitioner

Parameter practitioner:reference

One of the individuals of the appointment is this practitioner

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Practitioner)
Target ResourcesPractitioner
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-reason-code

Parameter reason-code:token

Reference to a concept (by class)

ResourceAppointment
ExpressionAppointment.reason.concept
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-reason-reference

Parameter reason-reference:reference

Reference to a resource (by instance)

ResourceAppointment
ExpressionAppointment.reason.reference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-requested-period

Parameter requested-period:date

During what period was the Appointment requested to take place

ResourceAppointment
ExpressionrequestedPeriod
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Appointment-service-category

Parameter service-category:token

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

ResourceAppointment
ExpressionAppointment.serviceCategory
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-service-type

Parameter service-type:token

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

ResourceAppointment
ExpressionAppointment.serviceType.concept
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-service-type-reference

Parameter service-type-reference:reference

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

ResourceAppointment
ExpressionAppointment.serviceType.reference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-slot

Parameter slot:reference

The slots that this appointment is filling

ResourceAppointment
ExpressionAppointment.slot
Target ResourcesSlot
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-specialty

Parameter specialty:token

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

ResourceAppointment
ExpressionAppointment.specialty
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-status

Parameter status:token

The overall status of the appointment

ResourceAppointment
ExpressionAppointment.status
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-subject

Parameter subject:reference

One of the individuals of the appointment is this patient

ResourceAppointment
ExpressionAppointment.subject
Target ResourcesGroup, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Appointment-supporting-info

Parameter supporting-info:reference

Additional information to support the appointment

ResourceAppointment
ExpressionAppointment.supportingInformation
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values