Resource type: searchparameter

Description

A search parameter that defines a named search item that can be used to search/filter on a resource.

Elements

PathShortDefinitionComments
Search parameter for a resourceA search parameter that defines a named search item that can be used to search/filter on a resource.In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.
urlCanonical identifier for this search parameter, represented as a URI (globally unique)An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
versionBusiness version of the search parameterThe identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.There may be different search parameter instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the search parameter with the format [url]|[version].
nameName for this search parameter (computer friendly)A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
derivedFromOriginal definition for the search parameterWhere this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.The intent of this is that a server can designate that it provides support for a search parameter defined in the specification itself (e.g. [`value-quantity`](http://hl7.org/fhir/SearchParameter/Observation-value-quantity), but detail how it is supported by the server.
statusdraft | active | retired | unknownThe status of this search parameter. Enables tracking the life-cycle of the content.Allows filtering of search parameters that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.Allows filtering of search parameters that are appropriate for use versus not.
dateDate last changedThe date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the search parameter. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the search parameter.Usually an organization but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the search parameter. This item SHOULD be populated unless the information is available from context.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the search parameterAnd how it used.This description can be used to capture details such as why the search parameter was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the search parameter as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the search parameter is presumed to be the predominant language in the place the search parameter was created).
useContextThe context that the content is intended to supportThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for search parameter (if applicable)A legal or geographic region in which the search parameter is intended to be used.It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this search parameter is definedExplanation of why this search parameter is needed and why it has been designed as it has.This element does not describe the usage of the search parameter. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this search parameter.
codeCode used in URLThe code used in the URL or the parameter name in a parameters resource for this search parameter.For maximum compatibility, use only lowercase ASCII characters.
baseThe resource type(s) this search parameter applies toThe base resource type(s) that this search parameter can be used against.A search parameter must always apply to at least one resource type. When search parameters apply to more than one resource type, they can be used against any of the listed resource types, or in a cross-type search (see [Cross Resource Search](http.html#xres-search)).
typenumber | date | string | token | reference | composite | quantity | uri | specialThe type of value that a search parameter may contain, and how the content is interpreted.
expressionFHIRPath expression that extracts the valuesA FHIRPath expression that returns a set of elements for the search parameter.Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived.
xpathXPath that extracts the valuesAn XPath expression that returns a set of elements for the search parameter.Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.
xpathUsagenormal | phonetic | nearby | distance | otherHow the search parameter relates to the set of elements returned by evaluating the xpath query.
targetTypes of resource (if a resource reference)Types of resource (if a resource is referenced).
multipleOrAllow multiple values per parameter (or)Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
multipleAndAllow multiple parameters (and)Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
comparatoreq | ne | gt | lt | ge | le | sa | eb | apComparators supported for the search parameter.If no comparators are listed, clients should not expect servers to support any comparators.
modifiermissing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofTypeA modifier supported for the search parameter.
chainChained names supportedContains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.Systems are not required to list all the chain names they support, but if they don't list them, clients might not know to use them.
componentFor Composite resources to define the partsUsed to define the parts of a composite search parameter.
component.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
component.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
component.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
component.definitionDefines how the part worksThe definition of the search parameter that describes this part.
component.expressionSubexpression relative to main expressionA sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression.

Scope and Usage

A SearchParameter resource specifies a search parameter that may be used on the RESTful API to search or filter on a resource. The SearchParameter resource declares:

Boundaries and Relationships

Background and Context

Implementers should be familiar with the background and concepts described in Search on the RESTful API before working with this resource.

There is a registry of all Search Parameters.

SearchParameters on Extensions

The SearchParameter resource may be used to define searches on extensions. Depending on the context of the extension (as defined in the StructureDefinition), this may require multiple instances of the SearchParameter.xpath element like so:

Search Parameters

baseThe resource type(s) this search parameter applies toSearchParameter.base
codeCode used in URLSearchParameter.code
componentDefines how the part worksSearchParameter.component.definition
derived-fromOriginal definition for the search parameterSearchParameter.derivedFrom
targetTypes of resource (if a resource reference)SearchParameter.target
typenumber | date | string | token | reference | composite | quantity | uri | specialSearchParameter.type

Extension Definitions

These are extension definitions for this resource defined by the spec