PlanDefinition - FHIR v6.0.0-ballot3

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

12.23.13 Resource PlanDefinition - Search Parameters

Clinical Decision Support icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Business

Compartments: No defined compartments

Search parameters for the PlanDefinition 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

Generated Narrative: SearchParameter MetadataResource-composed-of

12.23.14 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 Account, ActivityDefinition, ActorDefinition, AdministrableProductDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, ArtifactAssessment, AuditEvent, Basic, Binary, BiologicallyDerivedProduct, BiologicallyDerivedProductDispense, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, ChargeItem, ChargeItemDefinition, Citation, Claim, ClaimResponse, ClinicalUseDefinition, CodeSystem, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, ConditionDefinition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceAssociation, DeviceDefinition, DeviceDispense, DeviceMetric, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentReference, Encounter, EncounterHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, FormularyItem, GenomicStudy, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, ImagingSelection, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, Ingredient, InsurancePlan, InventoryItem, InventoryReport, Invoice, Library, Linkage, List, Location, ManufacturedItemDefinition, Measure, MeasureReport, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProductDefinition, MessageDefinition, MessageHeader, NamingSystem, NutritionIntake, NutritionOrder, NutritionProduct, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PackagedProductDefinition, Parameters, Patient, PaymentNotice, PaymentReconciliation, Permission, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RegulatedAuthorization, RelatedPerson, RequestOrchestration, Requirements, ResearchStudy, ResearchSubject, RiskAssessment, Schedule, SearchParameter, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Subscription, SubscriptionStatus, SubscriptionTopic, Substance, SubstanceDefinition, SupplyDelivery, SupplyRequest, Task, TerminologyCapabilities, Transport, ValueSet, VerificationResult, VisionPrescription

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-context

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

Generated Narrative: SearchParameter CanonicalResource-context

12.23.15 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

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-context-quantity

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

Generated Narrative: SearchParameter CanonicalResource-context-quantity

12.23.16 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

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

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

Generated Narrative: SearchParameter CanonicalResource-context-type

12.23.17 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

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-context-type-quantity

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

Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

12.23.18 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

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

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

Generated Narrative: SearchParameter CanonicalResource-context-type-value

12.23.19 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

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

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

Generated Narrative: SearchParameter CanonicalResource-date

12.23.20 date

Parameter date:date

PlanDefinition: The plan definition publication date

Resource PlanDefinition

Expression PlanDefinition.date

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

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

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

Generated Narrative: SearchParameter PlanDefinition-definition

12.23.21 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

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-depends-on

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

Generated Narrative: SearchParameter MetadataResource-depends-on

12.23.22 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

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-derived-from

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

Generated Narrative: SearchParameter MetadataResource-derived-from

12.23.23 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

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-description

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

Generated Narrative: SearchParameter CanonicalResource-description

12.23.24 description

Parameter description:string

PlanDefinition: The description of the plan definition

Resource PlanDefinition

Expression PlanDefinition.description

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/MetadataResource-effective

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

Generated Narrative: SearchParameter MetadataResource-effective

12.23.25 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

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

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

Generated Narrative: SearchParameter CanonicalResource-identifier

12.23.26 identifier

Parameter identifier:token

PlanDefinition: External identifier for the plan definition

Resource PlanDefinition

Expression PlanDefinition.identifier

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-jurisdiction

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

Generated Narrative: SearchParameter CanonicalResource-jurisdiction

12.23.27 jurisdiction

Parameter jurisdiction:token

PlanDefinition: Jurisdiction of the authority that maintains the the plan definition

Resource PlanDefinition

Expression PlanDefinition.jurisdiction

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-name

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

Generated Narrative: SearchParameter CanonicalResource-name

12.23.28 name

Parameter name:string

PlanDefinition: Computationally friendly name of the plan definition

Resource PlanDefinition

Expression PlanDefinition.name

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/MetadataResource-predecessor

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

Generated Narrative: SearchParameter MetadataResource-predecessor

12.23.29 predecessor

Parameter predecessor:reference

PlanDefinition: What resource is being referenced

Resource PlanDefinition

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

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-publisher

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

Generated Narrative: SearchParameter CanonicalResource-publisher

12.23.30 publisher

Parameter publisher:string

PlanDefinition: Name of the publisher of the plan definition

Resource PlanDefinition

Expression PlanDefinition.publisher

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-status

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

Generated Narrative: SearchParameter CanonicalResource-status

12.23.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.23.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

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-code

Generated Narrative: SearchParameter PlanDefinition-subject-code

12.23.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.23.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

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

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-title

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

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

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-topic

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

Generated Narrative: SearchParameter MetadataResource-topic

12.23.37 topic

Parameter topic:token

PlanDefinition: Topics associated with the module

Resource PlanDefinition

Expression PlanDefinition.topic

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-type

Generated Narrative: 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

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-url

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

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

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-version

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

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

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