Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

2.1.27.5.12 2.1.27.5.11 Resource Resource - Search Parameters

FHIR Infrastructure icon Work Group Maturity Level : N/A   Normative (from v4.0.0) Security Category : N/A Compartments : No defined compartments

Search parameters for the Resource Resource - 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/Resource-content

2.1.27.5.13 Generated Narrative: SearchParameter Resource-content

2.1.27.5.12 _content TU

Parameter _content : special

Search on the entire content of the resource

Resource Resource
Expression (none)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-filter

2.1.27.5.14 Generated Narrative: SearchParameter Resource-filter

2.1.27.5.13 _filter TU

Parameter _filter : special

Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details

Resource Resource
Expression (none)
Processing Mode Other
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-has

2.1.27.5.15 Generated Narrative: SearchParameter Resource-has

2.1.27.5.14 _has TU

Parameter _has : special

Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation

Resource Resource
Expression (none)
Processing Mode Other
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-id

2.1.27.5.16 Generated Narrative: SearchParameter Resource-id

2.1.27.5.15 _id

Parameter _id : token

Logical id of this artifact

Resource Resource
Expression Resource.id
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-in

2.1.27.5.17 Generated Narrative: SearchParameter Resource-in

2.1.27.5.16 _in TU

Parameter _in : reference

Allows for the retrieval of resources that are active members of a CareTeam, Group, or List

Resource Resource
Expression Resource.id
Processing Mode Other
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-language

2.1.27.5.18 Generated Narrative: SearchParameter Resource-language

2.1.27.5.17 _language TU

Parameter _language : token

Language of the resource content

Resource Resource
Expression Resource.language
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-lastUpdated

2.1.27.5.19 Generated Narrative: SearchParameter Resource-lastUpdated

2.1.27.5.18 _lastUpdated

Parameter _lastUpdated : date

When the resource version last changed

Resource Resource
Expression Resource.meta.lastUpdated
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Resource-list

2.1.27.5.20 Generated Narrative: SearchParameter Resource-list

2.1.27.5.19 _list TU

Parameter _list : special

Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists

Resource Resource
Expression (none)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-profile

2.1.27.5.21 Generated Narrative: SearchParameter Resource-profile

2.1.27.5.20 _profile

Parameter _profile : reference

Profiles this resource claims to conform to

Resource Resource
Expression Resource.meta.profile
Processing Mode Normal
Target Resources StructureDefinition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-query

2.1.27.5.22 Generated Narrative: SearchParameter Resource-query

2.1.27.5.21 _query TU

Parameter _query : special

A custom search profile that describes a specific defined query operation

Resource Resource
Expression (none)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-security

2.1.27.5.23 Generated Narrative: SearchParameter Resource-security

2.1.27.5.22 _security TU

Parameter _security : token

Security Labels applied to this resource

Resource Resource
Expression Resource.meta.security
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-source

2.1.27.5.24 Generated Narrative: SearchParameter Resource-source

2.1.27.5.23 _source

Parameter _source : uri

Identifies where the resource comes from

Resource Resource
Expression Resource.meta.source
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-tag

2.1.27.5.25 Generated Narrative: SearchParameter Resource-tag

2.1.27.5.24 _tag TU

Parameter _tag : token

Tags applied to this resource

Resource Resource
Expression Resource.meta.tag
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-text

2.1.27.5.26 Generated Narrative: SearchParameter Resource-text

2.1.27.5.25 _text TU

Parameter _text : string

Text search against the narrative

Resource Resource
Expression (none)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Resource-type

2.1.27.5.27 Generated Narrative: SearchParameter Resource-type

2.1.27.5.26 _type TU

Parameter _type : special

A resource type filter

Resource Resource
Expression (none)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true