FHIR CI-Build

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

15.15.13 Resource Schedule - Search Parameters

Responsible Owner: Patient Administration icon Work Group NormativeSecurity Category: Business Compartments: Device, Patient, Practitioner, RelatedPerson

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

Generated Narrative: SearchParameter Schedule-active

15.15.14 active

Parameter active:token

Is the schedule in active use

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

Generated Narrative: SearchParameter Schedule-actor

15.15.15 actor

Parameter actor:reference

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

ResourceSchedule
Expression Schedule.actor
Processing Mode Normal
Target Resources HealthcareService, 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

Generated Narrative: SearchParameter Schedule-date

15.15.16 date

Parameter date:date

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

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

Generated Narrative: SearchParameter Schedule-identifier

15.15.17 identifier

Parameter identifier:token

A Schedule Identifier

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

Generated Narrative: SearchParameter Schedule-name

15.15.18 name

Parameter name:string

A portion of the Schedule name

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

Generated Narrative: SearchParameter Schedule-service-category

15.15.19 service-category

Parameter service-category:token

High-level category

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

Generated Narrative: SearchParameter Schedule-service-type

15.15.20 service-type

Parameter service-type:token

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

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

Generated Narrative: SearchParameter Schedule-service-type-reference

15.15.21 service-type-reference

Parameter service-type-reference:reference

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

ResourceSchedule
Expression Schedule.serviceType.reference
Processing Mode Normal
Target Resources HealthcareService
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

Generated Narrative: SearchParameter Schedule-specialty

15.15.22 specialty

Parameter specialty:token

Type of specialty needed

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