Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). 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: 5 Trial UseSecurity Category: Anonymous Compartments: No 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 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

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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... identifier Σ0..*IdentifierAdditional identifier for the search parameter (business identifier)

... version Σ0..1stringBusiness version of the search parameter
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: 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
Binding: 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 ΣXD0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this search parameter is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... code Σ1..1codeRecommended name for parameter in search url
... base Σ1..*codeThe resource type(s) this search parameter applies to
Binding: Version Independent Resource Types (All) (Required)
Additional BindingsPurpose
All Resource TypesUI Binding


... type ΣC1..1codenumber | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (Required)
... expression C0..1stringFHIRPath expression that extracts the values
... processingMode C0..1codenormal | phonetic | other
Binding: Search Processing Mode Type (Required)
... constraint 0..1stringFHIRPath expression that constraints the usage of this SearchParamete
... target 0..*codeTypes of resource (if a resource reference)
Binding: Version Independent Resource Types (All) (Required)
Additional BindingsPurpose
All Resource TypesUI Binding


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

... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: Search Modifier Code (Required)

... chain C0..*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) +CanonicalResource🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดurl : uri [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดidentifier : Identifier [0..*]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดversion : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดversionAlgorithm[x] : DataType [0..1] « string|Coding; 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุด VersionAlgorithm+ »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดname : string [1..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดtitle : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดderivedFrom : canonical [0..1] « SearchParameter »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดstatus : code [1..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดPublicationStatus! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดexperimental : boolean [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดdate : dateTime [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดpublisher : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcontact : ContactDetail [0..*]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดdescription : markdown [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดuseContext : UsageContext [0..*]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดjurisdiction : CodeableConcept [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดJurisdictionValueSet+ »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดpurpose : markdown [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcopyright : markdown [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcopyrightLabel : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcode : code [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดbase : code [1..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดVersionIndependentResourceTyp...! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดtype : code [1..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchParamType! » « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดexpression : string [0..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดprocessingMode : code [0..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchProcessingModeType! » « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดconstraint : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดtarget : code [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดVersionIndependentResourceTyp...! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดmultipleOr : boolean [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดmultipleAnd : boolean [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcomparator : code [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchComparator! » « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดmodifier : code [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchModifierCode! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดchain : string [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »Component🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดdefinition : canonical [1..1] « SearchParameter »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดexpression : string [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุด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) -->
 <identifier><!-- 0..* Identifier Additional identifier for the search parameter (business identifier) --></identifier>
 <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 -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <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]"/><!-- I 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]"/><!-- I 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]"/><!-- I 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)
  "identifier" : [{ Identifier }], // Additional identifier for the search parameter (business identifier)
  "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
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "code" : "<code>", // R!  Recommended name for parameter in search url
  "base" : ["<code>"], // R!  The resource type(s) this search parameter applies to
  "type" : "<code>", // I 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>"], // I 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>"], // I 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:url [ uri ] ; # 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the search parameter (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the search parameter
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this search parameter (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this search parameter (human friendly)
  fhir:derivedFrom [ canonical(SearchParameter) ] ; # 0..1 Original definition for the search parameter
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 1..1 Natural language description of the search parameter
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for search parameter (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this search parameter is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:code [ code ] ; # 1..1 Recommended name for parameter in search url
  fhir:base  ( [ code ] ... ) ; # 1..* The resource type(s) this search parameter applies to
  fhir:type [ code ] ; # 1..1 I number | date | string | token | reference | composite | quantity | uri | special
  fhir:expression [ string ] ; # 0..1 I FHIRPath expression that extracts the values
  fhir:processingMode [ code ] ; # 0..1 I normal | phonetic | other
  fhir:constraint [ string ] ; # 0..1 FHIRPath expression that constraints the usage of this SearchParamete
  fhir:target  ( [ code ] ... ) ; # 0..* Types of resource (if a resource reference)
  fhir:multipleOr [ boolean ] ; # 0..1 Allow multiple values per parameter (or)
  fhir:multipleAnd [ boolean ] ; # 0..1 Allow multiple parameters (and)
  fhir:comparator  ( [ code ] ... ) ; # 0..* I eq | ne | gt | lt | ge | le | sa | eb | ap
  fhir:modifier  ( [ code ] ... ) ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
  fhir:chain  ( [ string ] ... ) ; # 0..* I Chained names supported
  fhir:component ( [ # 0..* For Composite resources to define the parts
    fhir:definition [ canonical(SearchParameter) ] ; # 1..1 Defines how the part works
    fhir:expression [ string ] ; # 1..1 Subexpression relative to main expression
  ] ... ) ;
]

Changes from both R4 and R4B

SearchParameter
SearchParameter.identifier
  • Added Element
SearchParameter.versionAlgorithm[x]
  • Added Element
SearchParameter.title
  • Added Element
SearchParameter.copyright
  • Added Element
SearchParameter.copyrightLabel
  • Added Element
SearchParameter.base
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to Version Independent Resource Types (All)
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, CanonicalResource, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, MetadataResource, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport, BodySite, Conformance, DataElement, DeviceComponent, DeviceUseRequest, DiagnosticOrder, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ImagingObjectSelection, MedicationOrder, MedicationUsage, Order, OrderResponse, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
SearchParameter.processingMode
  • Renamed from xpathUsage to processingMode
  • Change value set from http://hl7.org/fhir/ValueSet/search-xpath-usage|4.0.0 to Search Processing Mode Type
  • Remove codes nearby, distance
SearchParameter.constraint
  • Added Element
SearchParameter.target
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to Version Independent Resource Types (All)
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, CanonicalResource, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, MetadataResource, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport, BodySite, Conformance, DataElement, DeviceComponent, DeviceUseRequest, DiagnosticOrder, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ImagingObjectSelection, MedicationOrder, MedicationUsage, Order, OrderResponse, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
SearchParameter.modifier
  • Remove code ofType
  • Add codes of-type, code-text, text-advanced, iterate
SearchParameter.xpath
  • Deleted (XPath removed due to lack of use and maintenance)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... identifier Σ0..*IdentifierAdditional identifier for the search parameter (business identifier)

... version Σ0..1stringBusiness version of the search parameter
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: 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
Binding: 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 ΣXD0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this search parameter is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... code Σ1..1codeRecommended name for parameter in search url
... base Σ1..*codeThe resource type(s) this search parameter applies to
Binding: Version Independent Resource Types (All) (Required)
Additional BindingsPurpose
All Resource TypesUI Binding


... type ΣC1..1codenumber | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (Required)
... expression C0..1stringFHIRPath expression that extracts the values
... processingMode C0..1codenormal | phonetic | other
Binding: Search Processing Mode Type (Required)
... constraint 0..1stringFHIRPath expression that constraints the usage of this SearchParamete
... target 0..*codeTypes of resource (if a resource reference)
Binding: Version Independent Resource Types (All) (Required)
Additional BindingsPurpose
All Resource TypesUI Binding


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

... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: Search Modifier Code (Required)

... chain C0..*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) +CanonicalResource🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดurl : uri [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดidentifier : Identifier [0..*]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดversion : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดversionAlgorithm[x] : DataType [0..1] « string|Coding; 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุด VersionAlgorithm+ »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดname : string [1..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดtitle : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดderivedFrom : canonical [0..1] « SearchParameter »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดstatus : code [1..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดPublicationStatus! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดexperimental : boolean [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดdate : dateTime [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดpublisher : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcontact : ContactDetail [0..*]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดdescription : markdown [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดuseContext : UsageContext [0..*]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดjurisdiction : CodeableConcept [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดJurisdictionValueSet+ »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดpurpose : markdown [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcopyright : markdown [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcopyrightLabel : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcode : code [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดbase : code [1..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดVersionIndependentResourceTyp...! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดtype : code [1..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchParamType! » « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดexpression : string [0..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดprocessingMode : code [0..1] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchProcessingModeType! » « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดconstraint : string [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดtarget : code [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดVersionIndependentResourceTyp...! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดmultipleOr : boolean [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดmultipleAnd : boolean [0..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดcomparator : code [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchComparator! » « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดmodifier : code [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดSearchModifierCode! »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดchain : string [0..*] « 🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดC »Component🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดdefinition : canonical [1..1] « SearchParameter »🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุดexpression : string [1..1]🔴 Hot News: fhir/R/searchparameter.html - สรุปดราม่าล่าสุด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) -->
 <identifier><!-- 0..* Identifier Additional identifier for the search parameter (business identifier) --></identifier>
 <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 -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <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]"/><!-- I 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]"/><!-- I 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]"/><!-- I 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)
  "identifier" : [{ Identifier }], // Additional identifier for the search parameter (business identifier)
  "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
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "code" : "<code>", // R!  Recommended name for parameter in search url
  "base" : ["<code>"], // R!  The resource type(s) this search parameter applies to
  "type" : "<code>", // I 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>"], // I 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>"], // I 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:url [ uri ] ; # 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the search parameter (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the search parameter
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this search parameter (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this search parameter (human friendly)
  fhir:derivedFrom [ canonical(SearchParameter) ] ; # 0..1 Original definition for the search parameter
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 1..1 Natural language description of the search parameter
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for search parameter (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this search parameter is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:code [ code ] ; # 1..1 Recommended name for parameter in search url
  fhir:base  ( [ code ] ... ) ; # 1..* The resource type(s) this search parameter applies to
  fhir:type [ code ] ; # 1..1 I number | date | string | token | reference | composite | quantity | uri | special
  fhir:expression [ string ] ; # 0..1 I FHIRPath expression that extracts the values
  fhir:processingMode [ code ] ; # 0..1 I normal | phonetic | other
  fhir:constraint [ string ] ; # 0..1 FHIRPath expression that constraints the usage of this SearchParamete
  fhir:target  ( [ code ] ... ) ; # 0..* Types of resource (if a resource reference)
  fhir:multipleOr [ boolean ] ; # 0..1 Allow multiple values per parameter (or)
  fhir:multipleAnd [ boolean ] ; # 0..1 Allow multiple parameters (and)
  fhir:comparator  ( [ code ] ... ) ; # 0..* I eq | ne | gt | lt | ge | le | sa | eb | ap
  fhir:modifier  ( [ code ] ... ) ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
  fhir:chain  ( [ string ] ... ) ; # 0..* I Chained names supported
  fhir:component ( [ # 0..* For Composite resources to define the parts
    fhir:definition [ canonical(SearchParameter) ] ; # 1..1 Defines how the part works
    fhir:expression [ string ] ; # 1..1 Subexpression relative to main expression
  ] ... ) ;
]

Changes from both R4 and R4B

SearchParameter
SearchParameter.identifier
  • Added Element
SearchParameter.versionAlgorithm[x]
  • Added Element
SearchParameter.title
  • Added Element
SearchParameter.copyright
  • Added Element
SearchParameter.copyrightLabel
  • Added Element
SearchParameter.base
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to Version Independent Resource Types (All)
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, CanonicalResource, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, MetadataResource, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport, BodySite, Conformance, DataElement, DeviceComponent, DeviceUseRequest, DiagnosticOrder, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ImagingObjectSelection, MedicationOrder, MedicationUsage, Order, OrderResponse, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
SearchParameter.processingMode
  • Renamed from xpathUsage to processingMode
  • Change value set from http://hl7.org/fhir/ValueSet/search-xpath-usage|4.0.0 to Search Processing Mode Type
  • Remove codes nearby, distance
SearchParameter.constraint
  • Added Element
SearchParameter.target
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to Version Independent Resource Types (All)
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, CanonicalResource, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, MetadataResource, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport, BodySite, Conformance, DataElement, DeviceComponent, DeviceUseRequest, DiagnosticOrder, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ImagingObjectSelection, MedicationOrder, MedicationUsage, Order, OrderResponse, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
SearchParameter.modifier
  • Remove code ofType
  • Add codes of-type, code-text, text-advanced, iterate
SearchParameter.xpath
  • Deleted (XPath removed due to lack of use and maintenance)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

 

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

PathValueSetTypeDocumentation
SearchParameter.versionAlgorithm[x] VersionAlgorithm Extensible

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

SearchParameter.status PublicationStatus Required

The lifecycle status of an artifact.

SearchParameter.jurisdiction JurisdictionValueSet Extensible

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.

SearchParameter.base VersionIndependentResourceTypesAll Required

Current and past FHIR resource types (deleted or renamed), including abstract types

  All Resource Types ui
SearchParameter.type SearchParamType Required

Data types allowed to be used for search parameters.

SearchParameter.processingMode SearchProcessingModeType Required

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

SearchParameter.target VersionIndependentResourceTypesAll Required

Current and past FHIR resource types (deleted or renamed), including abstract types

  All Resource Types ui
SearchParameter.comparator SearchComparator Required

What Search Comparator Codes are supported in search.

SearchParameter.modifier SearchModifierCode Required

A supported modifier for a search parameter.

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 problematicexists() implies 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'))

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 behaviors, 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 behavior, 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

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to 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.ofType(CodeableConcept))30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the search parameter(SearchParameter.useContext.value.ofType(Quantity)) | (SearchParameter.useContext.value.ofType(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
identifier NtokenExternal identifier for the search parameterSearchParameter.identifier34 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.status35 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.url34 Resources
versiontokenThe business version of the search parameterSearchParameter.version30 Resources