Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

12.14.15 12.13.14 Resource Appointment - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Administration icon Work Group   Trial Use Normative Security Category : Patient Compartments : Device , Group , 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.16 Generated Narrative: SearchParameter Appointment-actor

12.13.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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-appointment-type

12.14.17 Generated Narrative: SearchParameter Appointment-appointment-type

12.13.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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-based-on

12.14.18 Generated Narrative: SearchParameter Appointment-based-on

12.13.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 RequestOrchestration , DeviceRequest , ServiceRequest , CarePlan , MedicationRequest , NutritionOrder , VisionPrescription
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

12.14.19 Generated Narrative: SearchParameter clinical-date

12.13.18 date

Parameter date : date

Appointment : Appointment date/time.

Resource Appointment
Expression (start | requestedPeriod.start).first()
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Appointment-group

12.14.20 Generated Narrative: SearchParameter Appointment-group

12.13.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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-has-recurrence-template

Generated Narrative: SearchParameter Appointment-has-recurrence-template

12.13.20 has-recurrence-template

Parameter has-recurrence-template : token

This Appointment contains a recurrence template

Resource Appointment
Expression Appointment.recurrenceTemplate.exists()
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

12.14.21 Generated Narrative: SearchParameter clinical-identifier

12.13.21 identifier

Parameter identifier : token

Appointment : An Identifier of the Appointment

Resource Appointment
Expression Appointment.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-is-recurring

Generated Narrative: SearchParameter Appointment-is-recurring

12.13.22 is-recurring

Parameter is-recurring : token

This Appointment is a part of a recurring series of appointments (has a template or an originating appointment)

Resource Appointment
Expression Appointment.recurrenceTemplate.exists() | Appointment.originatingAppointment.exists()
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-location

12.14.22 Generated Narrative: SearchParameter Appointment-location

12.13.23 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-occurrence-changed

Generated Narrative: SearchParameter Appointment-occurrence-changed

12.13.24 occurrence-changed

Parameter occurrence-changed : token

This Appointment has been changed from the recurrence template

Resource Appointment
Expression Appointment.occurrenceChanged
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-originating-appointment

Generated Narrative: SearchParameter Appointment-originating-appointment

12.13.25 originating-appointment

Parameter originating-appointment : reference

Reference to the Appointment that contains the recurrence template

Resource Appointment
Expression Appointment.originatingAppointment
Processing Mode Normal
Target Resources Appointment
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-part-status

12.14.23 Generated Narrative: SearchParameter Appointment-part-status

12.13.26 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

12.14.24 Generated Narrative: SearchParameter clinical-patient

12.13.27 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-practitioner

12.14.25 Generated Narrative: SearchParameter Appointment-practitioner

12.13.28 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-previous-appointment

Generated Narrative: SearchParameter Appointment-previous-appointment

12.13.29 previous-appointment

Parameter previous-appointment : reference

Reference to the Appointment that preceded this appointment in a series

Resource Appointment
Expression Appointment.previousAppointment
Processing Mode Normal
Target Resources Appointment
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-reason-code

12.14.26 Generated Narrative: SearchParameter Appointment-reason-code

12.13.30 reason-code

Parameter reason-code : token

Reference to a concept (by class)

Resource Appointment
Expression Appointment.reason.concept
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-reason-reference

12.14.27 Generated Narrative: SearchParameter Appointment-reason-reference

12.13.31 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 DiagnosticReport , Condition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-requested-period

12.14.28 Generated Narrative: SearchParameter Appointment-requested-period

12.13.32 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Appointment-service-category

12.14.29 Generated Narrative: SearchParameter Appointment-service-category

12.13.33 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-service-type

12.14.30 Generated Narrative: SearchParameter Appointment-service-type

12.13.34 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-service-type-reference

12.14.31 Generated Narrative: SearchParameter Appointment-service-type-reference

12.13.35 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-slot

12.14.32 Generated Narrative: SearchParameter Appointment-slot

12.13.36 slot

Parameter slot : reference

The slots that this appointment is filling

Resource Appointment
Expression Appointment.slot
Processing Mode Normal
Target Resources Slot
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-specialty

12.14.33 Generated Narrative: SearchParameter Appointment-specialty

12.13.37 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-status

12.14.34 Generated Narrative: SearchParameter Appointment-status

12.13.38 status

Parameter status : token

The overall status of the appointment

Resource Appointment
Expression Appointment.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-subject

12.14.35 Generated Narrative: SearchParameter Appointment-subject

12.13.39 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Appointment-supporting-info

12.14.36 Generated Narrative: SearchParameter Appointment-supporting-info

12.13.40 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true