A 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.

An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see Technical and Business Versions .

Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).

Can be a urn:uuid: or a urn:oid:, urn:oid: but real http: addresses are preferred. Multiple instances may share the same url URL if they have a distinct version.

The URL SHOULD include the major version of the search parameter. For more information see Technical and Business Versions .

The 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 refrence reference to a particular business version of the search parameter with the format [url]|[version].

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.

Support human navigation and code generation.

The name is not expected to be globally unique. The name should be a simple alpha-numeric alphanumeric type name to ensure that it is computable machine-processing friendly.

Where 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 , but detail how it is supported by the server.

The status of this search parameter. Enables tracking the life-cycle of the content.

Allows filtering of search parameters that are appropriate for use vs. versus not. This is labeled as "Is Modifier" because applications should not use a retired search parameter without due consideration.

A boolean Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), education/evaluation/marketing) and is not intended to be used for genuine usage.

Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter.

Allows filtering of search parameter parameters that are appropriate for use vs. versus not. This is labeled as "Is Modifier" because applications should not use an experimental search parameter in production.

The date (and optionally time) when the search parameter was published. The date must change if and 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.

The name of the individual or organization or individual that published the search parameter.

Helps establish the "authority/credibility" "authority/credibility" of the search parameter. May also allow for contact.

Usually an organization, 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.

Contact details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

A free text natural language description of the search parameter from a consumer's perspective. and 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 profile is presumed to be the predominant language in the place the profile was created).

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.

Assist in searching for appropriate content.

When multiple useContexts are specified, there is no expectation whether that all or any of the contexts apply.

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.

Explaination Explanation 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 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.

The 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.

The base resource type(s) that this search parameter can be used against.

A search parameter must always have apply to at least one resource type. When search parameters have apply to more than one resource, resource type, they can be used against any of the listed resource types, or in a cross-type search (see Cross Resource Search ).

The type of value a search parameter refers to, and how the content is interpreted.

A 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.

An 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.

How the search parameter relates to the set of elements returned by evaluating the xpath query.

Types of resource (if a resource is referenced).

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.

Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

Comparators supported for the search parameter.

If no comparators are listed, clients should not expect servers to support any comparators.

A modifier supported for the search parameter.

Contains 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, 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 may might not know to use them.

Used to define the parts of a composite search parameter.

The definition of the search parameter that describes this part.

A 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, definition and extracts the index values from the outcome of the composite expression.