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 6.21 Resource SearchParameter - Content Resource SearchParameter - Content

A search parameter that defines a named search item that can be used to search/filter on a resource.
FHIR Infrastructure FHIR Infrastructure Work Group Work Group Maturity Level : 1 Maturity Level : 1 Compartments : Not linked to any defined compartments : Not linked to any defined compartments

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

6.19.1 Scope and Usage 6.21.1 Scope and Usage todo

todo

6.19.2 Boundaries and Relationships 6.21.2 Boundaries and Relationships Profiles are used by

6.19.3 Background and Context 6.21.3 Background and Context Implementers should be familiar with the background and concepts described in Profiling FHIR before working with this resource.

Implementers should be familiar with the background and concepts described in Profiling FHIR before working with this resource.

6.19.4 Resource Content 6.21.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . SearchParameter I DomainResource Search Parameter for a resource Search Parameter for a resource
If an xpath is present, there SHALL be an xpathUsage If an xpath is present, there SHALL be an xpathUsage
. . . url Σ 1..1 uri Absolute URL used to reference this search parameter Absolute URL used to reference this search parameter
. . . name Σ 1..1 string Informal name for this search parameter Informal name for this search parameter
. . . status ?! ?! Σ 0..1 code draft | active | retired draft | active | retired
ConformanceResourceStatus ( ( Required )
. . . experimental Σ 0..1 boolean If for testing purposes, not real usage If for testing purposes, not real usage
. . publisher . date Σ 0..1 dateTime Publication Date(/time)
... publisher Σ 0..1 string Name of the publisher (Organization or individual) Name of the publisher (Organization or individual)
. . . contact Σ 0..* BackboneElement Contact details of the publisher Contact details of the publisher
. . . . name Σ 0..1 string Name of a individual to contact Name of an individual to contact
. . . . telecom Σ 0..* ContactPoint Contact details for individual or publisher Contact details for individual or publisher
. . date . useContext Σ 0..1 0..* dateTime CodeableConcept Publication Date(/time) Content intends to support these contexts
Context of Use ValueSet ( Extensible )
. . . requirements 0..1 string Why this search parameter is defined Why this search parameter is defined
. . . code Σ 1..1 code Code used in URL Code used in URL
. . . base Σ 1..1 code The resource type this search parameter applies to The resource type this search parameter applies to
ResourceType ( ( Required )
. . . type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri number | date | string | token | reference | composite | quantity | uri
SearchParamType ( ( Required )
. . . description Σ 1..1 string Documentation for search parameter Documentation for search parameter
. . xpath . expression I 0..1 string FluentPath expression that extracts the values
... xpath I 0..1 string XPath that extracts the values XPath that extracts the values
. . . xpathUsage I 0..1 code normal | phonetic | nearby | distance | other normal | phonetic | nearby | distance | other
XPathUsageType ( ( Required )
. . . target 0..* code Types of resource (if a resource reference) Types of resource (if a resource reference)
ResourceType ( ( Required )

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

SearchParameter ( ( DomainResource ) 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 url : : uri [1..1] [1..1] A free text natural language name identifying the search parameter A free text natural language name identifying the search parameter name : : string [1..1] [1..1] The status of this search parameter definition (this element modifies the meaning of other elements) The status of this search parameter definition (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required) The lifecycle status of a Value Set or Concept Map. (Strength=Required) ConformanceResourceStatus ! » ! » 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 experimental : : boolean [0..1] [0..1] 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 date : dateTime [0..1] The name of the individual or organization that published the search parameter The name of the individual or organization that published the search parameter publisher : : string [0..1] [0..1] 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 date : dateTime useContext : CodeableConcept [0..*] « Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Strength=Extensible) Context of Use ValueSet [0..1] + » The Scope and Usage that this search parameter was created to meet The Scope and Usage that this search parameter was created to meet requirements : : string [0..1] [0..1] 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 code : : code [1..1] [1..1] The base resource type that this search parameter refers to The base resource type that this search parameter refers to base : : code [1..1] « [1..1] « One of the resource types defined as part of FHIR. (Strength=Required) One of the resource types defined as part of FHIR. (Strength=Required) ResourceType ! » ! » 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 type : : code [1..1] « [1..1] « Data types allowed to be used for search parameters. (Strength=Required) Data types allowed to be used for search parameters. (Strength=Required) SearchParamType ! » ! » A description of the search parameters and how it used A description of the search parameters and how it used description : : string [1..1] [1..1] An XPath A FluentPath expression that returns a set of elements for the search parameter expression that returns a set of elements for the search parameter : string [0..1] An XPath expression that returns a set of elements for the search parameter xpath : : string [0..1] [0..1] 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 xpathUsage : : code [0..1] « [0..1] « How a search parameter relates to the set of elements returned by evaluating its xpath query. (Strength=Required) How a search parameter relates to the set of elements returned by evaluating its xpath query. (Strength=Required) XPathUsageType ! » ! » Types of resource (if a resource is referenced) Types of resource (if a resource is referenced) target : : code [0..*] « [0..*] « One of the resource types defined as part of FHIR. (Strength=Required) One of the resource types defined as part of FHIR. (Strength=Required) ResourceType ! » ! » Contact The name of an individual to contact regarding the search parameter The name of an individual to contact regarding the search parameter name : : string [0..1] [0..1] Contact details for individual (if a name was provided) or the publisher Contact details for individual (if a name was provided) or the publisher telecom : : ContactPoint [0..*] [0..*] Contacts to assist a user in finding and communicating with the publisher Contacts to assist a user in finding and communicating with the publisher contact [0..*]

XML Template XML Template 

<SearchParameter xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Absolute URL used to reference this search parameter -->
 <name value="[string]"/><!-- 1..1 Informal name for this search parameter -->
 <status value="[code]"/><!-- 0..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Publication Date(/time) -->

 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <

  <name value="[string]"/><!-- 0..1 Name of an individual to contact -->

  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <

 <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext>

 <requirements value="[string]"/><!-- 0..1 Why this search parameter is defined -->
 <code value="[code]"/><!-- 1..1 Code used in URL -->
 <base value="[code]"/><!-- 1..1 The resource type this search parameter applies to -->
 <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri -->
 <description value="[string]"/><!-- 1..1 Documentation for  search parameter -->
 <expression value="[string]"/><!-- ?? 0..1 FluentPath expression that extracts the values -->

 <xpath value="[string]"/><!-- ?? 0..1 XPath that extracts the values -->
 <xpathUsage value="[code]"/><!-- ?? 0..1 normal | phonetic | nearby | distance | other -->
 <target value="[code]"/><!-- 0..* Types of resource (if a resource reference) -->
</SearchParameter>

JSON Template JSON Template

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . SearchParameter I DomainResource Search Parameter for a resource Search Parameter for a resource
If an xpath is present, there SHALL be an xpathUsage If an xpath is present, there SHALL be an xpathUsage
. . . url Σ 1..1 uri Absolute URL used to reference this search parameter Absolute URL used to reference this search parameter
. . . name Σ 1..1 string Informal name for this search parameter Informal name for this search parameter
. . . status ?! ?! Σ 0..1 code draft | active | retired draft | active | retired
ConformanceResourceStatus ( ( Required )
. . . experimental Σ 0..1 boolean If for testing purposes, not real usage If for testing purposes, not real usage
. . publisher . date Σ 0..1 dateTime Publication Date(/time)
... publisher Σ 0..1 string Name of the publisher (Organization or individual) Name of the publisher (Organization or individual)
. . . contact Σ 0..* BackboneElement Contact details of the publisher Contact details of the publisher
. . . . name Σ 0..1 string Name of a individual to contact Name of an individual to contact
. . . . telecom Σ 0..* ContactPoint Contact details for individual or publisher Contact details for individual or publisher
. . date . useContext Σ 0..1 0..* dateTime CodeableConcept Publication Date(/time) Content intends to support these contexts
Context of Use ValueSet ( Extensible )
. . . requirements 0..1 string Why this search parameter is defined Why this search parameter is defined
. . . code Σ 1..1 code Code used in URL Code used in URL
. . . base Σ 1..1 code The resource type this search parameter applies to The resource type this search parameter applies to
ResourceType ( ( Required )
. . . type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri number | date | string | token | reference | composite | quantity | uri
SearchParamType ( ( Required )
. . . description Σ 1..1 string Documentation for search parameter Documentation for search parameter
. . xpath . expression I 0..1 string FluentPath expression that extracts the values
... xpath I 0..1 string XPath that extracts the values XPath that extracts the values
. . . xpathUsage I 0..1 code normal | phonetic | nearby | distance | other normal | phonetic | nearby | distance | other
XPathUsageType ( ( Required )
. . . target 0..* code Types of resource (if a resource reference) Types of resource (if a resource reference)
ResourceType ( ( Required )

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

SearchParameter ( ( DomainResource ) 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 url : : uri [1..1] [1..1] A free text natural language name identifying the search parameter A free text natural language name identifying the search parameter name : : string [1..1] [1..1] The status of this search parameter definition (this element modifies the meaning of other elements) The status of this search parameter definition (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required) The lifecycle status of a Value Set or Concept Map. (Strength=Required) ConformanceResourceStatus ! » ! » 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 experimental : : boolean [0..1] [0..1] 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 date : dateTime [0..1] The name of the individual or organization that published the search parameter The name of the individual or organization that published the search parameter publisher : : string [0..1] [0..1] 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 date : dateTime useContext : CodeableConcept [0..*] « Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Strength=Extensible) Context of Use ValueSet [0..1] + » The Scope and Usage that this search parameter was created to meet The Scope and Usage that this search parameter was created to meet requirements : : string [0..1] [0..1] 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 code : : code [1..1] [1..1] The base resource type that this search parameter refers to The base resource type that this search parameter refers to base : : code [1..1] « [1..1] « One of the resource types defined as part of FHIR. (Strength=Required) One of the resource types defined as part of FHIR. (Strength=Required) ResourceType ! » ! » 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 type : : code [1..1] « [1..1] « Data types allowed to be used for search parameters. (Strength=Required) Data types allowed to be used for search parameters. (Strength=Required) SearchParamType ! » ! » A description of the search parameters and how it used A description of the search parameters and how it used description : : string [1..1] [1..1] An XPath A FluentPath expression that returns a set of elements for the search parameter expression that returns a set of elements for the search parameter : string [0..1] An XPath expression that returns a set of elements for the search parameter xpath : : string [0..1] [0..1] 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 xpathUsage : : code [0..1] « [0..1] « How a search parameter relates to the set of elements returned by evaluating its xpath query. (Strength=Required) How a search parameter relates to the set of elements returned by evaluating its xpath query. (Strength=Required) XPathUsageType ! » ! » Types of resource (if a resource is referenced) Types of resource (if a resource is referenced) target : : code [0..*] « [0..*] « One of the resource types defined as part of FHIR. (Strength=Required) One of the resource types defined as part of FHIR. (Strength=Required) ResourceType ! » ! » Contact The name of an individual to contact regarding the search parameter The name of an individual to contact regarding the search parameter name : : string [0..1] [0..1] Contact details for individual (if a name was provided) or the publisher Contact details for individual (if a name was provided) or the publisher telecom : : ContactPoint [0..*] [0..*] Contacts to assist a user in finding and communicating with the publisher Contacts to assist a user in finding and communicating with the publisher contact [0..*]

XML Template XML Template 

<SearchParameter xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Absolute URL used to reference this search parameter -->
 <name value="[string]"/><!-- 1..1 Informal name for this search parameter -->
 <status value="[code]"/><!-- 0..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Publication Date(/time) -->

 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <

  <name value="[string]"/><!-- 0..1 Name of an individual to contact -->

  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <

 <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext>

 <requirements value="[string]"/><!-- 0..1 Why this search parameter is defined -->
 <code value="[code]"/><!-- 1..1 Code used in URL -->
 <base value="[code]"/><!-- 1..1 The resource type this search parameter applies to -->
 <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri -->
 <description value="[string]"/><!-- 1..1 Documentation for  search parameter -->
 <expression value="[string]"/><!-- ?? 0..1 FluentPath expression that extracts the values -->

 <xpath value="[string]"/><!-- ?? 0..1 XPath that extracts the values -->
 <xpathUsage value="[code]"/><!-- ?? 0..1 normal | phonetic | nearby | distance | other -->
 <target value="[code]"/><!-- 0..* Types of resource (if a resource reference) -->
</SearchParameter>

JSON Template JSON Template

  Alternate definitions:

Alternate definitions: Schema / Schematron , Resource Profile ( , Resource Profile ( XML , , JSON ), ), Questionnaire

6.19.4.1 Terminology Bindings 6.21.4.1 Terminology Bindings

Path Definition Type Reference
SearchParameter.status SearchParameter.status The lifecycle status of a Value Set or Concept Map. The lifecycle status of a Value Set or Concept Map. Required ConformanceResourceStatus
SearchParameter.useContext Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. Extensible Context of Use ValueSet
SearchParameter.base
SearchParameter.target SearchParameter.target 		One of the resource types defined as part of FHIR. One of the resource types defined as part of FHIR. Required http://hl7.org/fhir/valueset/resource-types ResourceType
SearchParameter.type SearchParameter.type Data types allowed to be used for search parameters. Data types allowed to be used for search parameters. Required SearchParamType
SearchParameter.xpathUsage SearchParameter.xpathUsage How a search parameter relates to the set of elements returned by evaluating its xpath query. How a search parameter relates to the set of elements returned by evaluating its xpath query. Required XPathUsageType

6.19.4.2 Constraints 6.21.4.2 Constraints

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

6.19.5 SearchParameters on Extensions 6.21.5 SearchParameters on Extensions The SearchParameter resource may be used to define searches on extensions. Depending on the context of the extension (as defined in the

The SearchParameter resource may be used to define searches on extensions. Depending on the context of the extension (as defined in the StructureDefinition ), this may require multiple instances of the SearchParameter.xpath element like so: If the extension's context is scoped by a single resource, SearchParameter.base must be set to that resource, and there may be one or more xpath elements corresponding to the elements specified in the extension's context, e.g. "f:Patient/f:name/f:extension[@url='extension url']" If the extension's context specifies multiple resources, SearchParameter.base must be set to "DomainResource". You may use a single xpath element with the full url of the Extension to indicate that the SearchParameter would search in all elements of the given SearchParameter.base resource for the given extension. ), this may require multiple instances of the SearchParameter.xpath element like so:

  • If the extension's context is scoped by a single resource, SearchParameter.base must be set to that resource, and there may be one or more xpath elements corresponding to the elements specified in the extension's context, e.g. "f:Patient/f:name/f:extension[@url='extension url']"
  • If the extension's context specifies multiple resources, SearchParameter.base must be set to "DomainResource".
  • You may use a single xpath element with the full url of the Extension to indicate that the SearchParameter would search in all elements of the given SearchParameter.base resource for the given extension.

6.19.6 Search Parameters 6.21.6 Search Parameters Search parameters for this resource. The common parameters also apply. See

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. for more information about searching in REST, messaging, and services.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search
Name Type Description Paths
base token The resource type this search parameter applies to The resource type this search parameter applies to SearchParameter.base
code token Code used in URL Code used in URL SearchParameter.code
context token A use context assigned to the search parameter SearchParameter.useContext
description string Documentation for search parameter Documentation for search parameter SearchParameter.description
name string Informal name for this search parameter Informal name for this search parameter SearchParameter.name
target token Types of resource (if a resource reference) Types of resource (if a resource reference) SearchParameter.target
type token number | date | string | token | reference | composite | quantity | uri number | date | string | token | reference | composite | quantity | uri SearchParameter.type
url uri Absolute URL used to reference this search parameter Absolute URL used to reference this search parameter SearchParameter.url