This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
FHIR Infrastructure Work Group | Maturity Level: 3 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the SearchParameter resource.
SearchParameter | |||||||||||||||||
Element Id | SearchParameter | ||||||||||||||||
Definition | A search parameter that defines a named search item that can be used to search/filter on a resource. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Type | CanonicalResource | ||||||||||||||||
Comments | 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. | ||||||||||||||||
Invariants |
| ||||||||||||||||
SearchParameter.url | |||||||||||||||||
Element Id | SearchParameter.url | ||||||||||||||||
Definition | 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. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | uri | ||||||||||||||||
Requirements | 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). | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. 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. | ||||||||||||||||
SearchParameter.version | |||||||||||||||||
Element Id | SearchParameter.version | ||||||||||||||||
Definition | 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. | ||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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]. | ||||||||||||||||
SearchParameter.name | |||||||||||||||||
Element Id | SearchParameter.name | ||||||||||||||||
Definition | 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. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. | ||||||||||||||||
Invariants |
| ||||||||||||||||
SearchParameter.derivedFrom | |||||||||||||||||
Element Id | SearchParameter.derivedFrom | ||||||||||||||||
Definition | 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. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | canonical(SearchParameter) | ||||||||||||||||
Comments | 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. | ||||||||||||||||
SearchParameter.status | |||||||||||||||||
Element Id | SearchParameter.status | ||||||||||||||||
Definition | The status of this search parameter. Enables tracking the life-cycle of the content. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | Allows filtering of search parameters that are appropriate for use versus not. | ||||||||||||||||
SearchParameter.experimental | |||||||||||||||||
Element Id | SearchParameter.experimental | ||||||||||||||||
Definition | A 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. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | boolean | ||||||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter. | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | Allows filtering of search parameters that are appropriate for use versus not. | ||||||||||||||||
SearchParameter.date | |||||||||||||||||
Element Id | SearchParameter.date | ||||||||||||||||
Definition | The 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. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | dateTime | ||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. | ||||||||||||||||
SearchParameter.publisher | |||||||||||||||||
Element Id | SearchParameter.publisher | ||||||||||||||||
Definition | The name of the organization or individual that published the search parameter. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Requirements | Helps establish the "authority/credibility" of the search parameter. May also allow for contact. | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. | ||||||||||||||||
SearchParameter.contact | |||||||||||||||||
Element Id | SearchParameter.contact | ||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Type | ContactDetail | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||||||
SearchParameter.description | |||||||||||||||||
Element Id | SearchParameter.description | ||||||||||||||||
Definition | And how it used. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | markdown | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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). | ||||||||||||||||
SearchParameter.useContext | |||||||||||||||||
Element Id | SearchParameter.useContext | ||||||||||||||||
Definition | The 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. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Type | UsageContext | ||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||
SearchParameter.jurisdiction | |||||||||||||||||
Element Id | SearchParameter.jurisdiction | ||||||||||||||||
Definition | A legal or geographic region in which the search parameter is intended to be used. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Terminology Binding | Jurisdiction (Extensible) | ||||||||||||||||
Type | CodeableConcept | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended. | ||||||||||||||||
SearchParameter.purpose | |||||||||||||||||
Element Id | SearchParameter.purpose | ||||||||||||||||
Definition | Explanation of why this search parameter is needed and why it has been designed as it has. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | markdown | ||||||||||||||||
Comments | 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. | ||||||||||||||||
SearchParameter.code | |||||||||||||||||
Element Id | SearchParameter.code | ||||||||||||||||
Definition | The code used in the URL or the parameter name in a parameters resource for this search parameter. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | code | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | For maximum compatibility, use only lowercase ASCII characters. | ||||||||||||||||
SearchParameter.base | |||||||||||||||||
Element Id | SearchParameter.base | ||||||||||||||||
Definition | The base resource type(s) that this search parameter can be used against. | ||||||||||||||||
Cardinality | 1..* | ||||||||||||||||
Terminology Binding | Any defined Resource Type name | ||||||||||||||||
Type | code | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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). | ||||||||||||||||
SearchParameter.type | |||||||||||||||||
Element Id | SearchParameter.type | ||||||||||||||||
Definition | The type of value that a search parameter may contain, and how the content is interpreted. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Terminology Binding | SearchParamType (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
Summary | true | ||||||||||||||||
SearchParameter.expression | |||||||||||||||||
Element Id | SearchParameter.expression | ||||||||||||||||
Definition | A FHIRPath expression that returns a set of elements for the search parameter. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Comments | 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. | ||||||||||||||||
Invariants |
| ||||||||||||||||
SearchParameter.xpath | |||||||||||||||||
Element Id | SearchParameter.xpath | ||||||||||||||||
Definition | An XPath expression that returns a set of elements for the search parameter. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Comments | 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. | ||||||||||||||||
Invariants |
| ||||||||||||||||
SearchParameter.xpathUsage | |||||||||||||||||
Element Id | SearchParameter.xpathUsage | ||||||||||||||||
Definition | How the search parameter relates to the set of elements returned by evaluating the xpath query. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Terminology Binding | XPathUsageType (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
Invariants |
| ||||||||||||||||
SearchParameter.target | |||||||||||||||||
Element Id | SearchParameter.target | ||||||||||||||||
Definition | Types of resource (if a resource is referenced). | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Terminology Binding | Any defined Resource Type name | ||||||||||||||||
Type | code | ||||||||||||||||
SearchParameter.multipleOr | |||||||||||||||||
Element Id | SearchParameter.multipleOr | ||||||||||||||||
Definition | 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. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | boolean | ||||||||||||||||
SearchParameter.multipleAnd | |||||||||||||||||
Element Id | SearchParameter.multipleAnd | ||||||||||||||||
Definition | Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | boolean | ||||||||||||||||
SearchParameter.comparator | |||||||||||||||||
Element Id | SearchParameter.comparator | ||||||||||||||||
Definition | Comparators supported for the search parameter. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Terminology Binding | SearchComparator (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
Comments | If no comparators are listed, clients should not expect servers to support any comparators. | ||||||||||||||||
SearchParameter.modifier | |||||||||||||||||
Element Id | SearchParameter.modifier | ||||||||||||||||
Definition | A modifier supported for the search parameter. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Terminology Binding | SearchModifierCode (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
SearchParameter.chain | |||||||||||||||||
Element Id | SearchParameter.chain | ||||||||||||||||
Definition | 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 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. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Type | string | ||||||||||||||||
Comments | 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. | ||||||||||||||||
SearchParameter.component | |||||||||||||||||
Element Id | SearchParameter.component | ||||||||||||||||
Definition | Used to define the parts of a composite search parameter. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
SearchParameter.component.definition | |||||||||||||||||
Element Id | SearchParameter.component.definition | ||||||||||||||||
Definition | The definition of the search parameter that describes this part. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | canonical(SearchParameter) | ||||||||||||||||
SearchParameter.component.expression | |||||||||||||||||
Element Id | SearchParameter.component.expression | ||||||||||||||||
Definition | A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Comments | This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression. |