FHIR CI-Build

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

9.5.14 Resource CarePlan - Search Parameters

Patient Care icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Encounter, Patient

Search parameters for the Resource CarePlan - 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/CarePlan-activity-reference

Generated Narrative: SearchParameter CarePlan-activity-reference

9.5.15 activity-reference

Parameter activity-reference:reference

Activity that is intended to be part of the care plan

ResourceCarePlan
Expression CarePlan.activity.plannedActivityReference
Processing Mode Normal
Target Resources Appointment, RequestOrchestration, DeviceRequest, ServiceRequest, CommunicationRequest, Task, MedicationRequest, SupplyRequest, 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/CarePlan-based-on

Generated Narrative: SearchParameter CarePlan-based-on

9.5.16 based-on

Parameter based-on:reference

Fulfills CarePlan

ResourceCarePlan
Expression CarePlan.basedOn
Processing Mode Normal
Target Resources RequestOrchestration, ServiceRequest, CarePlan, NutritionOrder
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/CarePlan-care-team

Generated Narrative: SearchParameter CarePlan-care-team

9.5.17 care-team

Parameter care-team:reference

Who's involved in plan?

ResourceCarePlan
Expression CarePlan.careTeam
Processing Mode Normal
Target Resources CareTeam
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/CarePlan-category

Generated Narrative: SearchParameter CarePlan-category

9.5.18 category

Parameter category:token

Type of plan

ResourceCarePlan
Expression CarePlan.category
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/CarePlan-condition

Generated Narrative: SearchParameter CarePlan-condition

9.5.19 condition

Parameter condition:reference

Reference to a resource (by instance)

ResourceCarePlan
Expression CarePlan.addresses.reference
Processing Mode Normal
Target Resources Procedure, MedicationAdministration, 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/CarePlan-custodian

Generated Narrative: SearchParameter CarePlan-custodian

9.5.20 custodian

Parameter custodian:reference

Who is the designated responsible party

ResourceCarePlan
Expression CarePlan.custodian
Processing Mode Normal
Target Resources Device, Organization, CareTeam, RelatedPerson, PractitionerRole, Practitioner, 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/clinical-date
This search parameter is part of the common search parameter clinical-date

Generated Narrative: SearchParameter clinical-date

9.5.21 date

Parameter date:date

CarePlan: Time period plan covers

ResourceCarePlan
Expression CarePlan.period
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/clinical-encounter
This search parameter is part of the common search parameter clinical-encounter

Generated Narrative: SearchParameter clinical-encounter

9.5.22 encounter

Parameter encounter:reference

CarePlan: The Encounter during which this CarePlan was created

ResourceCarePlan
Expression CarePlan.encounter
Processing Mode Normal
Target Resources Encounter
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/CarePlan-goal

Generated Narrative: SearchParameter CarePlan-goal

9.5.23 goal

Parameter goal:reference

Desired outcome of plan

ResourceCarePlan
Expression CarePlan.goal
Processing Mode Normal
Target Resources Goal
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

Generated Narrative: SearchParameter clinical-identifier

9.5.24 identifier

Parameter identifier:token

CarePlan: External Ids for this plan

ResourceCarePlan
Expression CarePlan.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/CarePlan-instantiates-canonical

Generated Narrative: SearchParameter CarePlan-instantiates-canonical

9.5.25 instantiates-canonical

Parameter instantiates-canonical:reference

Instantiates FHIR protocol or definition

ResourceCarePlan
Expression CarePlan.instantiatesCanonical
Processing Mode Normal
Target Resources Measure, OperationDefinition, ActivityDefinition, PlanDefinition, Questionnaire
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/CarePlan-instantiates-uri

Generated Narrative: SearchParameter CarePlan-instantiates-uri

9.5.26 instantiates-uri

Parameter instantiates-uri:uri

Instantiates external protocol or definition

ResourceCarePlan
Expression CarePlan.instantiatesUri
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/CarePlan-intent

Generated Narrative: SearchParameter CarePlan-intent

9.5.27 intent

Parameter intent:token

proposal | plan | order | option | directive

ResourceCarePlan
Expression CarePlan.intent
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/CarePlan-part-of

Generated Narrative: SearchParameter CarePlan-part-of

9.5.28 part-of

Parameter part-of:reference

Part of referenced CarePlan

ResourceCarePlan
Expression CarePlan.partOf
Processing Mode Normal
Target Resources CarePlan
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

Generated Narrative: SearchParameter clinical-patient

9.5.29 patient

Parameter patient:reference

CarePlan: Who the care plan is for

ResourceCarePlan
Expression CarePlan.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources 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/CarePlan-replaces

Generated Narrative: SearchParameter CarePlan-replaces

9.5.30 replaces

Parameter replaces:reference

CarePlan replaced by this CarePlan

ResourceCarePlan
Expression CarePlan.replaces
Processing Mode Normal
Target Resources CarePlan
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/CarePlan-status

Generated Narrative: SearchParameter CarePlan-status

9.5.31 status

Parameter status:token

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

ResourceCarePlan
Expression CarePlan.status
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/CarePlan-subject

Generated Narrative: SearchParameter CarePlan-subject

9.5.32 subject

Parameter subject:reference

Who the care plan is for

ResourceCarePlan
Expression CarePlan.subject
Processing Mode Normal
Target Resources Group, 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