Release 5 Ballot

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

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

Search Parameter Registry for the schedule 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/Schedule-active

Parameter active:token

Is the schedule in active use

ResourceSchedule
ExpressionSchedule.active
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Schedule-actor

Parameter actor:reference

The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for

ResourceSchedule
ExpressionSchedule.actor
Target ResourcesPractitioner, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Schedule-date

Parameter date:date

Search for Schedule resources that have a period that contains this date specified

ResourceSchedule
ExpressionSchedule.planningHorizon
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Schedule-identifier

Parameter identifier:token

A Schedule Identifier

ResourceSchedule
ExpressionSchedule.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Schedule-name

Parameter name:string

A portion of the Schedule name

ResourceSchedule
ExpressionSchedule.name
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Schedule-service-category

Parameter service-category:token

High-level category

ResourceSchedule
ExpressionSchedule.serviceCategory
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Schedule-service-type

Parameter service-type:token

The type (by coding) of appointments that can be booked into associated slot(s)

ResourceSchedule
ExpressionSchedule.serviceType.concept
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Schedule-service-type-reference

Parameter service-type-reference:reference

The type (by HealthcareService) of appointments that can be booked into associated slot(s)

ResourceSchedule
ExpressionSchedule.serviceType.reference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Schedule-specialty

Parameter specialty:token

Type of specialty needed

ResourceSchedule
ExpressionSchedule.specialty
MultiplesThe parameter cannot repeat or have multiple values