FHIR CI-Build

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

12.14.15 Resource Appointment - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Device, 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 actor

Parameter actor:reference

Any one of the individuals participating in the appointment

ResourceAppointment
ExpressionAppointment.participant.actor
Processing ModeNormal
Target ResourcesHealthcareService, CareTeam, Device, RelatedPerson, PractitionerRole, Group, 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/Appointment-appointment-type

12.14.17 appointment-type

Parameter appointment-type:token

The style of appointment or patient that has been booked in the slot (not service type)

ResourceAppointment
ExpressionAppointment.appointmentType
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/Appointment-based-on

12.14.18 based-on

Parameter based-on:reference

The service request this appointment is allocated to assess

ResourceAppointment
ExpressionAppointment.basedOn
Processing ModeNormal
Target ResourcesRequestOrchestration, DeviceRequest, ServiceRequest, CarePlan, MedicationRequest, ImmunizationRecommendation, NutritionOrder, VisionPrescription
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-date
This search parameter is part of the common search parameter clinical-date

12.14.19 date

Parameter date:date

Appointment: Appointment date/time.

ResourceAppointment
Expression(start | requestedPeriod.start).first()
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/Appointment-group

12.14.20 group

Parameter group:reference

One of the individuals of the appointment is this patient

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)
Processing ModeNormal
Target ResourcesGroup
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 identifier

Parameter identifier:token

Appointment: An Identifier of the Appointment

ResourceAppointment
ExpressionAppointment.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/Appointment-location

12.14.22 location

Parameter location:reference

This location is listed in the participants of the appointment

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Location)
Processing ModeNormal
Target ResourcesLocation
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 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.

ResourceAppointment
ExpressionAppointment.participant.status
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/clinical-patient
This search parameter is part of the common search parameter clinical-patient

12.14.24 patient

Parameter patient:reference

Appointment: One of the individuals of the appointment is this patient

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient)
Processing ModeNormal
Target ResourcesPatient
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-practitioner

12.14.25 practitioner

Parameter practitioner:reference

One of the individuals of the appointment is this practitioner

ResourceAppointment
ExpressionAppointment.participant.actor.where(resolve() is Practitioner)
Processing ModeNormal
Target ResourcesPractitioner
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 reason-code

Parameter reason-code:token

Reference to a concept (by class)

ResourceAppointment
ExpressionAppointment.reason.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/Appointment-reason-reference

12.14.27 reason-reference

Parameter reason-reference:reference

Reference to a resource (by instance)

ResourceAppointment
ExpressionAppointment.reason.reference
Processing ModeNormal
Target ResourcesProcedure, Observation, ImmunizationRecommendation, Condition
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-requested-period

12.14.28 requested-period

Parameter requested-period:date

During what period was the Appointment requested to take place

ResourceAppointment
ExpressionrequestedPeriod
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/Appointment-service-category

12.14.29 service-category

Parameter service-category:token

A broad categorization of the service that is to be performed during this appointment

ResourceAppointment
ExpressionAppointment.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/Appointment-service-type

12.14.30 service-type

Parameter service-type:token

The specific service (by coding) that is to be performed during this appointment

ResourceAppointment
ExpressionAppointment.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/Appointment-service-type-reference

12.14.31 service-type-reference

Parameter service-type-reference:reference

The specific service (by HealthcareService) that is to be performed during this appointment

ResourceAppointment
ExpressionAppointment.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/Appointment-slot

12.14.32 slot

Parameter slot:reference

The slots that this appointment is filling

ResourceAppointment
ExpressionAppointment.slot
Processing ModeNormal
Target ResourcesSlot
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-specialty

12.14.33 specialty

Parameter specialty:token

The specialty of a practitioner that would be required to perform the service requested in this appointment

ResourceAppointment
ExpressionAppointment.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
 
http://hl7.org/fhir/SearchParameter/Appointment-status

12.14.34 status

Parameter status:token

The overall status of the appointment

ResourceAppointment
ExpressionAppointment.status
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/Appointment-subject

12.14.35 subject

Parameter subject:reference

One of the individuals of the appointment is this patient

ResourceAppointment
ExpressionAppointment.subject
Processing ModeNormal
Target ResourcesGroup, 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/Appointment-supporting-info

12.14.36 supporting-info

Parameter supporting-info:reference

Additional information to support the appointment

ResourceAppointment
ExpressionAppointment.supportingInformation
Processing ModeNormal
Target ResourcesAccount, ActivityDefinition, ActorDefinition, AdministrableProductDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, ArtifactAssessment, AuditEvent, Basic, Binary, BiologicallyDerivedProduct, BiologicallyDerivedProductDispense, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, ChargeItem, ChargeItemDefinition, Citation, Claim, ClaimResponse, ClinicalImpression, ClinicalUseDefinition, CodeSystem, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, ConditionDefinition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceAssociation, DeviceDefinition, DeviceDispense, DeviceMetric, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentReference, Encounter, EncounterHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, FormularyItem, GenomicStudy, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, ImagingSelection, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, Ingredient, InsurancePlan, InventoryItem, InventoryReport, Invoice, Library, Linkage, List, Location, ManufacturedItemDefinition, Measure, MeasureReport, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProductDefinition, MessageDefinition, MessageHeader, MolecularSequence, NamingSystem, NutritionIntake, NutritionOrder, NutritionProduct, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PackagedProductDefinition, Parameters, Patient, PaymentNotice, PaymentReconciliation, Permission, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RegulatedAuthorization, RelatedPerson, RequestOrchestration, Requirements, ResearchStudy, ResearchSubject, RiskAssessment, Schedule, SearchParameter, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Subscription, SubscriptionStatus, SubscriptionTopic, Substance, SubstanceDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SupplyDelivery, SupplyRequest, Task, TerminologyCapabilities, TestPlan, TestReport, TestScript, Transport, ValueSet, VerificationResult, VisionPrescription
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