FHIR CI-Build

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

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

Parameter activity-reference:reference

Activity that is intended to be part of the care plan

ResourceCarePlan
ExpressionCarePlan.activity.plannedActivityReference
Processing ModeNormal
Target ResourcesAppointment, 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

Parameter based-on:reference

Fulfills CarePlan

ResourceCarePlan
ExpressionCarePlan.basedOn
Processing ModeNormal
Target ResourcesRequestOrchestration, 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

Parameter care-team:reference

Who's involved in plan?

ResourceCarePlan
ExpressionCarePlan.careTeam
Processing ModeNormal
Target ResourcesCareTeam
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

Parameter category:token

Type of plan

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

Parameter condition:reference

Reference to a resource (by instance)

ResourceCarePlan
ExpressionCarePlan.addresses.reference
Processing ModeNormal
Target ResourcesProcedure, 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

Parameter custodian:reference

Who is the designated responsible party

ResourceCarePlan
ExpressionCarePlan.custodian
Processing ModeNormal
Target ResourcesDevice, 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

Parameter date:date

CarePlan: Time period plan covers

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

Parameter encounter:reference

CarePlan: The Encounter during which this CarePlan was created

ResourceCarePlan
ExpressionCarePlan.encounter
Processing ModeNormal
Target ResourcesEncounter
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

Parameter goal:reference

Desired outcome of plan

ResourceCarePlan
ExpressionCarePlan.goal
Processing ModeNormal
Target ResourcesGoal
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

Parameter identifier:token

CarePlan: External Ids for this plan

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

Parameter instantiates-canonical:reference

Instantiates FHIR protocol or definition

ResourceCarePlan
ExpressionCarePlan.instantiatesCanonical
Processing ModeNormal
Target ResourcesMeasure, 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

Parameter instantiates-uri:uri

Instantiates external protocol or definition

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

Parameter intent:token

proposal | plan | order | option | directive

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

Parameter part-of:reference

Part of referenced CarePlan

ResourceCarePlan
ExpressionCarePlan.partOf
Processing ModeNormal
Target ResourcesCarePlan
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

Parameter patient:reference

CarePlan: Who the care plan is for

ResourceCarePlan
ExpressionCarePlan.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/CarePlan-replaces

Parameter replaces:reference

CarePlan replaced by this CarePlan

ResourceCarePlan
ExpressionCarePlan.replaces
Processing ModeNormal
Target ResourcesCarePlan
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

Parameter status:token

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

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

Parameter subject:reference

Who the care plan is for

ResourceCarePlan
ExpressionCarePlan.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