This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

6.19 Resource SearchParameter - Content

This resource maintained by the FHIR Management Group Work Group

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

todo

6.19.2 Boundaries and Relationships

6.19.3 Background and Context

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

6.19.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . SearchParameter DomainResource Search Parameter for a resource
. . . url 1..1 uri Literal URL used to reference this search parameter
. . . name Σ 1..1 string Name of search parameter
. . . publisher Σ 0..1 string Name of the publisher (Organization or individual)
. . . contact Σ 0..* Element Contact details of the publisher
. . . . name Σ 0..1 string Name of a individual to contact
. . . . telecom Σ 0..* ContactPoint Contact details for individual or publisher
. . . requirements 0..1 string Why this search parameter is defined
. . . status ?! Σ 0..1 code draft | active | retired
ConformanceResourceStatus ( Required )
. . . experimental Σ 0..1 boolean If for testing purposes, not real usage
. . . date Σ 0..1 dateTime Publication Date(/time)
. . . base 1..1 code The resource type this search parameter applies to
ResourceType ( Required )
. . . type 1..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType ( Required )
. . . description 1..1 string Documentation for search parameter
. . . xpath 0..1 string XPath that extracts the values
. . . target 0..* code Types of resource (if a resource reference)
ResourceType ( Required )

UML Diagram

SearchParameter ( DomainResource ) An absolute URL at which this search parameter is (or will be) published, and which is used to reference this profile in conformance statements url : uri 1..1 The name of the standard or custom search parameter name : string 1..1 The name of the individual or organization that published the search parameter publisher : string 0..1 The Scope and Usage that this search parameter was created to meet requirements : string 0..1 The status of this search parameter definition (this element modifies the meaning of other elements) status : code 0..1 « The lifecycle status of a Value Set or Concept Map 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 experimental : boolean 0..1 The date (and optionally time) when the search parameter definition was published date : dateTime 0..1 The base resource type that this search parameter refers to base : code 1..1 « One of the resource types defined as part of FHIR ResourceType » The type of value a search parameter refers to, and how the content is interpreted type : code 1..1 « Data types allowed to be used for search parameters SearchParamType » A description of the search parameters and how it used description : string 1..1 An XPath expression that returns a set of elements for the search parameter xpath : string 0..1 Types of resource (if a resource is referenced) target : code 0..* « One of the resource types defined as part of FHIR ResourceType » Contact The name of an individual to contact regarding the search parameter name : string 0..1 Contact details for individual (if a name was provided) or the publisher telecom : ContactPoint 0..* Contacts to assist a user in finding and communicating with the publisher contact 0..*

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 Literal URL used to reference this search parameter -->
 <name value="[string]"/><!-- 1..1 Name of search parameter -->
 <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 a individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <requirements value="[string]"/><!-- 0..1 Why this search parameter is defined -->
 <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) -->
 <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 -->
 <xpath value="[string]"/><!-- 0..1 XPath that extracts the values -->
 <target value="[code]"/><!-- 0..* Types of resource (if a resource reference) -->
</SearchParameter>

JSON Template 

{doco
  "resourceType" : "SearchParameter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Literal URL used to reference this search parameter
  "name" : "<string>", // R!  Name of search parameter
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of a individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for individual or publisher
  }],
  "requirements" : "<string>", // Why this search parameter is defined
  "status" : "<code>", // draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Publication Date(/time)
  "base" : "<code>", // R!  The resource type this search parameter applies to
  "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri
  "description" : "<string>", // R!  Documentation for  search parameter
  "xpath" : "<string>", // XPath that extracts the values
  "target" : ["<code>"] // Types of resource (if a resource reference)
}

Structure

Name Flags Card. Type Description & Constraints doco
. . SearchParameter DomainResource Search Parameter for a resource
. . . url 1..1 uri Literal URL used to reference this search parameter
. . . name Σ 1..1 string Name of search parameter
. . . publisher Σ 0..1 string Name of the publisher (Organization or individual)
. . . contact Σ 0..* Element Contact details of the publisher
. . . . name Σ 0..1 string Name of a individual to contact
. . . . telecom Σ 0..* ContactPoint Contact details for individual or publisher
. . . requirements 0..1 string Why this search parameter is defined
. . . status ?! Σ 0..1 code draft | active | retired
ConformanceResourceStatus ( Required )
. . . experimental Σ 0..1 boolean If for testing purposes, not real usage
. . . date Σ 0..1 dateTime Publication Date(/time)
. . . base 1..1 code The resource type this search parameter applies to
ResourceType ( Required )
. . . type 1..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType ( Required )
. . . description 1..1 string Documentation for search parameter
. . . xpath 0..1 string XPath that extracts the values
. . . target 0..* code Types of resource (if a resource reference)
ResourceType ( Required )

UML Diagram

SearchParameter ( DomainResource ) An absolute URL at which this search parameter is (or will be) published, and which is used to reference this profile in conformance statements url : uri 1..1 The name of the standard or custom search parameter name : string 1..1 The name of the individual or organization that published the search parameter publisher : string 0..1 The Scope and Usage that this search parameter was created to meet requirements : string 0..1 The status of this search parameter definition (this element modifies the meaning of other elements) status : code 0..1 « The lifecycle status of a Value Set or Concept Map 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 experimental : boolean 0..1 The date (and optionally time) when the search parameter definition was published date : dateTime 0..1 The base resource type that this search parameter refers to base : code 1..1 « One of the resource types defined as part of FHIR ResourceType » The type of value a search parameter refers to, and how the content is interpreted type : code 1..1 « Data types allowed to be used for search parameters SearchParamType » A description of the search parameters and how it used description : string 1..1 An XPath expression that returns a set of elements for the search parameter xpath : string 0..1 Types of resource (if a resource is referenced) target : code 0..* « One of the resource types defined as part of FHIR ResourceType » Contact The name of an individual to contact regarding the search parameter name : string 0..1 Contact details for individual (if a name was provided) or the publisher telecom : ContactPoint 0..* Contacts to assist a user in finding and communicating with the publisher contact 0..*

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 Literal URL used to reference this search parameter -->
 <name value="[string]"/><!-- 1..1 Name of search parameter -->
 <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 a individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <requirements value="[string]"/><!-- 0..1 Why this search parameter is defined -->
 <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) -->
 <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 -->
 <xpath value="[string]"/><!-- 0..1 XPath that extracts the values -->
 <target value="[code]"/><!-- 0..* Types of resource (if a resource reference) -->
</SearchParameter>

JSON Template 

{doco
  "resourceType" : "SearchParameter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Literal URL used to reference this search parameter
  "name" : "<string>", // R!  Name of search parameter
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of a individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for individual or publisher
  }],
  "requirements" : "<string>", // Why this search parameter is defined
  "status" : "<code>", // draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Publication Date(/time)
  "base" : "<code>", // R!  The resource type this search parameter applies to
  "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri
  "description" : "<string>", // R!  Documentation for  search parameter
  "xpath" : "<string>", // XPath that extracts the values
  "target" : ["<code>"] // Types of resource (if a resource reference)
}

 

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

6.19.4.1 Terminology Bindings

Path Definition Type Reference
SearchParameter.status The lifecycle status of a Value Set or Concept Map Required http://hl7.org/fhir/conformance-resource-status
SearchParameter.base
SearchParameter.target 		One of the resource types defined as part of FHIR Required http://hl7.org/fhir/valueset/resource-types
SearchParameter.type Data types allowed to be used for search parameters Required http://hl7.org/fhir/search-param-type

6.19.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 StructureDefinition ), this may require multiple instances of the SearchParameter.xpath element like so:

6.19.6 Search Parameters

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

Name Type Description Paths
base token The resource type this search parameter applies to SearchParameter.base
description string Documentation for search parameter SearchParameter.description
name string Name of search parameter SearchParameter.name
target token Types of resource (if a resource reference) SearchParameter.target
type token number | date | string | token | reference | composite | quantity | uri SearchParameter.type
url uri Literal URL used to reference this search parameter SearchParameter.url