Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

9.5.15 9.5.14 Resource CarePlan - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Care icon Work Group   Trial Use Normative Security Category : Patient Compartments : Encounter , Group , 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

9.5.16 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

Resource CarePlan
Expression CarePlan.activity.plannedActivityReference
Processing Mode Normal
Target Resources Appointment , RequestOrchestration , DeviceRequest , ServiceRequest , CommunicationRequest , Task , MedicationRequest , SupplyRequest , ImmunizationRecommendation , NutritionOrder , VisionPrescription
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.17 Generated Narrative: SearchParameter CarePlan-based-on

9.5.16 based-on

Parameter based-on : reference

Fulfills CarePlan

Resource CarePlan
Expression CarePlan.basedOn
Processing Mode Normal
Target Resources RequestOrchestration , ServiceRequest , CarePlan , NutritionOrder
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.18 Generated Narrative: SearchParameter CarePlan-care-team

9.5.17 care-team

Parameter care-team : reference

Who's involved in plan?

Resource CarePlan
Expression CarePlan.careTeam
Processing Mode Normal
Target Resources CareTeam
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.19 Generated Narrative: SearchParameter CarePlan-category

9.5.18 category

Parameter category : token

Type of plan

Resource CarePlan
Expression CarePlan.category
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.20 Generated Narrative: SearchParameter CarePlan-condition

9.5.19 condition

Parameter condition : reference

Reference to a resource (by instance)

Resource CarePlan
Expression CarePlan.addresses.reference
Processing Mode Normal
Target Resources Procedure , MedicationAdministration , Condition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.21 Generated Narrative: SearchParameter CarePlan-custodian

9.5.20 custodian

Parameter custodian : reference

Who is the designated responsible party

Resource CarePlan
Expression CarePlan.custodian
Processing Mode Normal
Target Resources Device , Organization , CareTeam , RelatedPerson , PractitionerRole , Practitioner , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.22 Generated Narrative: SearchParameter clinical-date

9.5.21 date

Parameter date : date

CarePlan : Time period plan covers

Resource CarePlan
Expression CarePlan.period
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.23 Generated Narrative: SearchParameter clinical-encounter

9.5.22 encounter

Parameter encounter : reference

CarePlan : The Encounter during which this CarePlan was created

Resource CarePlan
Expression CarePlan.encounter
Processing Mode Normal
Target Resources Encounter
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.24 Generated Narrative: SearchParameter CarePlan-goal

9.5.23 goal

Parameter goal : reference

Desired outcome of plan

Resource CarePlan
Expression CarePlan.goal
Processing Mode Normal
Target Resources Goal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.25 Generated Narrative: SearchParameter clinical-identifier

9.5.24 identifier

Parameter identifier : token

CarePlan : External Ids for this plan

Resource CarePlan
Expression CarePlan.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values   http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-canonical 9.5.26 instantiates-canonical Parameter instantiates-canonical : reference Instantiates FHIR protocol or definition Resource CarePlan Expression CarePlan.instantiatesCanonical Processing Mode Normal Target Resources Measure , OperationDefinition , ActivityDefinition , PlanDefinition , Questionnaire Multiples that must all be true
    • The
  • multipleOr: It's up to the server whether the parameter cannot repeat or can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-uri http://hl7.org/fhir/SearchParameter/CarePlan-intent
9.5.27 instantiates-uri

Parameter instantiates-uri : uri Generated Narrative: SearchParameter CarePlan-intent

Instantiates external protocol or definition Resource CarePlan Expression CarePlan.instantiatesUri Processing Mode Normal Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/CarePlan-intent

9.5.28 9.5.25 intent

Parameter intent : token

proposal | plan | order | option | directive

Resource CarePlan
Expression CarePlan.intent
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.29 Generated Narrative: SearchParameter CarePlan-part-of

9.5.26 part-of

Parameter part-of : reference

Part of referenced CarePlan

Resource CarePlan
Expression CarePlan.partOf
Processing Mode Normal
Target Resources CarePlan
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.30 Generated Narrative: SearchParameter clinical-patient

9.5.27 patient

Parameter patient : reference

CarePlan : Who the care plan is for

Resource CarePlan
Expression CarePlan.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.31 Generated Narrative: SearchParameter CarePlan-replaces

9.5.28 replaces

Parameter replaces : reference

CarePlan replaced by this CarePlan

Resource CarePlan
Expression CarePlan.replaces
Processing Mode Normal
Target Resources CarePlan
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.32 Generated Narrative: SearchParameter CarePlan-status

9.5.29 status

Parameter status : token

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

Resource CarePlan
Expression CarePlan.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.5.33 Generated Narrative: SearchParameter CarePlan-subject

9.5.30 subject

Parameter subject : reference

Who the care plan is for

Resource CarePlan
Expression CarePlan.subject
Processing Mode Normal
Target Resources Group , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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