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

12.23.15 Resource PlanDefinition - Search Parameters

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Business Compartments: Not linked to any defined compartments

Search Parameter Registry for the plandefinition resource

12.23.16 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/PlanDefinition-composed-of

12.23.17 composed-of

Parameter composed-of:reference

What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='composed-of').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-context

12.23.18 context

Parameter context:token

A use context assigned to the plan definition

ResourcePlanDefinition
Expression(PlanDefinition.useContext.value as CodeableConcept)
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-context-quantity

12.23.19 context-quantity

Parameter context-quantity:quantity

A quantity- or range-valued use context assigned to the plan definition

ResourcePlanDefinition
Expression(PlanDefinition.useContext.value as Quantity) | (PlanDefinition.useContext.value as Range)
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type

12.23.20 context-type

Parameter context-type:token

A type of use context assigned to the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.useContext.code
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type-quantity

12.23.21 context-type-quantity

Parameter context-type-quantity:composite

A use context type and quantity- or range-based value assigned to the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.useContext
MultiplesThe parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/PlanDefinition-context-typecode
http://hl7.org/fhir/SearchParameter/PlanDefinition-context-quantityvalue.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type-value

12.23.22 context-type-value

Parameter context-type-value:composite

A use context type and value assigned to the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.useContext
MultiplesThe parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/PlanDefinition-context-typecode
http://hl7.org/fhir/SearchParameter/PlanDefinition-contextvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-date

12.23.23 date

Parameter date:date

The plan definition publication date

ResourcePlanDefinition
ExpressionPlanDefinition.date
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-definition

12.23.24 definition

Parameter definition:reference

Activity or plan definitions used by plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.action.definition
Target ResourcesSpecimenDefinition, Questionnaire, ObservationDefinition, PlanDefinition, ActivityDefinition
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-depends-on

12.23.25 depends-on

Parameter depends-on:reference

What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-derived-from

12.23.26 derived-from

Parameter derived-from:reference

What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='derived-from').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-description

12.23.27 description

Parameter description:string

The description of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.description
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-effective

12.23.28 effective

Parameter effective:date

The time during which the plan definition is intended to be in use

ResourcePlanDefinition
ExpressionPlanDefinition.effectivePeriod
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier

12.23.29 identifier

Parameter identifier:token

External identifier for the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-jurisdiction

12.23.30 jurisdiction

Parameter jurisdiction:token

Intended jurisdiction for the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.jurisdiction
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-name

12.23.31 name

Parameter name:string

Computationally friendly name of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.name
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-predecessor

12.23.32 predecessor

Parameter predecessor:reference

What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='predecessor').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher

12.23.33 publisher

Parameter publisher:string

Name of the publisher of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.publisher
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-status

12.23.34 status

Parameter status:token

The current status of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.status
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-successor

12.23.35 successor

Parameter successor:reference

What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='successor').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-title

12.23.36 title

Parameter title:string

The human-friendly name of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.title
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-topic

12.23.37 topic

Parameter topic:token

Topics associated with the module

ResourcePlanDefinition
ExpressionPlanDefinition.topic
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-type

12.23.38 type

Parameter type:token

The type of artifact the plan (e.g. order-set, eca-rule, protocol)

ResourcePlanDefinition
ExpressionPlanDefinition.type
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-url

12.23.39 url

Parameter url:uri

The uri that identifies the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.url
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-version

12.23.40 version

Parameter version:token

The business version of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.version
MultiplesThe parameter cannot repeat or have multiple values