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.16.13 12.15.13 Resource Schedule - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Administration icon Work Group   Trial Use Security 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 Generated Narrative: SearchParameter Schedule-active

12.15.14 active

Parameter active : token

Is the schedule in active use

Resource Schedule
Expression Schedule.active
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/Schedule-actor

12.16.15 Generated Narrative: SearchParameter Schedule-actor

12.15.15 actor

Parameter actor : reference

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

Resource Schedule
Expression Schedule.actor
Processing Mode Normal
Target Resources HealthcareService , CareTeam , Device , RelatedPerson , PractitionerRole , 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/Schedule-date

12.16.16 Generated Narrative: SearchParameter Schedule-date

12.15.16 date

Parameter date : date

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

Resource Schedule
Expression Schedule.planningHorizon
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/Schedule-identifier

12.16.17 Generated Narrative: SearchParameter Schedule-identifier

12.15.17 identifier

Parameter identifier : token

A Schedule Identifier

Resource Schedule
Expression Schedule.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/Schedule-name

12.16.18 Generated Narrative: SearchParameter Schedule-name

12.15.18 name

Parameter name : string

A portion of the Schedule name

Resource Schedule
Expression Schedule.name
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/Schedule-service-category

12.16.19 Generated Narrative: SearchParameter Schedule-service-category

12.15.19 service-category

Parameter service-category : token

High-level category

Resource Schedule
Expression Schedule.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/Schedule-service-type

12.16.20 Generated Narrative: SearchParameter Schedule-service-type

12.15.20 service-type

Parameter service-type : token

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

Resource Schedule
Expression Schedule.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/Schedule-service-type-reference

12.16.21 Generated Narrative: SearchParameter Schedule-service-type-reference

12.15.21 service-type-reference

Parameter service-type-reference : reference

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

Resource Schedule
Expression Schedule.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/Schedule-specialty

12.16.22 Generated Narrative: SearchParameter Schedule-specialty

12.15.22 specialty

Parameter specialty : token

Type of specialty needed

Resource Schedule
Expression Schedule.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