PlanDefinition - FHIR v5.0.0-snapshot3

Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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 icon

Work Group

Maturity Level: N/A

Standards Status: Informative

Security 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/build/SearchParameter/PlanDefinition-composed-of

12.23.17 composed-of

Parameter composed-of:reference

What resource is being referenced

Resources

Expression PlanDefinition.relatedArtifact.where(type='composed-of').resource

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-context

12.23.18 context

Parameter context:token

A use context assigned to the plan definition

Resources

Expression (PlanDefinition.useContext.value as CodeableConcept)

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/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

Resources

Expression (PlanDefinition.useContext.value as Quantity) | (PlanDefinition.useContext.value as Range)

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-context-type

12.23.20 context-type

Parameter context-type:token

A type of use context assigned to the plan definition

Resources

Expression PlanDefinition.useContext.code

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/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

Resources

Expression PlanDefinition.useContext

Usage Normal

Multiples The parameter cannot repeat or have multiple values

Components

context-type code

context-quantity value.ofType(Quantity) | value.ofType(Range)

http://hl7.org/fhir/build/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

Resources

Expression PlanDefinition.useContext

Usage Normal

Multiples The parameter cannot repeat or have multiple values

Components

context-type code

context value.ofType(CodeableConcept)

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-date

12.23.23 date

Parameter date:date

The plan definition publication date

Resources

Expression PlanDefinition.date

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/PlanDefinition-definition

12.23.24 definition

Parameter definition:reference

Activity or plan definitions used by plan definition

Resource PlanDefinition

Expression PlanDefinition.action.definition.as(canonical) | PlanDefinition.action.definition.as(uri)

Target Resources SpecimenDefinition, Questionnaire, ObservationDefinition, PlanDefinition, ActivityDefinition

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-depends-on

12.23.25 depends-on

Parameter depends-on:reference

What resource is being referenced

Resources

Expression PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-derived-from

12.23.26 derived-from

Parameter derived-from:reference

What resource is being referenced

Resources

Expression PlanDefinition.relatedArtifact.where(type='derived-from').resource

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-description

12.23.27 description

Parameter description:string

The description of the plan definition

Resources

Expression PlanDefinition.description

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-effective

12.23.28 effective

Parameter effective:date

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

Resources

Expression PlanDefinition.effectivePeriod

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-identifier

12.23.29 identifier

Parameter identifier:token

External identifier for the plan definition

Resources

Expression PlanDefinition.identifier

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-jurisdiction

12.23.30 jurisdiction

Parameter jurisdiction:token

Intended jurisdiction for the plan definition

Resources

Expression PlanDefinition.jurisdiction

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-name

12.23.31 name

Parameter name:string

Computationally friendly name of the plan definition

Resources

Expression PlanDefinition.name

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-predecessor

12.23.32 predecessor

Parameter predecessor:reference

What resource is being referenced

Resources

Expression PlanDefinition.relatedArtifact.where(type='predecessor').resource

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-publisher

12.23.33 publisher

Parameter publisher:string

Name of the publisher of the plan definition

Resources

Expression PlanDefinition.publisher

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-status

12.23.34 status

Parameter status:token

The current status of the plan definition

Resources

Expression PlanDefinition.status

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-successor

12.23.35 successor

Parameter successor:reference

What resource is being referenced

Resources

Expression PlanDefinition.relatedArtifact.where(type='successor').resource

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-title

12.23.36 title

Parameter title:string

The human-friendly name of the plan definition

Resources

Expression PlanDefinition.title

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-topic

12.23.37 topic

Parameter topic:token

Topics associated with the module

Resources

Expression PlanDefinition.topic

Usage Normal

Multiples The 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)

Resource PlanDefinition

Expression PlanDefinition.type

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-url

12.23.39 url

Parameter url:uri

The uri that identifies the plan definition

Resources

Expression PlanDefinition.url

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/PlanDefinition-version

12.23.40 version

Parameter version:token

The business version of the plan definition

Resources

Expression PlanDefinition.version

Usage Normal

Multiples The parameter cannot repeat or have multiple values