Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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

5.6 Resource SearchParameter - Content

FHIR Infrastructure icon Work GroupMaturity Level: 3 Trial UseSecurity 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.

5.6.1 Scope and Usage

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 typically refer to the search parameter from a client (SearchParameter.code)
  • how the search parameter is to be understood by the server
  • where in the source resource the parameter matches

5.6.2 Boundaries and Relationships

5.6.3 Background and Context

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.

5.6.4 References to this Resource

5.6.5 Resource Content

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. SearchParameter TUDomainResourceSearch 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 expression is present, there SHALL be a processingMode
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
+ Rule: Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'.

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... version Σ0..1stringBusiness version of the search parameter
... versionAlgorithm[x] Σ0..1How to compare versions
Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC1..1stringName for this search parameter (computer friendly)
... title ΣT0..1stringName for this search parameter (human friendly)
... derivedFrom 0..1canonical(SearchParameter)Original definition for the search parameter
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description ΣT1..1markdownNatural language description of the search parameter
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this search parameter is defined
... code Σ1..1codeRecommended name for parameter in search url
... base Σ1..*codeThe resource type(s) this search parameter applies to
All Resource Types (Required)

... type Σ1..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
... expression C0..1stringFHIRPath expression that extracts the values
... processingMode C0..1codenormal | phonetic | other
SearchProcessingModeType (Required)
... constraint 0..1stringFHIRPath expression that constraints the usage of this SearchParamete
... target 0..*codeTypes of resource (if a resource reference)
Resource Types (Required)

... multipleOr 0..1booleanAllow multiple values per parameter (or)
... multipleAnd 0..1booleanAllow multiple parameters (and)
... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator (Required)

... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
SearchModifierCode (Required)

... chain 0..*stringChained names supported

... component 0..*BackboneElementFor Composite resources to define the parts

.... definition 1..1canonical(SearchParameter)Defines how the part works
.... expression 1..1stringSubexpression relative to main expression

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

SearchParameter (DomainResource) +CanonicalResourceAn absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different serversurl : 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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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 generationname : string [1..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the search parametertitle : string [0..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 parameterderivedFrom : 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] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the search parameter was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changesdate : dateTime [0..1]The name of the organization or individual tresponsible for the release and ongoing maintenance of the search parameterpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]And how it useddescription : markdown [1..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instancesuseContext : UsageContext [0..*]A legal or geographic region in which the search parameter is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this search parameter is needed and why it has been designed as it haspurpose : markdown [0..1]The label that is recommended to be used in the URL or the parameter name in a parameters resource for this search parameter. In some cases, servers may need to use a different CapabilityStatement searchParam.name to differentiate between multiple SearchParameters that happen to have the same codecode : code [1..1]The base resource type(s) that this search parameter can be used againstbase : code [1..*] « null (Strength=Required)AllResourceTypes! »The type of value that a search parameter may contain, and how the content is interpretedtype : code [1..1] « null (Strength=Required)SearchParamType! »A FHIRPath expression that returns a set of elements for the search parameterexpression : string [0..1] « This element has or is affected by some invariantsC »How the search parameter relates to the set of elements returned by evaluating the expression queryprocessingMode : code [0..1] « null (Strength=Required)SearchProcessingModeType! » « This element has or is affected by some invariantsC »FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicableconstraint : string [0..1]Types of resource (if a resource is referenced)target : code [0..*] « null (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 matchmultipleOr : 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 matchmultipleAnd : boolean [0..1]Comparators supported for the search parametercomparator : code [0..*] « null (Strength=Required)SearchComparator! »A modifier supported for the search parametermodifier : code [0..*] « null (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 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 typechain : string [0..*]ComponentThe definition of the search parameter that describes this partdefinition : canonical [1..1] « SearchParameter »A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expressionexpression : string [1..1]Used to define the parts of a composite search parametercomponent[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 -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this search parameter (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this search parameter (human 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/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <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 Recommended name for parameter in search 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]"/><!-- I 0..1 FHIRPath expression that extracts the values -->
 <processingMode value="[code]"/><!-- I 0..1 normal | phonetic | other -->
 <constraint value="[string]"/><!-- 0..1 FHIRPath expression that constraints the usage of this SearchParamete -->
 <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 | of-type | code-text | text-advanced | iterate -->
 <chain value="[string]"/><!-- 0..* Chained names supported -->
 <component>  <!-- 0..* For Composite resources to define the parts -->
  <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
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this search parameter (computer friendly)
  "title" : "<string>", // Name for this search parameter (human 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/steward (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!  Recommended name for parameter in search 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>", // I FHIRPath expression that extracts the values
  "processingMode" : "<code>", // I normal | phonetic | other
  "constraint" : "<string>", // FHIRPath expression that constraints the usage of this SearchParamete
  "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 | of-type | code-text | text-advanced | iterate
  "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: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
  # SearchParameter.versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:SearchParameter.versionAlgorithmString [ string ]
    fhir:SearchParameter.versionAlgorithmCoding [ Coding ]
  fhir:SearchParameter.name [ string ]; # 1..1 I Name for this search parameter (computer friendly)
  fhir:SearchParameter.title [ string ]; # 0..1 Name for this search parameter (human 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: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/steward (organization or individual)
  fhir:SearchParameter.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  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:SearchParameter.purpose [ markdown ]; # 0..1 Why this search parameter is defined
  fhir:SearchParameter.code [ code ]; # 1..1 Recommended name for parameter in search url
  fhir:SearchParameter.base [ code ], ... ; # 1..* The resource type(s) this search parameter applies to
  fhir:SearchParameter.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
  fhir:SearchParameter.expression [ string ]; # 0..1 I FHIRPath expression that extracts the values
  fhir:SearchParameter.processingMode [ code ]; # 0..1 I normal | phonetic | other
  fhir:SearchParameter.constraint [ string ]; # 0..1 FHIRPath expression that constraints the usage of this SearchParamete
  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:SearchParameter.modifier [ code ], ... ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
  fhir:SearchParameter.chain [ string ], ... ; # 0..* Chained names supported
  fhir:SearchParameter.component [ # 0..* For Composite resources to define the parts
    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 R4

SearchParameter
SearchParameter.versionAlgorithm[x]
  • Added Element
SearchParameter.title
  • Added Element
SearchParameter.base
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/all-resource-types|5.0.0-snapshot3
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/all-resource-types|5.0.0-snapshot3
SearchParameter.processingMode
  • Added Element
SearchParameter.constraint
  • Added Element
SearchParameter.xpath
  • deleted
SearchParameter.xpathUsage
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. SearchParameter TUDomainResourceSearch 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 expression is present, there SHALL be a processingMode
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
+ Rule: Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'.

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... version Σ0..1stringBusiness version of the search parameter
... versionAlgorithm[x] Σ0..1How to compare versions
Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC1..1stringName for this search parameter (computer friendly)
... title ΣT0..1stringName for this search parameter (human friendly)
... derivedFrom 0..1canonical(SearchParameter)Original definition for the search parameter
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description ΣT1..1markdownNatural language description of the search parameter
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this search parameter is defined
... code Σ1..1codeRecommended name for parameter in search url
... base Σ1..*codeThe resource type(s) this search parameter applies to
All Resource Types (Required)

... type Σ1..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
... expression C0..1stringFHIRPath expression that extracts the values
... processingMode C0..1codenormal | phonetic | other
SearchProcessingModeType (Required)
... constraint 0..1stringFHIRPath expression that constraints the usage of this SearchParamete
... target 0..*codeTypes of resource (if a resource reference)
Resource Types (Required)

... multipleOr 0..1booleanAllow multiple values per parameter (or)
... multipleAnd 0..1booleanAllow multiple parameters (and)
... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator (Required)

... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
SearchModifierCode (Required)

... chain 0..*stringChained names supported

... component 0..*BackboneElementFor Composite resources to define the parts

.... definition 1..1canonical(SearchParameter)Defines how the part works
.... expression 1..1stringSubexpression relative to main expression

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

SearchParameter (DomainResource) +CanonicalResourceAn absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different serversurl : 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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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 generationname : string [1..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the search parametertitle : string [0..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 parameterderivedFrom : 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] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the search parameter was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changesdate : dateTime [0..1]The name of the organization or individual tresponsible for the release and ongoing maintenance of the search parameterpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]And how it useddescription : markdown [1..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instancesuseContext : UsageContext [0..*]A legal or geographic region in which the search parameter is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this search parameter is needed and why it has been designed as it haspurpose : markdown [0..1]The label that is recommended to be used in the URL or the parameter name in a parameters resource for this search parameter. In some cases, servers may need to use a different CapabilityStatement searchParam.name to differentiate between multiple SearchParameters that happen to have the same codecode : code [1..1]The base resource type(s) that this search parameter can be used againstbase : code [1..*] « null (Strength=Required)AllResourceTypes! »The type of value that a search parameter may contain, and how the content is interpretedtype : code [1..1] « null (Strength=Required)SearchParamType! »A FHIRPath expression that returns a set of elements for the search parameterexpression : string [0..1] « This element has or is affected by some invariantsC »How the search parameter relates to the set of elements returned by evaluating the expression queryprocessingMode : code [0..1] « null (Strength=Required)SearchProcessingModeType! » « This element has or is affected by some invariantsC »FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicableconstraint : string [0..1]Types of resource (if a resource is referenced)target : code [0..*] « null (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 matchmultipleOr : 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 matchmultipleAnd : boolean [0..1]Comparators supported for the search parametercomparator : code [0..*] « null (Strength=Required)SearchComparator! »A modifier supported for the search parametermodifier : code [0..*] « null (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 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 typechain : string [0..*]ComponentThe definition of the search parameter that describes this partdefinition : canonical [1..1] « SearchParameter »A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expressionexpression : string [1..1]Used to define the parts of a composite search parametercomponent[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 -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this search parameter (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this search parameter (human 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/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <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 Recommended name for parameter in search 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]"/><!-- I 0..1 FHIRPath expression that extracts the values -->
 <processingMode value="[code]"/><!-- I 0..1 normal | phonetic | other -->
 <constraint value="[string]"/><!-- 0..1 FHIRPath expression that constraints the usage of this SearchParamete -->
 <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 | of-type | code-text | text-advanced | iterate -->
 <chain value="[string]"/><!-- 0..* Chained names supported -->
 <component>  <!-- 0..* For Composite resources to define the parts -->
  <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
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this search parameter (computer friendly)
  "title" : "<string>", // Name for this search parameter (human 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/steward (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!  Recommended name for parameter in search 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>", // I FHIRPath expression that extracts the values
  "processingMode" : "<code>", // I normal | phonetic | other
  "constraint" : "<string>", // FHIRPath expression that constraints the usage of this SearchParamete
  "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 | of-type | code-text | text-advanced | iterate
  "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: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
  # SearchParameter.versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:SearchParameter.versionAlgorithmString [ string ]
    fhir:SearchParameter.versionAlgorithmCoding [ Coding ]
  fhir:SearchParameter.name [ string ]; # 1..1 I Name for this search parameter (computer friendly)
  fhir:SearchParameter.title [ string ]; # 0..1 Name for this search parameter (human 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: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/steward (organization or individual)
  fhir:SearchParameter.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  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:SearchParameter.purpose [ markdown ]; # 0..1 Why this search parameter is defined
  fhir:SearchParameter.code [ code ]; # 1..1 Recommended name for parameter in search url
  fhir:SearchParameter.base [ code ], ... ; # 1..* The resource type(s) this search parameter applies to
  fhir:SearchParameter.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
  fhir:SearchParameter.expression [ string ]; # 0..1 I FHIRPath expression that extracts the values
  fhir:SearchParameter.processingMode [ code ]; # 0..1 I normal | phonetic | other
  fhir:SearchParameter.constraint [ string ]; # 0..1 FHIRPath expression that constraints the usage of this SearchParamete
  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:SearchParameter.modifier [ code ], ... ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
  fhir:SearchParameter.chain [ string ], ... ; # 0..* Chained names supported
  fhir:SearchParameter.component [ # 0..* For Composite resources to define the parts
    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 Release 4

SearchParameter
SearchParameter.versionAlgorithm[x]
  • Added Element
SearchParameter.title
  • Added Element
SearchParameter.base
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/all-resource-types|5.0.0-snapshot3
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/all-resource-types|5.0.0-snapshot3
SearchParameter.processingMode
  • Added Element
SearchParameter.constraint
  • Added Element
SearchParameter.xpath
  • deleted
SearchParameter.xpathUsage
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

5.6.5.1 Terminology Bindings

PathDefinitionTypeReference
SearchParameter.versionAlgorithm[x]

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

ExtensibleVersionAlgorithm
SearchParameter.status

The lifecycle status of an artifact.

RequiredPublicationStatus
SearchParameter.jurisdiction

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

ExtensibleJurisdictionValueSet
SearchParameter.base

All fhir data types (including abstract resources)

RequiredAllResourceTypes
SearchParameter.type

Data types allowed to be used for search parameters.

RequiredSearchParamType
SearchParameter.processingMode

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

RequiredSearchProcessingModeType
SearchParameter.target

All fhir data types

RequiredResourceType
SearchParameter.comparator

What Search Comparator Codes are supported in search.

RequiredSearchComparator
SearchParameter.modifier

A supported modifier for a search parameter.

RequiredSearchModifierCode

5.6.5.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
img spd-1Rule (base)If an expression is present, there SHALL be a processingModeexpression.empty() or processingMode.exists()
img cnl-1Warning SearchParameter.urlURL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
img spd-2Rule (base)Search parameters can only have chain names when the search parameter type is 'reference'chain.empty() or type = 'reference'
img spd-3Rule (base)Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'.comparator.empty() or (type in ('number' | 'date' | 'quantity' | 'special'))

5.6.6 SearchParameters on Extensions

The SearchParameter resource may be used to define searches on extensions. A simple definition defines the code, the base resource the extension can be found in, and a type, and an expression. Assume that the extension is http://example.org/fhir/StructureDefinition/extension-thumb-length which has a value that is a quantity, and that is used on patient, then an appropriate SearchParameter would be: 

   "code" : "thumb-length",
   "base" : ["Patient"],
   "type" : "quantity",
   "expression" : "Patient.extension('http://example.org/fhir/StructureDefinition/extension-thumb-length').value"

Servers MAY attempt to process expressions that just select the extension without the .value, but this is not required and may be discouraged or deprecated in the future.

Extensions may have multiple types with different search behaviours, so the type can be specifically selected: 

   "code" : "thumb-length-code",
   "base" : ["Patient"],
   "type" : "token",
   "expression" : "Patient.extension('http://example.org/fhir/StructureDefinition/extension-thumb-length').value.ofType(CodeableConcept)"

This example would select coded thumb lengths and index them only for the thumb-length-code search parameter. When an extension can have multiple types with incompatible search behaviour, the search parameters have to do this. Note that is type casting the extension directly (e.g. Patient.extension('...').ofType(CodeableConcept)) will lead to an empty index, since the extension is not a CodeableConcept itself.

When extensions can be used in multiple places, these places are enumerated in the expression: 

Patient.extension('http://example.org/fhir/StructureDefinition/extension-thumb-length').value
 | Patient.contact.extension('http://example.org/fhir/StructureDefinition/extension-thumb-length').value
 | Practitioner.extension('http://example.org/fhir/StructureDefinition/extension-thumb-length').value

Notes:

  • If the extension's context specifies multiple resources, they are represented with multiple elements in the SearchParameter.base array
  • An expression like Resource.descendents.extension('extension-url').value is possible, but this is a low performance option for a server to evaluate, and search parameter expressions are performance sensitive

5.6.7 Search Parameters

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

NameTypeDescriptionExpressionIn Common
basetokenThe resource type(s) this search parameter applies toSearchParameter.base
codetokenCode used in URLSearchParameter.code
componentreferenceDefines how the part worksSearchParameter.component.definition
(SearchParameter)
contexttokenA use context assigned to the search parameter(SearchParameter.useContext.value as CodeableConcept)30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the search parameter(SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range)30 Resources
context-typetokenA type of use context assigned to the search parameterSearchParameter.useContext.code30 Resources
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the search parameterOn SearchParameter.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		30 Resources
context-type-valuecompositeA use context type and value assigned to the search parameterOn SearchParameter.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		30 Resources
datedateThe search parameter publication dateSearchParameter.date30 Resources
derived-fromreferenceOriginal definition for the search parameterSearchParameter.derivedFrom
(SearchParameter)
descriptionstringThe description of the search parameterSearchParameter.description28 Resources
jurisdictiontokenIntended jurisdiction for the search parameterSearchParameter.jurisdiction26 Resources
namestringComputationally friendly name of the search parameterSearchParameter.name26 Resources
publisherstringName of the publisher of the search parameterSearchParameter.publisher30 Resources
statustokenThe current status of the search parameterSearchParameter.status34 Resources
targettokenTypes of resource (if a resource reference)SearchParameter.target
typetokennumber | date | string | token | reference | composite | quantity | uri | specialSearchParameter.type
urluriThe uri that identifies the search parameterSearchParameter.url33 Resources
versiontokenThe business version of the search parameterSearchParameter.version30 Resources