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 an authoritative instance of this search parameter is (or will be) published. The This URL SHOULD include can be the major version target of a canonical reference. It SHALL remain the same when the search parameter. For more information see Technical and Business Versions . parameter is stored on different servers.

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

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 element to indicate where the current master source of the resource can be found.

A formal identifier that is used to identify this search parameter when it is represented in other formats, or referenced in a specification, model, design or an instance.

Allows externally provided and/or usable business identifiers to be easily associated with the module.

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]. The version SHOULD NOT contain a '#' - see Business Version .

Indicates the mechanism used to compare versions to determine which is more current.

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

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.

A short, descriptive, user-friendly title for the search parameter.

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

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. This canonical reference SHOULD always be version-specific, as different versions of the base resource may have changes that would cause the derived search parameter to not be a valid derivation.

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.

See guidance around (not) making local changes to elements here .

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 no version of this resource will ever be used intended 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. not. This is labeled as "Is Modifier" because applications should not use an experimental search parameter versus not.. Experimental resources might include example instances in production. implementation guides, instances created solely for testing purposes, etc

The date (and optionally time) when the search parameter was published. last significantly changed. 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.

The date is often not tracked until the resource is published, but may be present on draft content. 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.

See guidance around (not) making local changes to elements here .

The name of the individual or organization that published or individual responsible for the release and ongoing maintenance of 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.

See guidance around (not) making local changes to elements here .

And how it used.

This description can be used to capture details such as 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).

The content was developed with a focus and intent of supporting the contexts that are listed. These terms 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.

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 authority that maintains the resource is intended to be used. operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

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.

A copyright statement relating to the search parameter and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the search parameter.

Consumers must be able to determine any legal restrictions on the use of the search parameter and/or its content.

...

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Defines the content expected to be rendered in all representations of the artifact.

The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

The code label that is recommended to be used in the URL or the parameter name in a parameters resource for this search parameter. In some cases, servers may need to use a different CapabilityStatement searchParam.name to differentiate between multiple SearchParameters that happen to have the same code.

For maximum compatibility, use only lowercase ASCII characters and hyphens. The characters '.', '$', '|' and whitespace are prohibited as they are used as separators in search parameter processing. Note that HL7 will never define multiple search parameters with the same code.

Additional label that are recommended to be used in the URL or the parameter name in a parameters resource for this search parameter. Typically used to provide backwards-compatibility for renamed search parameters and translations into localized languages.

For maximum compatibility, use only lowercase ASCII characters. characters and hyphens.

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 that a search parameter refers to, may contain, 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 How the search parameter relates to the set of elements for returned by evaluating the search parameter. expression query.

How the search parameter relates to FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicable.

Types of resource (if a resource is referenced).

In some cases, targets may exist for a search parameter that do not exist for the specified FHIRPath for all of the resources identified in SearchParameter.base. For example, the core clinical-encounter search parameter allows both Encounter and EpisodeOfCare as targets, even though not all of the base resources have EpisodeOfCare as a valid target.

However, the list of targets SHOULD cover all targets that might appear that are permitted by the specified FHIRPath.

Types Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of resource (if a resource is referenced). 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 Notes:

• Not all systems will declare chain values. If no chain values are not required specified at all, then no presumptions can be made about the degree of chaining support available
• A server may use a single chain value of '*' to list mean that all reference search types supported can be chained rather than enumerating all the chain names they support, values
• If a particular reference search parameter is supported, but if they don't list them, clients may not know to use them. subsequent chaining, then just list that search parameter name - e.g. for Patient.practitioner, the chain value would be practitioner
• If a particular reference search parameter is supported with unlimited chaining beneath it, then follow the search parameter name with '.'. E.g. practitioner.
• If there are specific (not unlimited) chaining paths allowed they can be explicitly enumerated. E.g. practitioner.organization

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.