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
Search parameters for the Resource SearchParameter - Search Parameters resource. Also 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.
http://hl7.org/fhir/SearchParameter/SearchParameter-baseParameter base:token
The resource type(s) this search parameter applies to
SearchParameter.basehttp://hl7.org/fhir/SearchParameter/SearchParameter-codeParameter code:token
Code used in URL
SearchParameter.codehttp://hl7.org/fhir/SearchParameter/SearchParameter-componentParameter component:reference
Defines how the part works
SearchParameter.component.definitionhttp://hl7.org/fhir/SearchParameter/CanonicalResource-contextParameter context:token
SearchParameter: A use context assigned to the search parameter
(SearchParameter.useContext.value.ofType(CodeableConcept))http://hl7.org/fhir/SearchParameter/CanonicalResource-context-quantityParameter context-quantity:quantity
SearchParameter: A quantity- or range-valued use context assigned to the search parameter
(SearchParameter.useContext.value.ofType(Quantity)) | (SearchParameter.useContext.value.ofType(Range))http://hl7.org/fhir/SearchParameter/CanonicalResource-context-typeParameter context-type:token
SearchParameter: A type of use context assigned to the search parameter
SearchParameter.useContext.codehttp://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-quantityParameter context-type-quantity:composite
SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter
SearchParameter.useContextComponents
codevalue.ofType(Quantity) | value.ofType(Range)http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-valueParameter context-type-value:composite
SearchParameter: A use context type and value assigned to the search parameter
SearchParameter.useContextComponents
codevalue.ofType(CodeableConcept)http://hl7.org/fhir/SearchParameter/CanonicalResource-dateParameter date:date
SearchParameter: The search parameter publication date
SearchParameter.datehttp://hl7.org/fhir/SearchParameter/SearchParameter-derived-fromParameter derived-from:reference
Original definition for the search parameter
SearchParameter.derivedFromhttp://hl7.org/fhir/SearchParameter/CanonicalResource-descriptionParameter description:string
SearchParameter: The description of the search parameter
SearchParameter.descriptionhttp://hl7.org/fhir/SearchParameter/CanonicalResource-identifierParameter identifier:token
SearchParameter: External identifier for the search parameter
SearchParameter.identifierhttp://hl7.org/fhir/SearchParameter/CanonicalResource-jurisdictionParameter jurisdiction:token
SearchParameter: Intended jurisdiction for the search parameter
SearchParameter.jurisdictionhttp://hl7.org/fhir/SearchParameter/CanonicalResource-nameParameter name:string
SearchParameter: Computationally friendly name of the search parameter
SearchParameter.namehttp://hl7.org/fhir/SearchParameter/CanonicalResource-publisherParameter publisher:string
SearchParameter: Name of the publisher of the search parameter
SearchParameter.publisherhttp://hl7.org/fhir/SearchParameter/CanonicalResource-statusParameter status:token
SearchParameter: The current status of the search parameter
SearchParameter.statushttp://hl7.org/fhir/SearchParameter/SearchParameter-targetParameter target:token
Types of resource (if a resource reference)
SearchParameter.targethttp://hl7.org/fhir/SearchParameter/SearchParameter-typeParameter type:token
number | date | string | token | reference | composite | quantity | uri | special
SearchParameter.typehttp://hl7.org/fhir/SearchParameter/CanonicalResource-urlParameter url:uri
SearchParameter: The uri that identifies the search parameter
SearchParameter.urlhttp://hl7.org/fhir/SearchParameter/CanonicalResource-versionParameter version:token
SearchParameter: The business version of the search parameter
SearchParameter.version