Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

Clinical Decision Support icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Business Compartments: No 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

Parameter composed-of:reference

PlanDefinition: What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='composed-of').resource
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe 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

Parameter context:token

PlanDefinition: A use context assigned to the plan definition

ResourcePlanDefinition
Expression(PlanDefinition.useContext.value.ofType(CodeableConcept))
Processing ModeNormal
MultiplesThe 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

Parameter context-quantity:quantity

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

ResourcePlanDefinition
Expression(PlanDefinition.useContext.value.ofType(Quantity)) | (PlanDefinition.useContext.value.ofType(Range))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: 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

Parameter context-type:token

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

ResourcePlanDefinition
ExpressionPlanDefinition.useContext.code
Processing ModeNormal
MultiplesThe 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

Parameter context-type-quantity:composite

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

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

Components

context-typecode
context-quantityvalue.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

Parameter context-type-value:composite

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

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

Components

context-typecode
contextvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-date
This search parameter is part of the common search parameter CanonicalResource-date

Parameter date:date

PlanDefinition: The plan definition publication date

ResourcePlanDefinition
ExpressionPlanDefinition.date
Processing ModeNormal
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

Parameter definition:reference

Activity or plan definitions used by plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.action.definition.ofType(canonical) | PlanDefinition.action.definition.ofType(uri)
Processing ModeNormal
Target ResourcesObservationDefinition, ActivityDefinition, PlanDefinition, MessageDefinition, Questionnaire, SpecimenDefinition
MultiplesThe 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

Parameter depends-on:reference

PlanDefinition: What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe 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

Parameter derived-from:reference

PlanDefinition: What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='derived-from').resource
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe 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

Parameter description:string

PlanDefinition: The description of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.description
Processing ModeNormal
MultiplesThe 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

Parameter effective:date

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

ResourcePlanDefinition
ExpressionPlanDefinition.effectivePeriod
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: 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

Parameter identifier:token

PlanDefinition: External identifier for the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.identifier
Processing ModeNormal
MultiplesThe 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

Parameter jurisdiction:token

PlanDefinition: Intended jurisdiction for the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.jurisdiction
Processing ModeNormal
MultiplesThe 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

Parameter name:string

PlanDefinition: Computationally friendly name of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.name
Processing ModeNormal
MultiplesThe 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

Parameter predecessor:reference

PlanDefinition: What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='predecessor').resource
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe 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

Parameter publisher:string

PlanDefinition: Name of the publisher of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.publisher
Processing ModeNormal
MultiplesThe 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

Parameter status:token

PlanDefinition: The current status of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.status
Processing ModeNormal
MultiplesThe 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

Parameter successor:reference

PlanDefinition: What resource is being referenced

ResourcePlanDefinition
ExpressionPlanDefinition.relatedArtifact.where(type='successor').resource
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe 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

Parameter title:string

PlanDefinition: The human-friendly name of the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.title
Processing ModeNormal
MultiplesThe 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

Parameter topic:token

PlanDefinition: Topics associated with the module

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

Parameter type:token

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

ResourcePlanDefinition
ExpressionPlanDefinition.type
Processing ModeNormal
MultiplesThe 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

Parameter url:uri

PlanDefinition: The uri that identifies the plan definition

ResourcePlanDefinition
ExpressionPlanDefinition.url
Processing ModeNormal
MultiplesThe 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

Parameter version:token

PlanDefinition: The business version of the plan definition

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