Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

12.23.16 12.22.12 Resource PlanDefinition - Search Parameters

Maturity Level : N/A
Responsible Owner: Clinical Decision Support icon Work Group   Trial Use Security 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

12.23.17 Generated Narrative: SearchParameter MetadataResource-composed-of

12.22.13 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context
This search parameter is part of the common search parameter CanonicalResource-context

12.23.18 Generated Narrative: SearchParameter CanonicalResource-context

12.22.14 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-quantity
This search parameter is part of the common search parameter CanonicalResource-context-quantity

12.23.19 Generated Narrative: SearchParameter CanonicalResource-context-quantity

12.22.15 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
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 Generated Narrative: SearchParameter CanonicalResource-context-type

12.22.16 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
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 Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

12.22.17 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

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 Generated Narrative: SearchParameter CanonicalResource-context-type-value

12.22.18 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

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 Generated Narrative: SearchParameter CanonicalResource-date

12.22.19 date

Parameter date : date

PlanDefinition : The plan definition publication date

Resource PlanDefinition
Expression PlanDefinition.date
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-definition

12.23.24 Generated Narrative: SearchParameter PlanDefinition-definition

12.22.20 definition

Parameter definition : reference

Activity or plan definitions used by plan definition

Resource PlanDefinition
Expression PlanDefinition.action.definition.ofType(canonical) PlanDefinition.repeat(action).definition.ofType(canonical) | PlanDefinition.action.definition.ofType(uri) PlanDefinition.repeat(action).definition.ofType(uri)
Processing Mode Normal
Target Resources Measure , OperationDefinition , ObservationDefinition , ActivityDefinition , PlanDefinition , MessageDefinition , Questionnaire , SpecimenDefinition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/MetadataResource-depends-on
This search parameter is part of the common search parameter MetadataResource-depends-on

12.23.25 Generated Narrative: SearchParameter MetadataResource-depends-on

12.22.21 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/MetadataResource-derived-from
This search parameter is part of the common search parameter MetadataResource-derived-from

12.23.26 Generated Narrative: SearchParameter MetadataResource-derived-from

12.22.22 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-description
This search parameter is part of the common search parameter CanonicalResource-description

12.23.27 Generated Narrative: SearchParameter CanonicalResource-description

12.22.23 description

Parameter description : string

PlanDefinition : The description of the plan definition

Resource PlanDefinition
Expression PlanDefinition.description
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/MetadataResource-effective
This search parameter is part of the common search parameter MetadataResource-effective

12.23.28 Generated Narrative: SearchParameter MetadataResource-effective

12.22.24 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-experimental

Generated Narrative: SearchParameter PlanDefinition-experimental

12.22.25 experimental

Parameter experimental : token

Whether the PlanDefinition is experimental

Resource PlanDefinition
Expression PlanDefinition.experimental
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-identifier
This search parameter is part of the common search parameter CanonicalResource-identifier

12.23.29 Generated Narrative: SearchParameter CanonicalResource-identifier

12.22.26 identifier

Parameter identifier : token

PlanDefinition : External identifier for the plan definition

Resource PlanDefinition
Expression PlanDefinition.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-jurisdiction
This search parameter is part of the common search parameter CanonicalResource-jurisdiction

12.23.30 Generated Narrative: SearchParameter CanonicalResource-jurisdiction

12.22.27 jurisdiction

Parameter jurisdiction : token

PlanDefinition : Intended jurisdiction for Jurisdiction of the authority that maintains the the plan definition

Resource PlanDefinition
Expression PlanDefinition.jurisdiction
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-name
This search parameter is part of the common search parameter CanonicalResource-name

12.23.31 Generated Narrative: SearchParameter CanonicalResource-name

12.22.28 name

Parameter name : string

PlanDefinition : Computationally friendly name of the plan definition

Resource PlanDefinition
Expression PlanDefinition.name
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/MetadataResource-predecessor
This search parameter is part of the common search parameter MetadataResource-predecessor

12.23.32 Generated Narrative: SearchParameter MetadataResource-predecessor

12.22.29 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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-publisher
This search parameter is part of the common search parameter CanonicalResource-publisher

12.23.33 Generated Narrative: SearchParameter CanonicalResource-publisher

12.22.30 publisher

Parameter publisher : string

PlanDefinition : Name of the publisher of the plan definition

Resource PlanDefinition
Expression PlanDefinition.publisher
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-status
This search parameter is part of the common search parameter CanonicalResource-status

12.23.34 Generated Narrative: SearchParameter CanonicalResource-status

12.22.31 status

Parameter status : token

PlanDefinition : The current status of the plan definition

Resource PlanDefinition
Expression PlanDefinition.status
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-subject-canonical

Generated Narrative: SearchParameter PlanDefinition-subject-canonical

12.22.32 subject-canonical

Parameter subject-canonical : reference

The subject of the PlanDefinition when expressed as a canonical

Resource PlanDefinition
Expression PlanDefinition.subject as canonical
Processing Mode Normal
Target Resources MedicinalProductDefinition , AdministrableProductDefinition , Group , PackagedProductDefinition , EvidenceVariable , SubstanceDefinition , ManufacturedItemDefinition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-subject-code

Generated Narrative: SearchParameter PlanDefinition-subject-code

12.22.33 subject-code

Parameter subject-code : token

The subject of the PlanDefinition when expressed as a code

Resource PlanDefinition
Expression PlanDefinition.subject as CodeableConcept
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-subject-reference

Generated Narrative: SearchParameter PlanDefinition-subject-reference

12.22.34 subject-reference

Parameter subject-reference : reference

The subject of the PlanDefinition when expressed as a reference

Resource PlanDefinition
Expression PlanDefinition.subject as Reference
Processing Mode Normal
Target Resources MedicinalProductDefinition , AdministrableProductDefinition , Group , PackagedProductDefinition , EvidenceVariable , SubstanceDefinition , ManufacturedItemDefinition
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/MetadataResource-successor
This search parameter is part of the common search parameter MetadataResource-successor

12.23.35 Generated Narrative: SearchParameter MetadataResource-successor

12.22.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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-title
This search parameter is part of the common search parameter CanonicalResource-title

12.23.36 Generated Narrative: SearchParameter CanonicalResource-title

12.22.36 title

Parameter title : string

PlanDefinition : The human-friendly name of the plan definition

Resource PlanDefinition
Expression PlanDefinition.title
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/MetadataResource-topic
This search parameter is part of the common search parameter MetadataResource-topic

12.23.37 Generated Narrative: SearchParameter MetadataResource-topic

12.22.37 topic

Parameter topic : token

PlanDefinition : Topics associated with the module

Resource PlanDefinition
Expression PlanDefinition.topic
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/PlanDefinition-type

12.23.38 Generated Narrative: SearchParameter PlanDefinition-type

12.22.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
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-url
This search parameter is part of the common search parameter CanonicalResource-url

12.23.39 Generated Narrative: SearchParameter CanonicalResource-url

12.22.39 url

Parameter url : uri

PlanDefinition : The uri that identifies the plan definition

Resource PlanDefinition
Expression PlanDefinition.url
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-version
This search parameter is part of the common search parameter CanonicalResource-version

12.23.40 Generated Narrative: SearchParameter CanonicalResource-version

12.22.40 version

Parameter version : token

PlanDefinition : The business version of the plan definition

Resource PlanDefinition
Expression PlanDefinition.version
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true