DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

6.19.8 6.21.8 Resource SearchParameter - Detailed Descriptions Resource SearchParameter - Detailed Descriptions Detailed Descriptions for the elements in the SearchParameter resource.

Detailed Descriptions for the elements in the SearchParameter resource.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search
SearchParameter
Definition

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

Control 1..1
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. 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 Defined on this element
spd-1 : If an xpath is present, there SHALL be an xpathUsage (xpath: not(exists(f:xpath)) or exists(f:xpathUsage)) : If an xpath is present, there SHALL be an xpathUsage ( expression : xpath.empty() or xpathUsage, xpath: not(exists(f:xpath)) or exists(f:xpathUsage))
SearchParameter.url
Definition

An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published.

Control 1..1
Type uri
Requirements

To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash). To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).

Summary true
SearchParameter.name
Definition

A free text natural language name identifying the search parameter. A free text natural language name identifying the search parameter.

Control 1..1
Type string
Summary true
Comments

This is often the same as the code for the parameter, but does not need to be. This is often the same as the code for the parameter, but does not need to be.

SearchParameter.status
Definition

The status of this search parameter definition. The status of this search parameter definition.

Control 0..1
Binding ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. ( ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. ( Required )
Type code
Is Modifier Is Modifier true
Summary true
Comments

This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems. This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.

SearchParameter.experimental
Definition

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

Control 0..1
Type boolean
Summary true
Comments

Allows filtering of search parameter definitions that are appropriate for use vs. not. Allows filtering of search parameter definitions that are appropriate for use vs. not.

SearchParameter.date
Definition

The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

Control 0..1
Type dateTime
Summary true
Comments

Additional specific dates may be added as extensions.

SearchParameter.publisher
Definition

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

Control 0..1
Type string
Requirements

Helps establish the "authority/credibility" of the search parameter. May also allow for contact. 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. This item SHOULD be populated unless the information is available from context. Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

SearchParameter.contact
Definition

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

Control 0..*
Summary true
Comments

May be a web site, an email address, a telephone number (tel:), etc. May be a web site, an email address, a telephone number (tel:), etc.

SearchParameter.contact.name
Definition

The name of an individual to contact regarding the search parameter. The name of an individual to contact regarding the search parameter.

Control 0..1
Type string
Summary true
Comments

If there is no named individual, the telecom is for the organization as a whole. If there is no named individual, the telecom is for the organization as a whole.

SearchParameter.contact.telecom
Definition

Contact details for individual (if a name was provided) or the publisher. Contact details for individual (if a name was provided) or the publisher.

Control 0..*
Type ContactPoint
Summary true
SearchParameter.date SearchParameter.useContext
Definition

The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes. 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 of search parameters.

Control 0..1 0..*
Type Binding dateTime Context of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. ( Extensible )
Summary Type true CodeableConcept
Comments Requirements

Additional specific dates may be added as extensions. Assist in searching for appropriate content.

Summary true
SearchParameter.requirements
Definition

The Scope and Usage that this search parameter was created to meet. The Scope and Usage that this search parameter was created to meet.

Control 0..1
Type string
SearchParameter.code
Definition

The code used in the URL or the parameter name in a parameters resource for this search parameter. The code used in the URL or the parameter name in a parameters resource for this search parameter.

Control 1..1
Type code
Summary true
Comments

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

SearchParameter.base
Definition

The base resource type that this search parameter refers to. The base resource type that this search parameter refers to.

Control 1..1
Binding ResourceType: Any defined Resource Type name ResourceType: Any defined Resource Type name
Type code
Summary true
SearchParameter.type
Definition

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

Control 1..1
Binding SearchParamType: Data types allowed to be used for search parameters. ( SearchParamType: Data types allowed to be used for search parameters. ( Required )
Type code
Summary true
SearchParameter.description
Definition

A description of the search parameters and how it used. A description of the search parameters and how it used.

Control 1..1
Type string
Summary true
SearchParameter.xpath SearchParameter.expression
Definition

An XPath A FluentPath expression that returns a set of elements for the search parameter.

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

Invariants Affect this element
spd-1 : If an xpath is present, there SHALL be an xpathUsage ( expression that returns a set of elements for the search parameter. : xpath.empty() or xpathUsage, xpath: not(exists(f:xpath)) or exists(f:xpathUsage))
SearchParameter.xpath
Definition

An XPath expression that returns a set of elements for the search parameter.

Control 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. 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 Affect this element Affect this element
spd-1 : If an xpath is present, there SHALL be an xpathUsage (xpath: not(exists(f:xpath)) or exists(f:xpathUsage)) : If an xpath is present, there SHALL be an xpathUsage ( expression : xpath.empty() or xpathUsage, xpath: not(exists(f:xpath)) or exists(f:xpathUsage))
SearchParameter.xpathUsage
Definition

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

Control 0..1
Binding XPathUsageType: How a search parameter relates to the set of elements returned by evaluating its xpath query. ( XPathUsageType: How a search parameter relates to the set of elements returned by evaluating its xpath query. ( Required )
Type code
Invariants Affect this element Affect this element
spd-1 : If an xpath is present, there SHALL be an xpathUsage (xpath: not(exists(f:xpath)) or exists(f:xpathUsage)) : If an xpath is present, there SHALL be an xpathUsage ( expression : xpath.empty() or xpathUsage, xpath: not(exists(f:xpath)) or exists(f:xpathUsage))
SearchParameter.target
Definition

Types of resource (if a resource is referenced). Types of resource (if a resource is referenced).

Control 0..*
Binding ResourceType: Any defined Resource Type name ResourceType: Any defined Resource Type name
Type code