Release 4 R5 Final QA

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-draft-final: Final QA Preview for R5 - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

9.5.14 Resource CarePlan - Search Parameters

Vocabulary Patient Care icon Work Group Maturity Level : N/A   Trial Use Standards Status : Informative Security Category : Patient Compartments : Encounter , Patient

This is the narrative Search parameters for the Resource CarePlan - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource. See

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.15 activity-reference

Parameter activity-reference : reference

Activity that is intended to be part of the XML care plan

Resource CarePlan
Expression CarePlan.activity.plannedActivityReference
Processing Mode Normal
Target Resources Appointment , JSON RequestOrchestration , DeviceRequest , ServiceRequest , CommunicationRequest , Task , MedicationRequest , SupplyRequest , ImmunizationRecommendation , NutritionOrder , VisionPrescription
Multiples The parameter cannot repeat or Turtle have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-based-on format.

9.5.16 based-on

Parameter based-on : reference

v3.DocumentReferenceStatus (http://hl7.org/fhir/ConceptMap/cm-document-reference-status-v3)

Fulfills CarePlan

Resource CarePlan
Expression CarePlan.basedOn
Processing Mode Normal
Target Resources RequestOrchestration , ServiceRequest , CarePlan , NutritionOrder
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-care-team

9.5.17 care-team

Mapping from http://hl7.org/fhir/ValueSet/document-reference-status Parameter care-team : reference

Who's involved in plan?

Resource CarePlan to http://terminology.hl7.org/ValueSet/v3-ActStatus
Expression CarePlan.careTeam
Processing Mode Normal
Target Resources CareTeam
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-category

9.5.18 category

Parameter category : token

DRAFT. Published on 01/11/2019 9:29:23 AM by HL7 (FHIR Project). Type of plan

Resource CarePlan
Expression CarePlan.category
Processing Mode Normal
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-condition

9.5.19 condition

Parameter condition : reference

Reference to a resource (by instance)

Source Code Equivalence Destination Code
Resource CarePlan
Expression CarePlan.addresses.reference
Processing Mode Normal
Target Resources Condition
current Multiples equivalent The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-custodian

9.5.20 custodian

Parameter custodian : reference

Who is the designated responsible party

active Resource CarePlan
superseded Expression equivalent CarePlan.custodian
obsolete Processing Mode Normal
entered-in-error Target Resources equivalent Device , Organization , CareTeam , RelatedPerson , PractitionerRole , Practitioner , Patient
nullified Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

9.5.21 date

Parameter date : date

CarePlan : Time period plan covers

Resource CarePlan
Expression CarePlan.period
Processing Mode Normal
Multiples The parameter cannot repeat or have multiple values
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.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 parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-goal

9.5.23 goal

Parameter goal : reference

Usage note: every effort has been made to ensure that Desired outcome of plan

Resource CarePlan
Expression CarePlan.goal
Processing Mode Normal
Target Resources Goal
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the examples are correct and useful, but they are not a normative common search parameter 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 parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-canonical

9.5.25 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 The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-uri

9.5.26 instantiates-uri

Parameter instantiates-uri : uri

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.27 intent

Parameter intent : token

proposal | plan | order | option | directive

Resource CarePlan
Expression CarePlan.intent
Processing Mode Normal
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-part-of

9.5.28 part-of

Parameter part-of : reference

Part of referenced CarePlan

Resource CarePlan
Expression CarePlan.partOf
Processing Mode Normal
Target Resources CarePlan
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the specification. common search parameter clinical-patient

9.5.29 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 parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-replaces

9.5.30 replaces

Parameter replaces : reference

CarePlan replaced by this CarePlan

Resource CarePlan
Expression CarePlan.replaces
Processing Mode Normal
Target Resources CarePlan
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-status

9.5.31 status

Parameter status : token

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

Resource CarePlan
Expression CarePlan.status
Processing Mode Normal
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CarePlan-subject

9.5.32 subject

Parameter subject : reference

Who the care plan is for

Resource CarePlan
Expression CarePlan.subject
Processing Mode Normal
Target Resources Group , Patient
Multiples The parameter cannot repeat or have multiple values