R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

12.16.13 Resource Schedule - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Business Compartments: Device, Patient, Practitioner, RelatedPerson

Search parameters for the Resource Schedule - 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/Schedule-active

12.16.14 active

Parameter active:token

Is the schedule in active use

ResourceSchedule
ExpressionSchedule.active
Processing ModeNormal
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/Schedule-actor

12.16.15 actor

Parameter actor:reference

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

ResourceSchedule
ExpressionSchedule.actor
Processing ModeNormal
Target ResourcesHealthcareService, CareTeam, Device, RelatedPerson, PractitionerRole, Practitioner, Location, Patient
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/Schedule-date

12.16.16 date

Parameter date:date

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

ResourceSchedule
ExpressionSchedule.planningHorizon
Processing ModeNormal
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
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Schedule-identifier

12.16.17 identifier

Parameter identifier:token

A Schedule Identifier

ResourceSchedule
ExpressionSchedule.identifier
Processing ModeNormal
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/Schedule-name

12.16.18 name

Parameter name:string

A portion of the Schedule name

ResourceSchedule
ExpressionSchedule.name
Processing ModeNormal
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/Schedule-service-category

12.16.19 service-category

Parameter service-category:token

High-level category

ResourceSchedule
ExpressionSchedule.serviceCategory
Processing ModeNormal
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/Schedule-service-type

12.16.20 service-type

Parameter service-type:token

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

ResourceSchedule
ExpressionSchedule.serviceType.concept
Processing ModeNormal
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/Schedule-service-type-reference

12.16.21 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
Processing ModeNormal
Target ResourcesHealthcareService
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/Schedule-specialty

12.16.22 specialty

Parameter specialty:token

Type of specialty needed

ResourceSchedule
ExpressionSchedule.specialty
Processing ModeNormal
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