Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.2.15 Resource CapabilityStatement - Search Parameters

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Search Parameter Registry for the capabilitystatement resource

5.2.16 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

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

5.2.17 context

Parameter context:token

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
Expression(CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept)
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-context-quantity

5.2.18 context-quantity

Parameter context-quantity:quantity

Multiple Resources:

  • CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement
  • 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
  • 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
  • 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
  • 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
  • ValueSet: A quantity- or range-valued use context assigned to the value set
ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
Expression(CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range)
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/conformance-context-type

5.2.19 context-type

Parameter context-type:token

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity

5.2.20 context-type-quantity

Parameter context-type-quantity:composite

Multiple Resources:

  • CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement
  • 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
  • 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
  • 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
  • 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
  • ValueSet: A use context type and quantity- or range-based value assigned to the value set
ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
MultiplesThe parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/conformance-context-typecode
http://hl7.org/fhir/SearchParameter/conformance-context-quantityvalue.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/SearchParameter/conformance-context-type-value

5.2.21 context-type-value

Parameter context-type-value:composite

Multiple Resources:

  • CapabilityStatement: A use context type and value assigned to the capability statement
  • 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
  • GraphDefinition: A use context type and value assigned to the graph definition
  • ImplementationGuide: A use context type and value assigned to the implementation guide
  • 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
  • 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
  • ValueSet: A use context type and value assigned to the value set
ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
MultiplesThe parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/conformance-context-typecode
http://hl7.org/fhir/SearchParameter/conformance-contextvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/conformance-date

5.2.22 date

Parameter date:date

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/conformance-description

5.2.23 description

Parameter description:string

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-fhirversion

5.2.24 fhirversion

Parameter fhirversion:token

The version of FHIR

ResourceCapabilityStatement
ExpressionCapabilityStatement.fhirVersion
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-format

5.2.25 format

Parameter format:token

formats supported (xml | json | ttl | mime type)

ResourceCapabilityStatement
ExpressionCapabilityStatement.format
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-guide

5.2.26 guide

Parameter guide:reference

Implementation guides supported

ResourceCapabilityStatement
ExpressionCapabilityStatement.implementationGuide
Target ResourcesImplementationGuide
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-jurisdiction

5.2.27 jurisdiction

Parameter jurisdiction:token

Multiple Resources:

ResourcesCapabilityStatementCodeSystemConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | ValueSet.jurisdiction
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-mode

5.2.28 mode

Parameter mode:token

Mode - restful (server/client) or messaging (sender/receiver)

ResourceCapabilityStatement
ExpressionCapabilityStatement.rest.mode
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-name

5.2.29 name

Parameter name:string

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-publisher

5.2.30 publisher

Parameter publisher:string

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource

5.2.31 resource

Parameter resource:token

Name of a resource mentioned in a capability statement

ResourceCapabilityStatement
ExpressionCapabilityStatement.rest.resource.type
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource-profile

5.2.32 resource-profile

Parameter resource-profile:reference

A profile id invoked in a capability statement

ResourceCapabilityStatement
ExpressionCapabilityStatement.rest.resource.profile
Target ResourcesStructureDefinition
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-security-service

5.2.33 security-service

Parameter security-service:token

OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates

ResourceCapabilityStatement
ExpressionCapabilityStatement.rest.security.service
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-software

5.2.34 software

Parameter software:string

Part of the name of a software application

ResourceCapabilityStatement
ExpressionCapabilityStatement.software.name
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-status

5.2.35 status

Parameter status:token

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CapabilityStatement-supported-profile

5.2.36 supported-profile

Parameter supported-profile:reference

Profiles for use cases supported

ResourceCapabilityStatement
ExpressionCapabilityStatement.rest.resource.supportedProfile
Target ResourcesStructureDefinition
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-title

5.2.37 title

Parameter title:string

Multiple Resources:

ResourcesCapabilityStatementCodeSystemConceptMapImplementationGuideMessageDefinitionOperationDefinitionStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.title | CodeSystem.title | ConceptMap.title | ImplementationGuide.title | MessageDefinition.title | OperationDefinition.title | StructureDefinition.title | StructureMap.title | TerminologyCapabilities.title | ValueSet.title
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-url

5.2.38 url

Parameter url:uri

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | NamingSystem.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-version

5.2.39 version

Parameter version:token

Multiple Resources:

ResourcesCapabilityStatementCodeSystemCompartmentDefinitionConceptMapGraphDefinitionImplementationGuideMessageDefinitionNamingSystemOperationDefinitionSearchParameterStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | NamingSystem.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version
MultiplesThe parameter cannot repeat or have multiple values