R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

FHIR Infrastructure icon Work GroupMaturity 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

Parameter context:token

A use context assigned to the {{title}}

Resources
Expression({{name}}.useContext.value.ofType(CodeableConcept))
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

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 ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter context-reference:reference

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

Resources
Expression{{name}}.useContext.value
Processing ModeNormal
Target ResourcesHealthcareService, InsurancePlan, Organization, PlanDefinition, ResearchStudy, Group, Location
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter context-type:token

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

Resources
Expression{{name}}.useContext.code
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter context-type-quantity:composite

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

Resources
Expression{{name}}.useContext
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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-typecode
context-quantityvalue.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/build/SearchParameter/CanonicalResource-context-type-value

Parameter context-type-value:composite

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

Resources
Expression{{name}}.useContext
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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-typecode
contextvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/build/SearchParameter/CanonicalResource-date

Parameter date:date

The {{title}} publication date

Resources
Expression{{name}}.date
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter description:string

The description of the {{title}}

Resources
Expression{{name}}.description
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter identifier:token

External identifier for the {{title}}

Resources
Expression{{name}}.identifier
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter jurisdiction:token

Intended jurisdiction for the {{title}}

Resources
Expression{{name}}.jurisdiction
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter name:string

Computationally friendly name of the {{title}}

Resources
Expression{{name}}.name
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter publisher:string

Name of the publisher of the {{title}}

Resources
Expression{{name}}.publisher
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter status:token

The current status of the {{title}}

Resources
Expression{{name}}.status
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter title:string

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

Resources
Expression{{name}}.title
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter url:uri

The uri that identifies the {{title}}

Resources
Expression{{name}}.url
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Parameter version:token

The business version of the {{title}}

Resources
Expression{{name}}.version
Processing ModeNormal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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