FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: 3 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the SearchParameter resource.

SearchParameter
Element IdSearchParameter
Definition

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

Short DisplaySearch parameter for a resource
Cardinality0..*
TypeCanonicalResource
Summaryfalse
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
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
spd-1Rule If an expression is present, there SHALL be a processingModeexpression.empty() or processingMode.exists()
spd-2Rule Search parameters can only have chain names when the search parameter type is 'reference'chain.empty() or type = 'reference'
spd-3Rule Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'.comparator.empty() or (type in ('number' | 'date' | 'quantity' | 'special'))
SearchParameter.url
Element IdSearchParameter.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 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.

Short DisplayCanonical identifier for this search parameter, represented as a URI (globally unique)
Cardinality1..1
Typeuri
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).

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

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
SearchParameter.version
Element IdSearchParameter.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.

Short DisplayBusiness version of the search parameter
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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]. The version SHOULD NOT contain a '#' - see Business Version.

SearchParameter.versionAlgorithm[x]
Element IdSearchParameter.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

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.

SearchParameter.name
Element IdSearchParameter.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.

Short DisplayName for this search parameter (computer friendly)
Cardinality1..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
SearchParameter.title
Element IdSearchParameter.title
Definition

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

Short DisplayName for this search parameter (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

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

SearchParameter.derivedFrom
Element IdSearchParameter.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.

Short DisplayOriginal definition for the search parameter
Cardinality0..1
Typecanonical(SearchParameter)
Summaryfalse
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. value-quantity icon, but detail how it is supported by the server.

SearchParameter.status
Element IdSearchParameter.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of search parameters that are appropriate for use versus not.

SearchParameter.experimental
Element IdSearchParameter.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.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

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

Summarytrue
Comments

Allows filtering of search parameters that are appropriate for use versus not.

SearchParameter.date
Element IdSearchParameter.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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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 IdSearchParameter.publisher
Definition

The name of the organization or individual tresponsible for the release and ongoing maintenance of the search parameter.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

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

Summarytrue
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 IdSearchParameter.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

SearchParameter.description
Element IdSearchParameter.description
Definition

And how it used.

Short DisplayNatural language description of the search parameter
Cardinality1..1
Typemarkdown
Summarytrue
Comments

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

SearchParameter.useContext
Element IdSearchParameter.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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

SearchParameter.jurisdiction
Element IdSearchParameter.jurisdiction
Definition

A legal or geographic region in which the search parameter is intended to be used.

Short DisplayIntended jurisdiction for search parameter (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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 IdSearchParameter.purpose
Definition

Explanation of why this search parameter is needed and why it has been designed as it has.

Short DisplayWhy this search parameter is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdSearchParameter.code
Definition

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

Short DisplayRecommended name for parameter in search url
Cardinality1..1
Typecode
Summarytrue
Comments

For maximum compatibility, use only lowercase ASCII characters. Note that HL7 will never define multiple search parameters with the same code.

SearchParameter.base
Element IdSearchParameter.base
Definition

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

Short DisplayThe resource type(s) this search parameter applies to
Cardinality1..*
Terminology BindingAll Resource Types (Required)
Typecode
Summarytrue
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 IdSearchParameter.type
Definition

The type of value that a search parameter may contain, and how the content is interpreted.

Short Displaynumber | date | string | token | reference | composite | quantity | uri | special
Cardinality1..1
Terminology BindingSearchParamType (Required)
Typecode
Summarytrue
SearchParameter.expression
Element IdSearchParameter.expression
Definition

A FHIRPath expression that returns a set of elements for the search parameter.

Short DisplayFHIRPath expression that extracts the values
Cardinality0..1
Typestring
Summaryfalse
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
Affect this element
spd-1Rule If an expression is present, there SHALL be a processingModeexpression.empty() or processingMode.exists()
SearchParameter.processingMode
Element IdSearchParameter.processingMode
Definition

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

Short Displaynormal | phonetic | other
Cardinality0..1
Terminology BindingSearchProcessingModeType (Required)
Typecode
Summaryfalse
Invariants
Affect this element
spd-1Rule If an expression is present, there SHALL be a processingModeexpression.empty() or processingMode.exists()
SearchParameter.constraint
Element IdSearchParameter.constraint
Definition

FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicable.

Short DisplayFHIRPath expression that constraints the usage of this SearchParamete
Cardinality0..1
Typestring
Summaryfalse
SearchParameter.target
Element IdSearchParameter.target
Definition

Types of resource (if a resource is referenced).

Short DisplayTypes of resource (if a resource reference)
Cardinality0..*
Terminology BindingResource Types (Required)
Typecode
Summaryfalse
Comments

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.

SearchParameter.multipleOr
Element IdSearchParameter.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.

Short DisplayAllow multiple values per parameter (or)
Cardinality0..1
Typeboolean
Summaryfalse
SearchParameter.multipleAnd
Element IdSearchParameter.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.

Short DisplayAllow multiple parameters (and)
Cardinality0..1
Typeboolean
Summaryfalse
SearchParameter.comparator
Element IdSearchParameter.comparator
Definition

Comparators supported for the search parameter.

Short Displayeq | ne | gt | lt | ge | le | sa | eb | ap
Cardinality0..*
Terminology BindingSearchComparator (Required)
Typecode
Summaryfalse
Comments

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

SearchParameter.modifier
Element IdSearchParameter.modifier
Definition

A modifier supported for the search parameter.

Short Displaymissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Cardinality0..*
Terminology BindingSearchModifierCode (Required)
Typecode
Summaryfalse
SearchParameter.chain
Element IdSearchParameter.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.

Short DisplayChained names supported
Cardinality0..*
Typestring
Summaryfalse
Comments

Notes:

  • Not all systems will declare chain values. If no chain values are 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 mean that all reference search types supported can be chained rather than enumerating all chain values
  • If a particular reference search parameter is supported, but not 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
SearchParameter.component
Element IdSearchParameter.component
Definition

Used to define the parts of a composite search parameter.

Short DisplayFor Composite resources to define the parts
Cardinality0..*
Summaryfalse
SearchParameter.component.definition
Element IdSearchParameter.component.definition
Definition

The definition of the search parameter that describes this part.

Short DisplayDefines how the part works
Cardinality1..1
Typecanonical(SearchParameter)
Summaryfalse
SearchParameter.component.expression
Element IdSearchParameter.component.expression
Definition

A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.

Short DisplaySubexpression relative to main expression
Cardinality1..1
Typestring
Summaryfalse
Comments

This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression.