Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st 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.7.12 Resource CanonicalResource - Search Parameters

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

Search parameters for the Resource CanonicalResource - 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/build/SearchParameter/CanonicalResource-context

2.1.27.7.13 context TU

Parameter context : token

A use context assigned to the {{title}}

Resources
Expression ({{name}}.useContext.value.ofType(CodeableConcept))
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/build/SearchParameter/CanonicalResource-context-quantity

2.1.27.7.14 context-quantity TU

Parameter context-quantity : quantity

A quantity- or range-valued use context assigned to the {{title}}

Resources
Expression ({{name}}.useContext.value.ofType(Quantity)) | ({{name}}.useContext.value.ofType(Range))
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/build/SearchParameter/CanonicalResource-context-reference

2.1.27.7.15 context-reference

Parameter context-reference : reference

A use context reference assigned to the {{title}}

Resources
Expression {{name}}.useContext.value
Processing Mode Normal
Target Resources HealthcareService , InsurancePlan , Organization , PlanDefinition , ResearchStudy , Group , Location
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/build/SearchParameter/CanonicalResource-context-type

2.1.27.7.16 context-type TU

Parameter context-type : token

A type of use context assigned to the {{title}}

Resources
Expression {{name}}.useContext.code
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/build/SearchParameter/CanonicalResource-context-type-quantity

2.1.27.7.17 context-type-quantity TU

Parameter context-type-quantity : composite

A use context type and quantity- or range-based value assigned to the {{title}}

Resources
Expression {{name}}.useContext
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

Components

context-type code
context-quantity value.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/build/SearchParameter/CanonicalResource-context-type-value

2.1.27.7.18 context-type-value TU

Parameter context-type-value : composite

A use context type and value assigned to the {{title}}

Resources
Expression {{name}}.useContext
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

Components

context-type code
context value.ofType(CodeableConcept)
 
http://hl7.org/fhir/build/SearchParameter/CanonicalResource-date

2.1.27.7.19 date

Parameter date : date

The {{title}} publication date

Resources
Expression {{name}}.date
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/build/SearchParameter/CanonicalResource-description

2.1.27.7.20 description

Parameter description : string

The description of the {{title}}

Resources
Expression {{name}}.description
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/build/SearchParameter/CanonicalResource-identifier

2.1.27.7.21 identifier TU

Parameter identifier : token

External identifier for the {{title}}

Resources
Expression {{name}}.identifier
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/build/SearchParameter/CanonicalResource-jurisdiction

2.1.27.7.22 jurisdiction TU

Parameter jurisdiction : token

Intended jurisdiction for the {{title}}

Resources
Expression {{name}}.jurisdiction
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/build/SearchParameter/CanonicalResource-name

2.1.27.7.23 name

Parameter name : string

Computationally friendly name of the {{title}}

Resources
Expression {{name}}.name
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/build/SearchParameter/CanonicalResource-publisher

2.1.27.7.24 publisher

Parameter publisher : string

Name of the publisher of the {{title}}

Resources
Expression {{name}}.publisher
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/build/SearchParameter/CanonicalResource-status

2.1.27.7.25 status

Parameter status : token

The current status of the {{title}}

Resources
Expression {{name}}.status
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/build/SearchParameter/CanonicalResource-title

2.1.27.7.26 title

Parameter title : string

The human-friendly name of the {{title}}

Resources
Expression {{name}}.title
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/build/SearchParameter/CanonicalResource-url

2.1.27.7.27 url

Parameter url : uri

The uri that identifies the {{title}}

Resources
Expression {{name}}.url
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/build/SearchParameter/CanonicalResource-version

2.1.27.7.28 version

Parameter version : token

The business version of the {{title}}

Resources
Expression {{name}}.version
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