PlanDefinition - FHIR v5.0.0-draft-final

R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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.16 Resource PlanDefinition - Search Parameters

Clinical Decision Support icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Business

Compartments: Not linked to any defined compartments

Search parameters for the Resource PlanDefinition - 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/MetadataResource-composed-of

This search parameter is part of the common search parameter MetadataResource-composed-of

12.23.17 composed-of

Parameter composed-of:reference

PlanDefinition: What resource is being referenced

Resource PlanDefinition

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

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-context

This search parameter is part of the common search parameter CanonicalResource-context

12.23.18 context

Parameter context:token

PlanDefinition: A use context assigned to the plan definition

Resource PlanDefinition

Expression (PlanDefinition.useContext.value.ofType(CodeableConcept))

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-context-quantity

This search parameter is part of the common search parameter CanonicalResource-context-quantity

12.23.19 context-quantity

Parameter context-quantity:quantity

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

Resource PlanDefinition

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

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/CanonicalResource-context-type

This search parameter is part of the common search parameter CanonicalResource-context-type

12.23.20 context-type

Parameter context-type:token

PlanDefinition: A type of use context assigned to the plan definition

Resource PlanDefinition

Expression PlanDefinition.useContext.code

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-quantity

This search parameter is part of the common search parameter CanonicalResource-context-type-quantity

12.23.21 context-type-quantity

Parameter context-type-quantity:composite

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

Resource PlanDefinition

Expression PlanDefinition.useContext

Processing Mode 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/SearchParameter/CanonicalResource-context-type-value

This search parameter is part of the common search parameter CanonicalResource-context-type-value

12.23.22 context-type-value

Parameter context-type-value:composite

PlanDefinition: A use context type and value assigned to the plan definition

Resource PlanDefinition

Expression PlanDefinition.useContext

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

Components

context-type code

context value.ofType(CodeableConcept)

http://hl7.org/fhir/SearchParameter/CanonicalResource-date

This search parameter is part of the common search parameter CanonicalResource-date

12.23.23 date

Parameter date:date

PlanDefinition: The plan definition publication date

Resource PlanDefinition

Expression PlanDefinition.date

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/PlanDefinition-definition

12.23.24 definition

Parameter definition:reference

Activity or plan definitions used by plan definition

Resource PlanDefinition

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

Processing Mode Normal

Target Resources ObservationDefinition, ActivityDefinition, PlanDefinition, MessageDefinition, Questionnaire, SpecimenDefinition

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/MetadataResource-depends-on

This search parameter is part of the common search parameter MetadataResource-depends-on

12.23.25 depends-on

Parameter depends-on:reference

PlanDefinition: What resource is being referenced

Resource PlanDefinition

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

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/MetadataResource-derived-from

This search parameter is part of the common search parameter MetadataResource-derived-from

12.23.26 derived-from

Parameter derived-from:reference

PlanDefinition: What resource is being referenced

Resource PlanDefinition

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

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-description

This search parameter is part of the common search parameter CanonicalResource-description

12.23.27 description

Parameter description:string

PlanDefinition: The description of the plan definition

Resource PlanDefinition

Expression PlanDefinition.description

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/MetadataResource-effective

This search parameter is part of the common search parameter MetadataResource-effective

12.23.28 effective

Parameter effective:date

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

Resource PlanDefinition

Expression PlanDefinition.effectivePeriod

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/CanonicalResource-identifier

This search parameter is part of the common search parameter CanonicalResource-identifier

12.23.29 identifier

Parameter identifier:token

PlanDefinition: External identifier for the plan definition

Resource PlanDefinition

Expression PlanDefinition.identifier

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-jurisdiction

This search parameter is part of the common search parameter CanonicalResource-jurisdiction

12.23.30 jurisdiction

Parameter jurisdiction:token

PlanDefinition: Intended jurisdiction for the plan definition

Resource PlanDefinition

Expression PlanDefinition.jurisdiction

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-name

This search parameter is part of the common search parameter CanonicalResource-name

12.23.31 name

Parameter name:string

PlanDefinition: Computationally friendly name of the plan definition

Resource PlanDefinition

Expression PlanDefinition.name

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/MetadataResource-predecessor

This search parameter is part of the common search parameter MetadataResource-predecessor

12.23.32 predecessor

Parameter predecessor:reference

PlanDefinition: What resource is being referenced

Resource PlanDefinition

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

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-publisher

This search parameter is part of the common search parameter CanonicalResource-publisher

12.23.33 publisher

Parameter publisher:string

PlanDefinition: Name of the publisher of the plan definition

Resource PlanDefinition

Expression PlanDefinition.publisher

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-status

This search parameter is part of the common search parameter CanonicalResource-status

12.23.34 status

Parameter status:token

PlanDefinition: The current status of the plan definition

Resource PlanDefinition

Expression PlanDefinition.status

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/MetadataResource-successor

This search parameter is part of the common search parameter MetadataResource-successor

12.23.35 successor

Parameter successor:reference

PlanDefinition: What resource is being referenced

Resource PlanDefinition

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

Processing Mode Normal

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-title

This search parameter is part of the common search parameter CanonicalResource-title

12.23.36 title

Parameter title:string

PlanDefinition: The human-friendly name of the plan definition

Resource PlanDefinition

Expression PlanDefinition.title

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/MetadataResource-topic

This search parameter is part of the common search parameter MetadataResource-topic

12.23.37 topic

Parameter topic:token

PlanDefinition: Topics associated with the module

Resource PlanDefinition

Expression PlanDefinition.topic

Processing Mode 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

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-url

This search parameter is part of the common search parameter CanonicalResource-url

12.23.39 url

Parameter url:uri

PlanDefinition: The uri that identifies the plan definition

Resource PlanDefinition

Expression PlanDefinition.url

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/CanonicalResource-version

This search parameter is part of the common search parameter CanonicalResource-version

12.23.40 version

Parameter version:token

PlanDefinition: The business version of the plan definition

Resource PlanDefinition

Expression PlanDefinition.version

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values