FHIR Release 3 (STU) Current Build
This page is part of FHIR STU 3 (v3.0.1) in it's permanent home (it will always be available at this URL). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .

5.5 Resource SearchParameter - Content

FHIR Infrastructure Work Group Maturity Level : 3   Trial Use Security Category : Anonymous 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.

A SearchParameter resource specifies a search parameter that may be used on the RESTful API to search or filter on a resource. The SearchParameter resource declares:

  • how to refer to the search parameter from a client
  • how the search parameter is to be understood by the server
  • where in the source resource the parameter matches

Implementers should be familiar with the background and concepts described in Search on the RESTful API before working with this resource.

There is a registry of all Search Parameters .

This resource is referenced by CapabilityStatement and itself.

This resource does not implement any patterns.

Structure

Name Flags Card. Type Description & Constraints doco
. . SearchParameter I TU DomainResource Search Parameter parameter for a resource
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: If an xpath is present, there SHALL be an xpathUsage
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 1..1 uri Logical URI to reference Canonical identifier for this search parameter parameter, represented as a URI (globally unique)
. . . version Σ 0..1 string Business version of the search parameter
. . . name Σ I 1..1 string Name for this search parameter (computer friendly)
. . . derivedFrom 0..1 canonical ( SearchParameter ) Original definition for the search parameter
.. . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description Σ 1..1 markdown Natural language description of the search parameter
.. . useContext Σ 0..* UsageContext Context The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Jurisdiction ValueSet ( Extensible )
. . . purpose 0..1 markdown Why this search parameter is defined
. . . code Σ 1..1 code Code used in URL
. . . base Σ 1..* code The resource type(s) this search parameter applies to
ResourceType ( Required )
. . . type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri | special
SearchParamType ( Required )
. . . derivedFrom 0..1 uri Original Definition for the search parameter description Σ 1..1 markdown Natural language description of the search parameter expression I 0..1 string FHIRPath expression that extracts the values
. . . xpath I 0..1 string XPath that extracts the values
. . . xpathUsage I 0..1 code normal | phonetic | nearby | distance | other
XPathUsageType ( Required )
. . . target 0..* code Types of resource (if a resource reference)
ResourceType ( Required )
. . . multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator ( Required )
. . . modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
SearchModifierCode ( Required )
. . . chain 0..* string Chained names supported
. . . component 0..* BackboneElement For Composite resources to define the parts
. . . . definition 1..1 Reference canonical ( SearchParameter ) Defines how the part works
. . . . expression 1..1 string Subexpression relative to main expression

doco Documentation for this format

UML Diagram ( Legend )

SearchParameter ( DomainResource ) An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which at which an authoritative instance of this search parameter is (or will be) published. The This URL SHOULD include can be the major version target of a canonical reference. It SHALL remain the same when the search parameter. For more information see [Technical and Business Versions](resource.html#versions) parameter is stored on different servers url : uri [1..1] 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 version : string [0..1] 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 name : string [1..1] 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 derivedFrom : canonical [0..1] « SearchParameter » The status of this search parameter. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of a Value Set or Concept Map. an artifact. (Strength=Required) PublicationStatus ! » A boolean Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), education/evaluation/marketing) and is not intended to be used for genuine usage (this element modifies the meaning of other elements) experimental : boolean [0..1] The date (and optionally time) when the search parameter was published. The date must change if and 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 date : dateTime [0..1] The name of the individual or organization or individual that published the search parameter publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] And how it used description : markdown [1..1] The content was developed with a focus and intent of supporting the contexts that are listed. These terms 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 useContext : UsageContext [0..*] A legal or geographic region in which the search parameter is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use use. (Strength=Extensible) Jurisdiction ValueSet + » Explaination Explanation of why this search parameter is needed and why it has been designed as it has purpose : markdown [0..1] The code used in the URL or the parameter name in a parameters resource for this search parameter code : code [1..1] The base resource type(s) that this search parameter can be used against base : code [1..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required) ResourceType ! » The type of value that a search parameter refers to, may contain, and how the content is interpreted type : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required) SearchParamType ! » 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 derivedFrom : uri [0..1] A free text natural language description of the search parameter from a consumer's perspective. and how it used description : markdown [1..1] A FHIRPath expression that returns a set of elements for the search parameter expression : string [0..1] An XPath expression that returns a set of elements for the search parameter xpath : string [0..1] How the search parameter relates to the set of elements returned by evaluating the xpath query xpathUsage : code [0..1] « 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) target : code [0..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required) ResourceType ! » 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 multipleOr : boolean [0..1] Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match multipleAnd : boolean [0..1] Comparators supported for the search parameter comparator : code [0..*] « What Search Comparator Codes are supported in search search. (Strength=Required) SearchComparator ! » A modifier supported for the search parameter modifier : code [0..*] « A supported modifier for a search parameter. (Strength=Required) SearchModifierCode ! » 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, 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 chain : string [0..*] Component The definition of the search parameter that describes this part definition : Reference canonical [1..1] « SearchParameter » A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression expression : string [1..1] Used to define the parts of a composite search parameter component [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 Canonical identifier for this search parameter, represented as a URI (globally unique) -->

 <version value="[string]"/><!-- 0..1 Business version of the search parameter -->
 <

 <name value="[string]"/><!-- ?? 1..1 Name for this search parameter (computer friendly) -->
 <derivedFrom><!-- 0..1 canonical(SearchParameter) Original definition for the search parameter --></derivedFrom>

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <
 <
 <

 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <</useContext>

 <description value="[markdown]"/><!-- 1..1 Natural language description of the search parameter -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>

 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable) --></jurisdiction>
 <

 <purpose value="[markdown]"/><!-- 0..1 Why this search parameter is defined -->

 <code value="[code]"/><!-- 1..1 Code used in URL -->
 <base value="[code]"/><!-- 1..* The resource type(s) this search parameter applies to -->
 <
 <
 <

 <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special -->

 <expression value="[string]"/><!-- ?? 0..1 FHIRPath 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) -->
 <multipleOr value="[boolean]"/><!-- 0..1 Allow multiple values per parameter (or) -->
 <multipleAnd value="[boolean]"/><!-- 0..1 Allow multiple parameters (and) -->

 <comparator value="[code]"/><!-- 0..* eq | ne | gt | lt | ge | le | sa | eb | ap -->
 <
 <

 <modifier value="[code]"/><!-- 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType -->
 <chain value="[string]"/><!-- 0..* Chained names supported -->

 <component>  <!-- 0..* For Composite resources to define the parts -->
  <</definition>

  <definition><!-- 1..1 canonical(SearchParameter) Defines how the part works --></definition>

  <expression value="[string]"/><!-- 1..1 Subexpression relative to main expression -->
 </component>
</SearchParameter>

JSON Template

{doco
  "resourceType" : "SearchParameter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "url" : "<uri>", // R!  Canonical identifier for this search parameter, represented as a URI (globally unique)

  "version" : "<string>", // Business version of the search parameter
  "

  "name" : "<string>", // C? R!  Name for this search parameter (computer friendly)
  "derivedFrom" : { canonical(SearchParameter) }, // Original definition for the search parameter

  "status" : "<code>", // R!  draft | active | retired | unknown
  "
  "
  "

  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)

  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "

  "description" : "<markdown>", // R!  Natural language description of the search parameter
  "useContext" : [{ UsageContext }], // The context that the content is intended to support

  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for search parameter (if applicable)
  "

  "purpose" : "<markdown>", // Why this search parameter is defined

  "code" : "<code>", // R!  Code used in URL
  "base" : ["<code>"], // R!  The resource type(s) this search parameter applies to
  "
  "
  "

  "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri | special

  "expression" : "<string>", // C? FHIRPath expression that extracts the values
  "xpath" : "<string>", // C? XPath that extracts the values
  "xpathUsage" : "<code>", // C? normal | phonetic | nearby | distance | other
  "target" : ["<code>"], // Types of resource (if a resource reference)
  "multipleOr" : <boolean>, // Allow multiple values per parameter (or)
  "multipleAnd" : <boolean>, // Allow multiple parameters (and)

  "comparator" : ["<code>"], // eq | ne | gt | lt | ge | le | sa | eb | ap
  "
  "

  "modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  "chain" : ["<string>"], // Chained names supported

  "component" : [{ // For Composite resources to define the parts
    "

    "definition" : { canonical(SearchParameter) }, // R!  Defines how the part works

    "expression" : "<string>" // R!  Subexpression relative to main expression
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:SearchParameter;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:

  fhir:SearchParameter.url [ uri ]; # 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique)

  fhir:SearchParameter.version [ string ]; # 0..1 Business version of the search parameter
  fhir:SearchParameter.name [ string ]; # 1..1 Name for this search parameter (computer friendly)
  fhir:SearchParameter.derivedFrom [ canonical(SearchParameter) ]; # 0..1 Original definition for the search parameter

  fhir:SearchParameter.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:
  fhir:
  fhir:

  fhir:SearchParameter.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:SearchParameter.date [ dateTime ]; # 0..1 Date last changed
  fhir:SearchParameter.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)

  fhir:SearchParameter.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:

  fhir:SearchParameter.description [ markdown ]; # 1..1 Natural language description of the search parameter
  fhir:SearchParameter.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support

  fhir:SearchParameter.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for search parameter (if applicable)
  fhir:

  fhir:SearchParameter.purpose [ markdown ]; # 0..1 Why this search parameter is defined

  fhir:SearchParameter.code [ code ]; # 1..1 Code used in URL
  fhir:SearchParameter.base [ code ], ... ; # 1..* The resource type(s) this search parameter applies to
  fhir:
  fhir:
  fhir:

  fhir:SearchParameter.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special

  fhir:SearchParameter.expression [ string ]; # 0..1 FHIRPath expression that extracts the values
  fhir:SearchParameter.xpath [ string ]; # 0..1 XPath that extracts the values
  fhir:SearchParameter.xpathUsage [ code ]; # 0..1 normal | phonetic | nearby | distance | other
  fhir:SearchParameter.target [ code ], ... ; # 0..* Types of resource (if a resource reference)
  fhir:SearchParameter.multipleOr [ boolean ]; # 0..1 Allow multiple values per parameter (or)
  fhir:SearchParameter.multipleAnd [ boolean ]; # 0..1 Allow multiple parameters (and)

  fhir:SearchParameter.comparator [ code ], ... ; # 0..* eq | ne | gt | lt | ge | le | sa | eb | ap
  fhir:
  fhir:

  fhir:SearchParameter.modifier [ code ], ... ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  fhir:SearchParameter.chain [ string ], ... ; # 0..* Chained names supported

  fhir:SearchParameter.component [ # 0..* For Composite resources to define the parts
    fhir:

    fhir:SearchParameter.component.definition [ canonical(SearchParameter) ]; # 1..1 Defines how the part works

    fhir:SearchParameter.component.expression [ string ]; # 1..1 Subexpression relative to main expression
  ], ...;
]

Changes since DSTU2 R3

SearchParameter SearchParameter.version Added Element
SearchParameter.status
  • Min Cardinality changed from 0 to 1 Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status SearchParameter.experimental Now marked as Modifier http://hl7.org/fhir/ValueSet/publication-status|4.1.0
SearchParameter.contact SearchParameter.base
  • Type changed Change value set from BackboneElement http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to ContactDetail SearchParameter.useContext Added Element SearchParameter.jurisdiction Added Element http://hl7.org/fhir/ValueSet/resource-types|4.1.0
SearchParameter.purpose SearchParameter.type
  • Renamed from requirements to purpose Type changed Change value set from string http://hl7.org/fhir/ValueSet/search-param-type|4.0.0 to markdown http://hl7.org/fhir/ValueSet/search-param-type|4.1.0
SearchParameter.base SearchParameter.xpathUsage
  • Max Cardinality changed Change value set from 1 http://hl7.org/fhir/ValueSet/search-xpath-usage|4.0.0 to * SearchParameter.derivedFrom Added Element http://hl7.org/fhir/ValueSet/search-xpath-usage|4.1.0
SearchParameter.description SearchParameter.target
  • Type changed Change value set from string http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to markdown SearchParameter.expression Added Element http://hl7.org/fhir/ValueSet/resource-types|4.1.0
SearchParameter.comparator
  • Added Element Change value set from http://hl7.org/fhir/ValueSet/search-comparator|4.0.0 to http://hl7.org/fhir/ValueSet/search-comparator|4.1.0
SearchParameter.modifier
  • Added Element SearchParameter.chain Added Element SearchParameter.component Added Element SearchParameter.component.definition Added Element SearchParameter.component.expression Added Element SearchParameter.contact.name deleted SearchParameter.contact.telecom deleted Change value set from http://hl7.org/fhir/ValueSet/search-modifier-code|4.0.0 to http://hl7.org/fhir/ValueSet/search-modifier-code|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 2 3 tests that all execute ok. All tests pass round-trip testing and all 3 r3 resources are valid.). invalid (0 errors). )

Structure

Name Flags Card. Type Description & Constraints doco
. . SearchParameter I TU DomainResource Search Parameter parameter for a resource
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: If an xpath is present, there SHALL be an xpathUsage
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 1..1 uri Logical URI to reference Canonical identifier for this search parameter parameter, represented as a URI (globally unique)
. . . version Σ 0..1 string Business version of the search parameter
. . . name Σ I 1..1 string Name for this search parameter (computer friendly)
. . . derivedFrom 0..1 canonical ( SearchParameter ) Original definition for the search parameter
.. . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description Σ 1..1 markdown Natural language description of the search parameter
.. . useContext Σ 0..* UsageContext Context The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Jurisdiction ValueSet ( Extensible )
. . . purpose 0..1 markdown Why this search parameter is defined
. . . code Σ 1..1 code Code used in URL
. . . base Σ 1..* code The resource type(s) this search parameter applies to
ResourceType ( Required )
. . . type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri | special
SearchParamType ( Required )
. . . derivedFrom 0..1 uri Original Definition for the search parameter description Σ 1..1 markdown Natural language description of the search parameter expression I 0..1 string FHIRPath expression that extracts the values
. . . xpath I 0..1 string XPath that extracts the values
. . . xpathUsage I 0..1 code normal | phonetic | nearby | distance | other
XPathUsageType ( Required )
. . . target 0..* code Types of resource (if a resource reference)
ResourceType ( Required )
. . . multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator ( Required )
. . . modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
SearchModifierCode ( Required )
. . . chain 0..* string Chained names supported
. . . component 0..* BackboneElement For Composite resources to define the parts
. . . . definition 1..1 Reference canonical ( SearchParameter ) Defines how the part works
. . . . expression 1..1 string Subexpression relative to main expression

doco Documentation for this format

UML Diagram ( Legend )

SearchParameter ( DomainResource ) An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which at which an authoritative instance of this search parameter is (or will be) published. The This URL SHOULD include can be the major version target of a canonical reference. It SHALL remain the same when the search parameter. For more information see [Technical and Business Versions](resource.html#versions) parameter is stored on different servers url : uri [1..1] 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 version : string [0..1] 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 name : string [1..1] 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 derivedFrom : canonical [0..1] « SearchParameter » The status of this search parameter. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of a Value Set or Concept Map. an artifact. (Strength=Required) PublicationStatus ! » A boolean Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), education/evaluation/marketing) and is not intended to be used for genuine usage (this element modifies the meaning of other elements) experimental : boolean [0..1] The date (and optionally time) when the search parameter was published. The date must change if and 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 date : dateTime [0..1] The name of the individual or organization or individual that published the search parameter publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] And how it used description : markdown [1..1] The content was developed with a focus and intent of supporting the contexts that are listed. These terms 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 useContext : UsageContext [0..*] A legal or geographic region in which the search parameter is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use use. (Strength=Extensible) Jurisdiction ValueSet + » Explaination Explanation of why this search parameter is needed and why it has been designed as it has purpose : markdown [0..1] The code used in the URL or the parameter name in a parameters resource for this search parameter code : code [1..1] The base resource type(s) that this search parameter can be used against base : code [1..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required) ResourceType ! » The type of value that a search parameter refers to, may contain, and how the content is interpreted type : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required) SearchParamType ! » 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 derivedFrom : uri [0..1] A free text natural language description of the search parameter from a consumer's perspective. and how it used description : markdown [1..1] A FHIRPath expression that returns a set of elements for the search parameter expression : string [0..1] An XPath expression that returns a set of elements for the search parameter xpath : string [0..1] How the search parameter relates to the set of elements returned by evaluating the xpath query xpathUsage : code [0..1] « 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) target : code [0..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required) ResourceType ! » 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 multipleOr : boolean [0..1] Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match multipleAnd : boolean [0..1] Comparators supported for the search parameter comparator : code [0..*] « What Search Comparator Codes are supported in search search. (Strength=Required) SearchComparator ! » A modifier supported for the search parameter modifier : code [0..*] « A supported modifier for a search parameter. (Strength=Required) SearchModifierCode ! » 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, 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 chain : string [0..*] Component The definition of the search parameter that describes this part definition : Reference canonical [1..1] « SearchParameter » A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression expression : string [1..1] Used to define the parts of a composite search parameter component [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 Canonical identifier for this search parameter, represented as a URI (globally unique) -->

 <version value="[string]"/><!-- 0..1 Business version of the search parameter -->
 <

 <name value="[string]"/><!-- ?? 1..1 Name for this search parameter (computer friendly) -->
 <derivedFrom><!-- 0..1 canonical(SearchParameter) Original definition for the search parameter --></derivedFrom>

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <
 <
 <

 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <</useContext>

 <description value="[markdown]"/><!-- 1..1 Natural language description of the search parameter -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>

 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable) --></jurisdiction>
 <

 <purpose value="[markdown]"/><!-- 0..1 Why this search parameter is defined -->

 <code value="[code]"/><!-- 1..1 Code used in URL -->
 <base value="[code]"/><!-- 1..* The resource type(s) this search parameter applies to -->
 <
 <
 <

 <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special -->

 <expression value="[string]"/><!-- ?? 0..1 FHIRPath 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) -->
 <multipleOr value="[boolean]"/><!-- 0..1 Allow multiple values per parameter (or) -->
 <multipleAnd value="[boolean]"/><!-- 0..1 Allow multiple parameters (and) -->

 <comparator value="[code]"/><!-- 0..* eq | ne | gt | lt | ge | le | sa | eb | ap -->
 <
 <

 <modifier value="[code]"/><!-- 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType -->
 <chain value="[string]"/><!-- 0..* Chained names supported -->

 <component>  <!-- 0..* For Composite resources to define the parts -->
  <</definition>

  <definition><!-- 1..1 canonical(SearchParameter) Defines how the part works --></definition>

  <expression value="[string]"/><!-- 1..1 Subexpression relative to main expression -->
 </component>
</SearchParameter>

JSON Template

{doco
  "resourceType" : "SearchParameter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "url" : "<uri>", // R!  Canonical identifier for this search parameter, represented as a URI (globally unique)

  "version" : "<string>", // Business version of the search parameter
  "

  "name" : "<string>", // C? R!  Name for this search parameter (computer friendly)
  "derivedFrom" : { canonical(SearchParameter) }, // Original definition for the search parameter

  "status" : "<code>", // R!  draft | active | retired | unknown
  "
  "
  "

  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)

  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "

  "description" : "<markdown>", // R!  Natural language description of the search parameter
  "useContext" : [{ UsageContext }], // The context that the content is intended to support

  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for search parameter (if applicable)
  "

  "purpose" : "<markdown>", // Why this search parameter is defined

  "code" : "<code>", // R!  Code used in URL
  "base" : ["<code>"], // R!  The resource type(s) this search parameter applies to
  "
  "
  "

  "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri | special

  "expression" : "<string>", // C? FHIRPath expression that extracts the values
  "xpath" : "<string>", // C? XPath that extracts the values
  "xpathUsage" : "<code>", // C? normal | phonetic | nearby | distance | other
  "target" : ["<code>"], // Types of resource (if a resource reference)
  "multipleOr" : <boolean>, // Allow multiple values per parameter (or)
  "multipleAnd" : <boolean>, // Allow multiple parameters (and)

  "comparator" : ["<code>"], // eq | ne | gt | lt | ge | le | sa | eb | ap
  "
  "

  "modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  "chain" : ["<string>"], // Chained names supported

  "component" : [{ // For Composite resources to define the parts
    "

    "definition" : { canonical(SearchParameter) }, // R!  Defines how the part works

    "expression" : "<string>" // R!  Subexpression relative to main expression
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:SearchParameter;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:

  fhir:SearchParameter.url [ uri ]; # 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique)

  fhir:SearchParameter.version [ string ]; # 0..1 Business version of the search parameter
  fhir:SearchParameter.name [ string ]; # 1..1 Name for this search parameter (computer friendly)
  fhir:SearchParameter.derivedFrom [ canonical(SearchParameter) ]; # 0..1 Original definition for the search parameter

  fhir:SearchParameter.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:
  fhir:
  fhir:

  fhir:SearchParameter.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:SearchParameter.date [ dateTime ]; # 0..1 Date last changed
  fhir:SearchParameter.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)

  fhir:SearchParameter.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:

  fhir:SearchParameter.description [ markdown ]; # 1..1 Natural language description of the search parameter
  fhir:SearchParameter.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support

  fhir:SearchParameter.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for search parameter (if applicable)
  fhir:

  fhir:SearchParameter.purpose [ markdown ]; # 0..1 Why this search parameter is defined

  fhir:SearchParameter.code [ code ]; # 1..1 Code used in URL
  fhir:SearchParameter.base [ code ], ... ; # 1..* The resource type(s) this search parameter applies to
  fhir:
  fhir:
  fhir:

  fhir:SearchParameter.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special

  fhir:SearchParameter.expression [ string ]; # 0..1 FHIRPath expression that extracts the values
  fhir:SearchParameter.xpath [ string ]; # 0..1 XPath that extracts the values
  fhir:SearchParameter.xpathUsage [ code ]; # 0..1 normal | phonetic | nearby | distance | other
  fhir:SearchParameter.target [ code ], ... ; # 0..* Types of resource (if a resource reference)
  fhir:SearchParameter.multipleOr [ boolean ]; # 0..1 Allow multiple values per parameter (or)
  fhir:SearchParameter.multipleAnd [ boolean ]; # 0..1 Allow multiple parameters (and)

  fhir:SearchParameter.comparator [ code ], ... ; # 0..* eq | ne | gt | lt | ge | le | sa | eb | ap
  fhir:
  fhir:

  fhir:SearchParameter.modifier [ code ], ... ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  fhir:SearchParameter.chain [ string ], ... ; # 0..* Chained names supported

  fhir:SearchParameter.component [ # 0..* For Composite resources to define the parts
    fhir:

    fhir:SearchParameter.component.definition [ canonical(SearchParameter) ]; # 1..1 Defines how the part works

    fhir:SearchParameter.component.expression [ string ]; # 1..1 Subexpression relative to main expression
  ], ...;
]

Changes since DSTU2 Release 3

SearchParameter SearchParameter.version Added Element
SearchParameter.status
  • Min Cardinality changed from 0 to 1 Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status SearchParameter.experimental Now marked as Modifier http://hl7.org/fhir/ValueSet/publication-status|4.1.0
SearchParameter.contact SearchParameter.base
  • Type changed Change value set from BackboneElement http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to ContactDetail SearchParameter.useContext Added Element SearchParameter.jurisdiction Added Element http://hl7.org/fhir/ValueSet/resource-types|4.1.0
SearchParameter.purpose SearchParameter.type
  • Renamed from requirements to purpose Type changed Change value set from string http://hl7.org/fhir/ValueSet/search-param-type|4.0.0 to markdown http://hl7.org/fhir/ValueSet/search-param-type|4.1.0
SearchParameter.base SearchParameter.xpathUsage
  • Max Cardinality changed Change value set from 1 http://hl7.org/fhir/ValueSet/search-xpath-usage|4.0.0 to * SearchParameter.derivedFrom Added Element http://hl7.org/fhir/ValueSet/search-xpath-usage|4.1.0
SearchParameter.description SearchParameter.target
  • Type changed Change value set from string http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to markdown SearchParameter.expression Added Element http://hl7.org/fhir/ValueSet/resource-types|4.1.0
SearchParameter.comparator
  • Added Element Change value set from http://hl7.org/fhir/ValueSet/search-comparator|4.0.0 to http://hl7.org/fhir/ValueSet/search-comparator|4.1.0
SearchParameter.modifier
  • Added Element SearchParameter.chain Added Element SearchParameter.component Added Element SearchParameter.component.definition Added Element SearchParameter.component.expression Added Element SearchParameter.contact.name deleted SearchParameter.contact.telecom deleted Change value set from http://hl7.org/fhir/ValueSet/search-modifier-code|4.0.0 to http://hl7.org/fhir/ValueSet/search-modifier-code|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 2 3 tests that all execute ok. All tests pass round-trip testing and all 3 r3 resources are valid.). invalid (0 errors). )

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

Path Definition Type Reference
SearchParameter.status The lifecycle status of a Value Set or Concept Map. an artifact. Required PublicationStatus
SearchParameter.jurisdiction Countries and regions within which this artifact is targeted for use use. Extensible Jurisdiction ValueSet
SearchParameter.base
SearchParameter.target
One of the resource types defined as part of this version of FHIR. Required Resource Types
SearchParameter.type Data types allowed to be used for search parameters. Required SearchParamType
SearchParameter.xpathUsage How a search parameter relates to the set of elements returned by evaluating its xpath query. Required XPathUsageType
SearchParameter.comparator What Search Comparator Codes are supported in search search. Required SearchComparator
SearchParameter.modifier A supported modifier for a search parameter. Required SearchModifierCode

id Level Location Description Expression
spd-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
spd-1 : Rule (base) If an xpath is present, there SHALL be an xpathUsage ( expression : xpath.empty() or xpathUsage.exists() )
spd-2 : Rule (base) Search parameters can only have chain names when the search parameter type is 'reference' ( expression : chain.empty() or type = 'reference' )

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.

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 Expression In Common
base token The resource type(s) this search parameter applies to SearchParameter.base
code token Code used in URL SearchParameter.code
component reference Defines how the part works SearchParameter.component.definition
( SearchParameter )
context token A use context assigned to the search parameter (SearchParameter.useContext.value as CodeableConcept)
context-quantity quantity A quantity- or range-valued use context assigned to the search parameter (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range)
context-type token A type of use context assigned to the search parameter SearchParameter.useContext.code
context-type-quantity composite A use context type and quantity- or range-based value assigned to the search parameter On SearchParameter.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-value composite A use context type and value assigned to the search parameter On SearchParameter.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date date The search parameter publication date SearchParameter.date
derived-from uri reference Original Definition definition for the search parameter SearchParameter.derivedFrom
( SearchParameter )
description string The description of the search parameter SearchParameter.description
jurisdiction token Intended jurisdiction for the search parameter SearchParameter.jurisdiction
name string Computationally friendly name of the search parameter SearchParameter.name
publisher string Name of the publisher of the search parameter SearchParameter.publisher
status token The current status of the search parameter SearchParameter.status
target token Types of resource (if a resource reference) SearchParameter.target
type token number | date | string | token | reference | composite | quantity | uri | special SearchParameter.type
url uri The uri that identifies the search parameter SearchParameter.url
version token The business version of the search parameter SearchParameter.version