ActivityDefinition - FHIR v5.0.0

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

12.22.14 Resource ActivityDefinition - Search Parameters

Clinical Decision Support icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Anonymous

Compartments: No defined compartments

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

12.22.15 composed-of

Parameter composed-of:reference

Multiple Resources:

ActivityDefinition: What resource is being referenced
EventDefinition: What resource is being referenced
EvidenceVariable: What resource is being referenced
Library: What resource is being referenced
Measure: What resource is being referenced
PlanDefinition: What resource is being referenced

Resources ActivityDefinition, EventDefinition, EvidenceVariable, Library, Measure, PlanDefinition

Expression ActivityDefinition.relatedArtifact.where(type='composed-of').resource | EventDefinition.relatedArtifact.where(type='composed-of').resource | EvidenceVariable.relatedArtifact.where(type='composed-of').resource | Library.relatedArtifact.where(type='composed-of').resource | Measure.relatedArtifact.where(type='composed-of').resource | 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

12.22.16 context

Parameter context:token

Multiple Resources:

ActivityDefinition: A use context assigned to the activity definition
ActorDefinition: A use context assigned to the Actor Definition
CapabilityStatement: A use context assigned to the capability statement
ChargeItemDefinition: A use context assigned to the charge item definition
Citation: A use context assigned to the citation
CodeSystem: A use context assigned to the code system
CompartmentDefinition: A use context assigned to the compartment definition
ConceptMap: A use context assigned to the concept map
ConditionDefinition: A use context assigned to the condition definition
EventDefinition: A use context assigned to the event definition
Evidence: A use context assigned to the evidence
EvidenceReport: A use context assigned to the evidence report
EvidenceVariable: A use context assigned to the evidence variable
ExampleScenario: A use context assigned to the example scenario
GraphDefinition: A use context assigned to the graph definition
ImplementationGuide: A use context assigned to the implementation guide
Library: A use context assigned to the library
Measure: A use context assigned to the measure
MessageDefinition: A use context assigned to the message definition
NamingSystem: A use context assigned to the naming system
OperationDefinition: A use context assigned to the operation definition
PlanDefinition: A use context assigned to the plan definition
Questionnaire: A use context assigned to the questionnaire
Requirements: A use context assigned to the requirements
SearchParameter: A use context assigned to the search parameter
StructureDefinition: A use context assigned to the structure definition
StructureMap: A use context assigned to the structure map
TerminologyCapabilities: A use context assigned to the terminology capabilities
TestScript: A use context assigned to the test script
ValueSet: A use context assigned to the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, StructureDefinition, StructureMap, TerminologyCapabilities, TestScript, ValueSet

Expression (ActivityDefinition.useContext.value.ofType(CodeableConcept)) | (ActorDefinition.useContext.value.ofType(CodeableConcept)) | (CapabilityStatement.useContext.value.ofType(CodeableConcept)) | (ChargeItemDefinition.useContext.value.ofType(CodeableConcept)) | (Citation.useContext.value.ofType(CodeableConcept)) | (CodeSystem.useContext.value.ofType(CodeableConcept)) | (CompartmentDefinition.useContext.value.ofType(CodeableConcept)) | (ConceptMap.useContext.value.ofType(CodeableConcept)) | (ConditionDefinition.useContext.value.ofType(CodeableConcept)) | (EventDefinition.useContext.value.ofType(CodeableConcept)) | (Evidence.useContext.value.ofType(CodeableConcept)) | (EvidenceReport.useContext.value.ofType(CodeableConcept)) | (EvidenceVariable.useContext.value.ofType(CodeableConcept)) | (ExampleScenario.useContext.value.ofType(CodeableConcept)) | (GraphDefinition.useContext.value.ofType(CodeableConcept)) | (ImplementationGuide.useContext.value.ofType(CodeableConcept)) | (Library.useContext.value.ofType(CodeableConcept)) | (Measure.useContext.value.ofType(CodeableConcept)) | (MessageDefinition.useContext.value.ofType(CodeableConcept)) | (NamingSystem.useContext.value.ofType(CodeableConcept)) | (OperationDefinition.useContext.value.ofType(CodeableConcept)) | (PlanDefinition.useContext.value.ofType(CodeableConcept)) | (Questionnaire.useContext.value.ofType(CodeableConcept)) | (Requirements.useContext.value.ofType(CodeableConcept)) | (SearchParameter.useContext.value.ofType(CodeableConcept)) | (StructureDefinition.useContext.value.ofType(CodeableConcept)) | (StructureMap.useContext.value.ofType(CodeableConcept)) | (TerminologyCapabilities.useContext.value.ofType(CodeableConcept)) | (TestScript.useContext.value.ofType(CodeableConcept)) | (ValueSet.useContext.value.ofType(CodeableConcept))

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.17 context-quantity

Parameter context-quantity:quantity

Multiple Resources:

ActivityDefinition: A quantity- or range-valued use context assigned to the activity definition
ActorDefinition: A quantity- or range-valued use context assigned to the Actor Definition
CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement
ChargeItemDefinition: A quantity- or range-valued use context assigned to the charge item definition
Citation: A quantity- or range-valued use context assigned to the citation
CodeSystem: A quantity- or range-valued use context assigned to the code system
CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition
ConceptMap: A quantity- or range-valued use context assigned to the concept map
ConditionDefinition: A quantity- or range-valued use context assigned to the condition definition
EventDefinition: A quantity- or range-valued use context assigned to the event definition
Evidence: A quantity- or range-valued use context assigned to the evidence
EvidenceReport: A quantity- or range-valued use context assigned to the evidence report
EvidenceVariable: A quantity- or range-valued use context assigned to the evidence variable
ExampleScenario: A quantity- or range-valued use context assigned to the example scenario
GraphDefinition: A quantity- or range-valued use context assigned to the graph definition
ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide
Library: A quantity- or range-valued use context assigned to the library
Measure: A quantity- or range-valued use context assigned to the measure
MessageDefinition: A quantity- or range-valued use context assigned to the message definition
NamingSystem: A quantity- or range-valued use context assigned to the naming system
OperationDefinition: A quantity- or range-valued use context assigned to the operation definition
PlanDefinition: A quantity- or range-valued use context assigned to the plan definition
Questionnaire: A quantity- or range-valued use context assigned to the questionnaire
Requirements: A quantity- or range-valued use context assigned to the requirements
SearchParameter: A quantity- or range-valued use context assigned to the search parameter
StructureDefinition: A quantity- or range-valued use context assigned to the structure definition
StructureMap: A quantity- or range-valued use context assigned to the structure map
TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities
TestScript: A quantity- or range-valued use context assigned to the test script
ValueSet: A quantity- or range-valued use context assigned to the value set

Expression (ActivityDefinition.useContext.value.ofType(Quantity)) | (ActivityDefinition.useContext.value.ofType(Range)) | (ActorDefinition.useContext.value.ofType(Quantity)) | (ActorDefinition.useContext.value.ofType(Range)) | (CapabilityStatement.useContext.value.ofType(Quantity)) | (CapabilityStatement.useContext.value.ofType(Range)) | (ChargeItemDefinition.useContext.value.ofType(Quantity)) | (ChargeItemDefinition.useContext.value.ofType(Range)) | (Citation.useContext.value.ofType(Quantity)) | (Citation.useContext.value.ofType(Range)) | (CodeSystem.useContext.value.ofType(Quantity)) | (CodeSystem.useContext.value.ofType(Range)) | (CompartmentDefinition.useContext.value.ofType(Quantity)) | (CompartmentDefinition.useContext.value.ofType(Range)) | (ConceptMap.useContext.value.ofType(Quantity)) | (ConceptMap.useContext.value.ofType(Range)) | (ConditionDefinition.useContext.value.ofType(Quantity)) | (ConditionDefinition.useContext.value.ofType(Range)) | (EventDefinition.useContext.value.ofType(Quantity)) | (EventDefinition.useContext.value.ofType(Range)) | (Evidence.useContext.value.ofType(Quantity)) | (Evidence.useContext.value.ofType(Range)) | (EvidenceReport.useContext.value.ofType(Quantity)) | (EvidenceReport.useContext.value.ofType(Range)) | (EvidenceVariable.useContext.value.ofType(Quantity)) | (EvidenceVariable.useContext.value.ofType(Range)) | (ExampleScenario.useContext.value.ofType(Quantity)) | (ExampleScenario.useContext.value.ofType(Range)) | (GraphDefinition.useContext.value.ofType(Quantity)) | (GraphDefinition.useContext.value.ofType(Range)) | (ImplementationGuide.useContext.value.ofType(Quantity)) | (ImplementationGuide.useContext.value.ofType(Range)) | (Library.useContext.value.ofType(Quantity)) | (Library.useContext.value.ofType(Range)) | (Measure.useContext.value.ofType(Quantity)) | (Measure.useContext.value.ofType(Range)) | (MessageDefinition.useContext.value.ofType(Quantity)) | (MessageDefinition.useContext.value.ofType(Range)) | (NamingSystem.useContext.value.ofType(Quantity)) | (NamingSystem.useContext.value.ofType(Range)) | (OperationDefinition.useContext.value.ofType(Quantity)) | (OperationDefinition.useContext.value.ofType(Range)) | (PlanDefinition.useContext.value.ofType(Quantity)) | (PlanDefinition.useContext.value.ofType(Range)) | (Questionnaire.useContext.value.ofType(Quantity)) | (Questionnaire.useContext.value.ofType(Range)) | (Requirements.useContext.value.ofType(Quantity)) | (Requirements.useContext.value.ofType(Range)) | (SearchParameter.useContext.value.ofType(Quantity)) | (SearchParameter.useContext.value.ofType(Range)) | (StructureDefinition.useContext.value.ofType(Quantity)) | (StructureDefinition.useContext.value.ofType(Range)) | (StructureMap.useContext.value.ofType(Quantity)) | (StructureMap.useContext.value.ofType(Range)) | (TerminologyCapabilities.useContext.value.ofType(Quantity)) | (TerminologyCapabilities.useContext.value.ofType(Range)) | (TestScript.useContext.value.ofType(Quantity)) | (TestScript.useContext.value.ofType(Range)) | (ValueSet.useContext.value.ofType(Quantity)) | (ValueSet.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

12.22.18 context-type

Parameter context-type:token

Multiple Resources:

ActivityDefinition: A type of use context assigned to the activity definition
ActorDefinition: A type of use context assigned to the Actor Definition
CapabilityStatement: A type of use context assigned to the capability statement
ChargeItemDefinition: A type of use context assigned to the charge item definition
Citation: A type of use context assigned to the citation
CodeSystem: A type of use context assigned to the code system
CompartmentDefinition: A type of use context assigned to the compartment definition
ConceptMap: A type of use context assigned to the concept map
ConditionDefinition: A type of use context assigned to the condition definition
EventDefinition: A type of use context assigned to the event definition
Evidence: A type of use context assigned to the evidence
EvidenceReport: A type of use context assigned to the evidence report
EvidenceVariable: A type of use context assigned to the evidence variable
ExampleScenario: A type of use context assigned to the example scenario
GraphDefinition: A type of use context assigned to the graph definition
ImplementationGuide: A type of use context assigned to the implementation guide
Library: A type of use context assigned to the library
Measure: A type of use context assigned to the measure
MessageDefinition: A type of use context assigned to the message definition
NamingSystem: A type of use context assigned to the naming system
OperationDefinition: A type of use context assigned to the operation definition
PlanDefinition: A type of use context assigned to the plan definition
Questionnaire: A type of use context assigned to the questionnaire
Requirements: A type of use context assigned to the requirements
SearchParameter: A type of use context assigned to the search parameter
StructureDefinition: A type of use context assigned to the structure definition
StructureMap: A type of use context assigned to the structure map
TerminologyCapabilities: A type of use context assigned to the terminology capabilities
TestScript: A type of use context assigned to the test script
ValueSet: A type of use context assigned to the value set

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.19 context-type-quantity

Parameter context-type-quantity:composite

Multiple Resources:

ActivityDefinition: A use context type and quantity- or range-based value assigned to the activity definition
ActorDefinition: A use context type and quantity- or range-based value assigned to the Actor Definition
CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement
ChargeItemDefinition: A use context type and quantity- or range-based value assigned to the charge item definition
Citation: A use context type and quantity- or range-based value assigned to the citation
CodeSystem: A use context type and quantity- or range-based value assigned to the code system
CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition
ConceptMap: A use context type and quantity- or range-based value assigned to the concept map
ConditionDefinition: A use context type and quantity- or range-based value assigned to the condition definition
EventDefinition: A use context type and quantity- or range-based value assigned to the event definition
Evidence: A use context type and quantity- or range-based value assigned to the evidence
EvidenceReport: A use context type and quantity- or range-based value assigned to the evidence report
EvidenceVariable: A use context type and quantity- or range-based value assigned to the evidence variable
ExampleScenario: A use context type and quantity- or range-based value assigned to the example scenario
GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition
ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide
Library: A use context type and quantity- or range-based value assigned to the library
Measure: A use context type and quantity- or range-based value assigned to the measure
MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition
NamingSystem: A use context type and quantity- or range-based value assigned to the naming system
OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition
PlanDefinition: A use context type and quantity- or range-based value assigned to the plan definition
Questionnaire: A use context type and quantity- or range-based value assigned to the questionnaire
Requirements: A use context type and quantity- or range-based value assigned to the requirements
SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter
StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition
StructureMap: A use context type and quantity- or range-based value assigned to the structure map
TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities
TestScript: A use context type and quantity- or range-based value assigned to the test script
ValueSet: A use context type and quantity- or range-based value assigned to the value set

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

12.22.20 context-type-value

Parameter context-type-value:composite

Multiple Resources:

ActivityDefinition: A use context type and value assigned to the activity definition
ActorDefinition: A use context type and value assigned to the Actor Definition
CapabilityStatement: A use context type and value assigned to the capability statement
ChargeItemDefinition: A use context type and value assigned to the charge item definition
Citation: A use context type and value assigned to the citation
CodeSystem: A use context type and value assigned to the code system
CompartmentDefinition: A use context type and value assigned to the compartment definition
ConceptMap: A use context type and value assigned to the concept map
ConditionDefinition: A use context type and value assigned to the condition definition
EventDefinition: A use context type and value assigned to the event definition
Evidence: A use context type and value assigned to the evidence
EvidenceReport: A use context type and value assigned to the evidence report
EvidenceVariable: A use context type and value assigned to the evidence variable
ExampleScenario: A use context type and value assigned to the example scenario
GraphDefinition: A use context type and value assigned to the graph definition
ImplementationGuide: A use context type and value assigned to the implementation guide
Library: A use context type and value assigned to the library
Measure: A use context type and value assigned to the measure
MessageDefinition: A use context type and value assigned to the message definition
NamingSystem: A use context type and value assigned to the naming system
OperationDefinition: A use context type and value assigned to the operation definition
PlanDefinition: A use context type and value assigned to the plan definition
Questionnaire: A use context type and value assigned to the questionnaire
Requirements: A use context type and value assigned to the requirements
SearchParameter: A use context type and value assigned to the search parameter
StructureDefinition: A use context type and value assigned to the structure definition
StructureMap: A use context type and value assigned to the structure map
TerminologyCapabilities: A use context type and value assigned to the terminology capabilities
TestScript: A use context type and value assigned to the test script
ValueSet: A use context type and value assigned to the value set

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

12.22.21 date

Parameter date:date

Multiple Resources:

ActivityDefinition: The activity definition publication date
ActorDefinition: The Actor Definition publication date
CapabilityStatement: The capability statement publication date
ChargeItemDefinition: The charge item definition publication date
Citation: The citation publication date
CodeSystem: The code system publication date
CompartmentDefinition: The compartment definition publication date
ConceptMap: The concept map publication date
ConditionDefinition: The condition definition publication date
EventDefinition: The event definition publication date
Evidence: The evidence publication date
EvidenceVariable: The evidence variable publication date
ExampleScenario: The example scenario publication date
GraphDefinition: The graph definition publication date
ImplementationGuide: The implementation guide publication date
Library: The library publication date
Measure: The measure publication date
MessageDefinition: The message definition publication date
NamingSystem: The naming system publication date
OperationDefinition: The operation definition publication date
PlanDefinition: The plan definition publication date
Questionnaire: The questionnaire publication date
Requirements: The requirements publication date
SearchParameter: The search parameter publication date
StructureDefinition: The structure definition publication date
StructureMap: The structure map publication date
SubscriptionTopic: Date status first applied
TerminologyCapabilities: The terminology capabilities publication date
TestScript: The test script publication date
ValueSet: The value set publication date

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestScript, ValueSet

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

12.22.22 depends-on

Parameter depends-on:reference

Multiple Resources:

ActivityDefinition: What resource is being referenced
EventDefinition: What resource is being referenced
EvidenceVariable: What resource is being referenced
Library: What resource is being referenced
Measure: What resource is being referenced
PlanDefinition: What resource is being referenced

Resources ActivityDefinition, EventDefinition, EvidenceVariable, Library, Measure, PlanDefinition

Expression ActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library | EventDefinition.relatedArtifact.where(type='depends-on').resource | EvidenceVariable.relatedArtifact.where(type='depends-on').resource | Library.relatedArtifact.where(type='depends-on').resource | Measure.relatedArtifact.where(type='depends-on').resource | Measure.library | 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

12.22.23 derived-from

Parameter derived-from:reference

Multiple Resources:

ActivityDefinition: What resource is being referenced
CodeSystem: A resource that the CodeSystem is derived from
ConceptMap: A resource that the ConceptMap is derived from
EventDefinition: What resource is being referenced
EvidenceVariable: What resource is being referenced
Library: What resource is being referenced
Measure: What resource is being referenced
NamingSystem: A resource that the NamingSystem is derived from
PlanDefinition: What resource is being referenced
ValueSet: A resource that the ValueSet is derived from

Resources ActivityDefinition, CodeSystem, ConceptMap, EventDefinition, EvidenceVariable, Library, Measure, NamingSystem, PlanDefinition, ValueSet

Expression ActivityDefinition.relatedArtifact.where(type='derived-from').resource | CodeSystem.relatedArtifact.where(type='derived-from').resource | ConceptMap.relatedArtifact.where(type='derived-from').resource | EventDefinition.relatedArtifact.where(type='derived-from').resource | EvidenceVariable.relatedArtifact.where(type='derived-from').resource | Library.relatedArtifact.where(type='derived-from').resource | Measure.relatedArtifact.where(type='derived-from').resource | NamingSystem.relatedArtifact.where(type='derived-from').resource | PlanDefinition.relatedArtifact.where(type='derived-from').resource | ValueSet.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

12.22.24 description

Parameter description:string

Multiple Resources:

ActivityDefinition: The description of the activity definition
ActorDefinition: The description of the Actor Definition
CapabilityStatement: The description of the capability statement
ChargeItemDefinition: The description of the charge item definition
Citation: The description of the citation
CodeSystem: The description of the code system
CompartmentDefinition: The description of the compartment definition
ConceptMap: The description of the concept map
ConditionDefinition: The description of the condition definition
EventDefinition: The description of the event definition
Evidence: The description of the evidence
EvidenceVariable: The description of the evidence variable
GraphDefinition: The description of the graph definition
ImplementationGuide: The description of the implementation guide
Library: The description of the library
Measure: The description of the measure
MessageDefinition: The description of the message definition
NamingSystem: The description of the naming system
OperationDefinition: The description of the operation definition
PlanDefinition: The description of the plan definition
Questionnaire: The description of the questionnaire
Requirements: The description of the requirements
SearchParameter: The description of the search parameter
StructureDefinition: The description of the structure definition
StructureMap: The description of the structure map
TerminologyCapabilities: The description of the terminology capabilities
TestScript: The description of the test script
ValueSet: The description of the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceVariable, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, StructureDefinition, StructureMap, TerminologyCapabilities, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.25 effective

Parameter effective:date

Multiple Resources:

ActivityDefinition: The time during which the activity definition is intended to be in use
ChargeItemDefinition: The time during which the charge item definition is intended to be in use
Citation: The time during which the citation is intended to be in use
CodeSystem: The time during which the CodeSystem is intended to be in use
ConceptMap: The time during which the ConceptMap is intended to be in use
EventDefinition: The time during which the event definition is intended to be in use
Library: The time during which the library is intended to be in use
Measure: The time during which the measure is intended to be in use
NamingSystem: The time during which the NamingSystem is intended to be in use
PlanDefinition: The time during which the plan definition is intended to be in use
Questionnaire: The time during which the questionnaire is intended to be in use
ValueSet: The time during which the ValueSet is intended to be in use

Resources ActivityDefinition, ChargeItemDefinition, Citation, CodeSystem, ConceptMap, EventDefinition, Library, Measure, NamingSystem, PlanDefinition, Questionnaire, ValueSet

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

12.22.26 identifier

Parameter identifier:token

Multiple Resources:

ActivityDefinition: External identifier for the activity definition
ActorDefinition: External identifier for the Actor Definition
CapabilityStatement: External identifier for the capability statement
ChargeItemDefinition: External identifier for the charge item definition
Citation: External identifier for the citation
CodeSystem: External identifier for the code system
ConceptMap: External identifier for the concept map
ConditionDefinition: External identifier for the condition definition
EventDefinition: External identifier for the event definition
Evidence: External identifier for the evidence
EvidenceReport: External identifier for the evidence report
EvidenceVariable: External identifier for the evidence variable
ExampleScenario: External identifier for the example scenario
GraphDefinition: External identifier for the graph definition
ImplementationGuide: External identifier for the implementation guide
Library: External identifier for the library
Measure: External identifier for the measure
MedicationKnowledge: Business identifier for this medication
MessageDefinition: External identifier for the message definition
NamingSystem: External identifier for the naming system
ObservationDefinition: The unique identifier associated with the specimen definition
OperationDefinition: External identifier for the search parameter
PlanDefinition: External identifier for the plan definition
Questionnaire: External identifier for the questionnaire
Requirements: External identifier for the requirements
SearchParameter: External identifier for the search parameter
SpecimenDefinition: The unique identifier associated with the SpecimenDefinition
StructureDefinition: External identifier for the structure definition
StructureMap: External identifier for the structure map
SubscriptionTopic: Business Identifier for SubscriptionTopic
TerminologyCapabilities: External identifier for the terminology capabilities
TestPlan: An identifier for the test plan
TestScript: External identifier for the test script
ValueSet: External identifier for the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MedicationKnowledge, MessageDefinition, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.27 jurisdiction

Parameter jurisdiction:token

Multiple Resources:

ActivityDefinition: Intended jurisdiction for the activity definition
ActorDefinition: Intended jurisdiction for the Actor Definition
CapabilityStatement: Intended jurisdiction for the capability statement
ChargeItemDefinition: Intended jurisdiction for the charge item definition
Citation: Intended jurisdiction for the citation
CodeSystem: Intended jurisdiction for the code system
ConceptMap: Intended jurisdiction for the concept map
ConditionDefinition: Intended jurisdiction for the condition definition
EventDefinition: Intended jurisdiction for the event definition
ExampleScenario: Intended jurisdiction for the example scenario
GraphDefinition: Intended jurisdiction for the graph definition
ImplementationGuide: Intended jurisdiction for the implementation guide
Library: Intended jurisdiction for the library
Measure: Intended jurisdiction for the measure
MessageDefinition: Intended jurisdiction for the message definition
NamingSystem: Intended jurisdiction for the naming system
OperationDefinition: Intended jurisdiction for the operation definition
PlanDefinition: Intended jurisdiction for the plan definition
Questionnaire: Intended jurisdiction for the questionnaire
Requirements: Intended jurisdiction for the requirements
SearchParameter: Intended jurisdiction for the search parameter
StructureDefinition: Intended jurisdiction for the structure definition
StructureMap: Intended jurisdiction for the structure map
TerminologyCapabilities: Intended jurisdiction for the terminology capabilities
TestScript: Intended jurisdiction for the test script
ValueSet: Intended jurisdiction for the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, ConceptMap, ConditionDefinition, EventDefinition, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, StructureDefinition, StructureMap, TerminologyCapabilities, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/ActivityDefinition-kind

12.22.28 kind

Parameter kind:token

The kind of activity definition

Resource ActivityDefinition

Expression ActivityDefinition.kind

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.29 name

Parameter name:string

Multiple Resources:

ActivityDefinition: Computationally friendly name of the activity definition
CapabilityStatement: Computationally friendly name of the capability statement
Citation: Computationally friendly name of the citation
CodeSystem: Computationally friendly name of the code system
CompartmentDefinition: Computationally friendly name of the compartment definition
ConceptMap: Computationally friendly name of the concept map
ConditionDefinition: Computationally friendly name of the condition definition
EventDefinition: Computationally friendly name of the event definition
EvidenceVariable: Computationally friendly name of the evidence variable
ExampleScenario: Computationally friendly name of the example scenario
GraphDefinition: Computationally friendly name of the graph definition
ImplementationGuide: Computationally friendly name of the implementation guide
Library: Computationally friendly name of the library
Measure: Computationally friendly name of the measure
MessageDefinition: Computationally friendly name of the message definition
NamingSystem: Computationally friendly name of the naming system
OperationDefinition: Computationally friendly name of the operation definition
PlanDefinition: Computationally friendly name of the plan definition
Questionnaire: Computationally friendly name of the questionnaire
Requirements: Computationally friendly name of the requirements
SearchParameter: Computationally friendly name of the search parameter
StructureDefinition: Computationally friendly name of the structure definition
StructureMap: Computationally friendly name of the structure map
TerminologyCapabilities: Computationally friendly name of the terminology capabilities
TestScript: Computationally friendly name of the test script
ValueSet: Computationally friendly name of the value set

Resources ActivityDefinition, CapabilityStatement, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, StructureDefinition, StructureMap, TerminologyCapabilities, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.30 predecessor

Parameter predecessor:reference

Multiple Resources:

ActivityDefinition: What resource is being referenced
CodeSystem: The predecessor of the CodeSystem
ConceptMap: The predecessor of the ConceptMap
EventDefinition: What resource is being referenced
EvidenceVariable: What resource is being referenced
Library: What resource is being referenced
Measure: What resource is being referenced
NamingSystem: The predecessor of the NamingSystem
PlanDefinition: What resource is being referenced
ValueSet: The predecessor of the ValueSet

Resources ActivityDefinition, CodeSystem, ConceptMap, EventDefinition, EvidenceVariable, Library, Measure, NamingSystem, PlanDefinition, ValueSet

Expression ActivityDefinition.relatedArtifact.where(type='predecessor').resource | CodeSystem.relatedArtifact.where(type='predecessor').resource | ConceptMap.relatedArtifact.where(type='predecessor').resource | EventDefinition.relatedArtifact.where(type='predecessor').resource | EvidenceVariable.relatedArtifact.where(type='predecessor').resource | Library.relatedArtifact.where(type='predecessor').resource | Measure.relatedArtifact.where(type='predecessor').resource | NamingSystem.relatedArtifact.where(type='predecessor').resource | PlanDefinition.relatedArtifact.where(type='predecessor').resource | ValueSet.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

12.22.31 publisher

Parameter publisher:string

Multiple Resources:

ActivityDefinition: Name of the publisher of the activity definition
ActorDefinition: Name of the publisher of the Actor Definition
CapabilityStatement: Name of the publisher of the capability statement
ChargeItemDefinition: Name of the publisher of the charge item definition
Citation: Name of the publisher of the citation
CodeSystem: Name of the publisher of the code system
CompartmentDefinition: Name of the publisher of the compartment definition
ConceptMap: Name of the publisher of the concept map
ConditionDefinition: Name of the publisher of the condition definition
EventDefinition: Name of the publisher of the event definition
Evidence: Name of the publisher of the evidence
EvidenceReport: Name of the publisher of the evidence report
EvidenceVariable: Name of the publisher of the evidence variable
ExampleScenario: Name of the publisher of the example scenario
GraphDefinition: Name of the publisher of the graph definition
ImplementationGuide: Name of the publisher of the implementation guide
Library: Name of the publisher of the library
Measure: Name of the publisher of the measure
MessageDefinition: Name of the publisher of the message definition
NamingSystem: Name of the publisher of the naming system
OperationDefinition: Name of the publisher of the operation definition
PlanDefinition: Name of the publisher of the plan definition
Questionnaire: Name of the publisher of the questionnaire
Requirements: Name of the publisher of the requirements
SearchParameter: Name of the publisher of the search parameter
StructureDefinition: Name of the publisher of the structure definition
StructureMap: Name of the publisher of the structure map
TerminologyCapabilities: Name of the publisher of the terminology capabilities
TestScript: Name of the publisher of the test script
ValueSet: Name of the publisher of the value set

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.32 status

Parameter status:token

Multiple Resources:

ActivityDefinition: The current status of the activity definition
ActorDefinition: The current status of the Actor Definition
CapabilityStatement: The current status of the capability statement
ChargeItemDefinition: The current status of the charge item definition
Citation: The current status of the citation
CodeSystem: The current status of the code system
CompartmentDefinition: The current status of the compartment definition
ConceptMap: The current status of the concept map
ConditionDefinition: The current status of the condition definition
EventDefinition: The current status of the event definition
Evidence: The current status of the evidence
EvidenceReport: The current status of the evidence report
EvidenceVariable: The current status of the evidence variable
ExampleScenario: The current status of the example scenario
GraphDefinition: The current status of the graph definition
ImplementationGuide: The current status of the implementation guide
Library: The current status of the library
Measure: The current status of the measure
MedicationKnowledge: active | inactive | entered-in-error
MessageDefinition: The current status of the message definition
NamingSystem: The current status of the naming system
ObservationDefinition: Publication status of the ObservationDefinition: draft, active, retired, unknown
OperationDefinition: The current status of the operation definition
PlanDefinition: The current status of the plan definition
Questionnaire: The current status of the questionnaire
Requirements: The current status of the requirements
SearchParameter: The current status of the search parameter
SpecimenDefinition: Publication status of the SpecimenDefinition: draft, active, retired, unknown
StructureDefinition: The current status of the structure definition
StructureMap: The current status of the structure map
SubscriptionTopic: draft | active | retired | unknown
TerminologyCapabilities: The current status of the terminology capabilities
TestPlan: The current status of the test plan
TestScript: The current status of the test script
ValueSet: The current status of the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MedicationKnowledge, MessageDefinition, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.33 successor

Parameter successor:reference

Multiple Resources:

ActivityDefinition: What resource is being referenced
EventDefinition: What resource is being referenced
EvidenceVariable: What resource is being referenced
Library: What resource is being referenced
Measure: What resource is being referenced
PlanDefinition: What resource is being referenced

Resources ActivityDefinition, EventDefinition, EvidenceVariable, Library, Measure, PlanDefinition

Expression ActivityDefinition.relatedArtifact.where(type='successor').resource | EventDefinition.relatedArtifact.where(type='successor').resource | EvidenceVariable.relatedArtifact.where(type='successor').resource | Library.relatedArtifact.where(type='successor').resource | Measure.relatedArtifact.where(type='successor').resource | 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

12.22.34 title

Parameter title:string

Multiple Resources:

ActivityDefinition: The human-friendly name of the activity definition
ActorDefinition: The human-friendly name of the Actor Definition
CapabilityStatement: The human-friendly name of the capability statement
ChargeItemDefinition: The human-friendly name of the charge item definition
Citation: The human-friendly name of the citation
CodeSystem: The human-friendly name of the code system
ConceptMap: The human-friendly name of the concept map
ConditionDefinition: The human-friendly name of the condition definition
EventDefinition: The human-friendly name of the event definition
Evidence: The human-friendly name of the evidence
EvidenceVariable: The human-friendly name of the evidence variable
ImplementationGuide: The human-friendly name of the implementation guide
Library: The human-friendly name of the library
Measure: The human-friendly name of the measure
MessageDefinition: The human-friendly name of the message definition
ObservationDefinition: Human-friendly name of the ObservationDefinition
OperationDefinition: The human-friendly name of the operation definition
PlanDefinition: The human-friendly name of the plan definition
Questionnaire: The human-friendly name of the questionnaire
Requirements: The human-friendly name of the requirements
SpecimenDefinition: Human-friendly name of the SpecimenDefinition
StructureDefinition: The human-friendly name of the structure definition
StructureMap: The human-friendly name of the structure map
SubscriptionTopic: Name for this SubscriptionTopic (Human friendly)
TerminologyCapabilities: The human-friendly name of the terminology capabilities
TestScript: The human-friendly name of the test script
ValueSet: The human-friendly name of the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceVariable, ImplementationGuide, Library, Measure, MessageDefinition, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.35 topic

Parameter topic:token

Multiple Resources:

ActivityDefinition: Topics associated with the module
CodeSystem: Topics associated with the CodeSystem
ConceptMap: Topics associated with the ConceptMap
EventDefinition: Topics associated with the module
EvidenceVariable: Topics associated with the EvidenceVariable
Library: Topics associated with the module
Measure: Topics associated with the measure
NamingSystem: Topics associated with the NamingSystem
PlanDefinition: Topics associated with the module
ValueSet: Topics associated with the ValueSet

Resources ActivityDefinition, CodeSystem, ConceptMap, EventDefinition, EvidenceVariable, Library, Measure, NamingSystem, PlanDefinition, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.36 url

Parameter url:uri

Multiple Resources:

ActivityDefinition: The uri that identifies the activity definition
ActorDefinition: The uri that identifies the Actor Definition
CapabilityStatement: The uri that identifies the capability statement
ChargeItemDefinition: The uri that identifies the charge item definition
Citation: The uri that identifies the citation
CodeSystem: The uri that identifies the code system
CompartmentDefinition: The uri that identifies the compartment definition
ConceptMap: The URI that identifies the concept map
ConditionDefinition: The uri that identifies the condition definition
EventDefinition: The uri that identifies the event definition
Evidence: The uri that identifies the evidence
EvidenceReport: The uri that identifies the evidence report
EvidenceVariable: The uri that identifies the evidence variable
ExampleScenario: The uri that identifies the example scenario
GraphDefinition: The uri that identifies the graph definition
ImplementationGuide: The uri that identifies the implementation guide
Library: The uri that identifies the library
Measure: The uri that identifies the measure
MessageDefinition: The uri that identifies the message definition
NamingSystem: The uri that identifies the naming system
ObservationDefinition: The uri that identifies the observation definition
OperationDefinition: The uri that identifies the operation definition
PlanDefinition: The uri that identifies the plan definition
Questionnaire: The uri that identifies the questionnaire
Requirements: The uri that identifies the requirements
SearchParameter: The uri that identifies the search parameter
SpecimenDefinition: The uri that identifies the specimen definition
StructureDefinition: The uri that identifies the structure definition
StructureMap: The uri that identifies the structure map
SubscriptionTopic: Logical canonical URL to reference this SubscriptionTopic (globally unique)
TerminologyCapabilities: The uri that identifies the terminology capabilities
TestPlan: The uri that identifies the test plan
TestScript: The uri that identifies the test script
ValueSet: The uri that identifies the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

12.22.37 version

Parameter version:token

Multiple Resources:

ActivityDefinition: The business version of the activity definition
ActorDefinition: The business version of the Actor Definition
CapabilityStatement: The business version of the capability statement
ChargeItemDefinition: The business version of the charge item definition
Citation: The business version of the citation
CodeSystem: The business version of the code system
CompartmentDefinition: The business version of the compartment definition
ConceptMap: The business version of the concept map
ConditionDefinition: The business version of the condition definition
EventDefinition: The business version of the event definition
Evidence: The business version of the evidence
EvidenceVariable: The business version of the evidence variable
ExampleScenario: The business version of the example scenario
GraphDefinition: The business version of the graph definition
ImplementationGuide: The business version of the implementation guide
Library: The business version of the library
Measure: The business version of the measure
MessageDefinition: The business version of the message definition
NamingSystem: The business version of the naming system
OperationDefinition: The business version of the operation definition
PlanDefinition: The business version of the plan definition
Questionnaire: The business version of the questionnaire
Requirements: The business version of the requirements
SearchParameter: The business version of the search parameter
StructureDefinition: The business version of the structure definition
StructureMap: The business version of the structure map
SubscriptionTopic: Business version of the SubscriptionTopic
TerminologyCapabilities: The business version of the terminology capabilities
TestScript: The business version of the test script
ValueSet: The business version of the value set

Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestScript, ValueSet

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values