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

9.5.14 Resource CarePlan - Search Parameters

Patient Care Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Patient Compartments: Encounter, Patient, Practitioner, RelatedPerson

Search Parameter Registry for the careplan resource

9.5.15 Search Parameters

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/CarePlan-activity-code

9.5.16 activity-code

Parameter activity-code:token

Detail type of activity

ResourceCarePlan
ExpressionCarePlan.activity.plannedActivityDetail.code
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-activity-reference

9.5.17 activity-reference

Parameter activity-reference:reference

Activity that is intended to be part of the care plan

ResourceCarePlan
ExpressionCarePlan.activity.plannedActivityReference
Target ResourcesAppointment, MedicationRequest, Task, NutritionOrder, RequestOrchestration, VisionPrescription, DeviceRequest, ServiceRequest, CommunicationRequest, ImmunizationRecommendation
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-activity-scheduled-date

9.5.18 activity-scheduled-date

Parameter activity-scheduled-date:date

Specified date occurs within period specified by CarePlan.activity.plannedActivityDetail.scheduled[x]

ResourceCarePlan
ExpressionCarePlan.activity.plannedActivityDetail.scheduled.ofType(Timing) | CarePlan.activity.plannedActivityDetail.scheduled.ofType(Period)
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/CarePlan-activity-scheduled-string

9.5.19 activity-scheduled-string

Parameter activity-scheduled-string:string

When activity is to occur

ResourceCarePlan
ExpressionCarePlan.activity.plannedActivityDetail.scheduled.ofType(string)
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-based-on

9.5.20 based-on

Parameter based-on:reference

Fulfills CarePlan

ResourceCarePlan
ExpressionCarePlan.basedOn
Target ResourcesCarePlan
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-care-team

9.5.21 care-team

Parameter care-team:reference

Who's involved in plan?

ResourceCarePlan
ExpressionCarePlan.careTeam
Target ResourcesCareTeam
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-category

9.5.22 category

Parameter category:token

Type of plan

ResourceCarePlan
ExpressionCarePlan.category
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-condition

9.5.23 condition

Parameter condition:reference

Reference to a resource (by instance)

ResourceCarePlan
ExpressionCarePlan.addresses.reference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-custodian

9.5.24 custodian

Parameter custodian:reference

Who is the designated responsible party

ResourceCarePlan
ExpressionCarePlan.custodian
Target ResourcesPractitioner, Organization, CareTeam, Device, Patient, PractitionerRole, RelatedPerson
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CarePlan-date

9.5.25 date

Parameter date:date

Time period plan covers

Resources
ExpressionCarePlan.period
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-encounter

9.5.26 encounter

Parameter encounter:reference

The Encounter during which this CarePlan was created

ResourceCarePlan
ExpressionCarePlan.encounter
Target ResourcesEncounter
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-goal

9.5.27 goal

Parameter goal:reference

Desired outcome of plan

ResourceCarePlan
ExpressionCarePlan.goal
Target ResourcesGoal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CarePlan-identifier

9.5.28 identifier

Parameter identifier:token

External Ids for this plan

Resources
ExpressionCarePlan.identifier
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-canonical

9.5.29 instantiates-canonical

Parameter instantiates-canonical:reference

Instantiates FHIR protocol or definition

ResourceCarePlan
ExpressionCarePlan.instantiatesCanonical
Target ResourcesQuestionnaire, Measure, PlanDefinition, OperationDefinition, ActivityDefinition
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-uri

9.5.30 instantiates-uri

Parameter instantiates-uri:uri

Instantiates external protocol or definition

ResourceCarePlan
ExpressionCarePlan.instantiatesUri
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-intent

9.5.31 intent

Parameter intent:token

proposal | plan | order | option | directive

ResourceCarePlan
ExpressionCarePlan.intent
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-part-of

9.5.32 part-of

Parameter part-of:reference

Part of referenced CarePlan

ResourceCarePlan
ExpressionCarePlan.partOf
Target ResourcesCarePlan
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CarePlan-patient

9.5.33 patient

Parameter patient:reference

Who the care plan is for

Resources
ExpressionCarePlan.subject.where(resolve() is Patient)
UsageNormal
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-performer

9.5.34 performer

Parameter performer:reference

Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)

ResourceCarePlan
ExpressionCarePlan.activity.plannedActivityDetail.performer
Target ResourcesPractitioner, Organization, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-replaces

9.5.35 replaces

Parameter replaces:reference

CarePlan replaced by this CarePlan

ResourceCarePlan
ExpressionCarePlan.replaces
Target ResourcesCarePlan
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-status

9.5.36 status

Parameter status:token

draft | active | on-hold | revoked | completed | entered-in-error | unknown

ResourceCarePlan
ExpressionCarePlan.status
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-subject

9.5.37 subject

Parameter subject:reference

Who the care plan is for

ResourceCarePlan
ExpressionCarePlan.subject
Target ResourcesGroup, Patient
MultiplesThe parameter cannot repeat or have multiple values