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

5.4.16 5.4.15 Resource StructureDefinition - Search Parameters

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

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

5.4.17 Generated Narrative: SearchParameter StructureDefinition-abstract

5.4.16 abstract

Parameter abstract : token

Whether the structure is abstract

Resource StructureDefinition
Expression StructureDefinition.abstract
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/StructureDefinition-base

5.4.18 Generated Narrative: SearchParameter StructureDefinition-base

5.4.17 base

Parameter base : reference

Definition that this type is constrained/specialized from

Resource StructureDefinition
Expression StructureDefinition.baseDefinition
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/StructureDefinition-base-path

5.4.19 Generated Narrative: SearchParameter StructureDefinition-base-path

5.4.18 base-path

Parameter base-path : token

Path that identifies the base element

Resource StructureDefinition
Expression StructureDefinition.snapshot.element.base.path | StructureDefinition.differential.element.base.path
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/CanonicalResource-context
This search parameter is part of the common search parameter CanonicalResource-context

5.4.20 Generated Narrative: SearchParameter CanonicalResource-context

5.4.19 context TU

Parameter context : token

StructureDefinition : A use context assigned to the structure definition

Resource StructureDefinition
Expression (StructureDefinition.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/SearchParameter/CanonicalResource-context-quantity
This search parameter is part of the common search parameter CanonicalResource-context-quantity

5.4.21 Generated Narrative: SearchParameter CanonicalResource-context-quantity

5.4.20 context-quantity TU

Parameter context-quantity : quantity

StructureDefinition : A quantity- or range-valued use context assigned to the structure definition

Resource StructureDefinition
Expression (StructureDefinition.useContext.value.ofType(Quantity)) | (StructureDefinition.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
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type
This search parameter is part of the common search parameter CanonicalResource-context-type

5.4.22 Generated Narrative: SearchParameter CanonicalResource-context-type

5.4.21 context-type TU

Parameter context-type : token

StructureDefinition : A type of use context assigned to the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/CanonicalResource-context-type-quantity
This search parameter is part of the common search parameter CanonicalResource-context-type-quantity

5.4.23 Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

5.4.22 context-type-quantity TU

Parameter context-type-quantity : composite

StructureDefinition : A use context type and quantity- or range-based value assigned to the structure definition

Resource StructureDefinition
Expression StructureDefinition.useContext
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

context-type code
context-quantity value.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-value
This search parameter is part of the common search parameter CanonicalResource-context-type-value

5.4.24 Generated Narrative: SearchParameter CanonicalResource-context-type-value

5.4.23 context-type-value TU

Parameter context-type-value : composite

StructureDefinition : A use context type and value assigned to the structure definition

Resource StructureDefinition
Expression StructureDefinition.useContext
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

context-type code
context value.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-date
This search parameter is part of the common search parameter CanonicalResource-date

5.4.25 Generated Narrative: SearchParameter CanonicalResource-date

5.4.24 date TU

Parameter date : date

StructureDefinition : The structure definition publication date

Resource StructureDefinition
Expression StructureDefinition.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
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/StructureDefinition-derivation

5.4.26 Generated Narrative: SearchParameter StructureDefinition-derivation

5.4.25 derivation

Parameter derivation : token

specialization | constraint - How relates to base definition

Resource StructureDefinition
Expression StructureDefinition.derivation
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/CanonicalResource-description
This search parameter is part of the common search parameter CanonicalResource-description

5.4.27 Generated Narrative: SearchParameter CanonicalResource-description

5.4.26 description TU

Parameter description : string

StructureDefinition : The description of the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/StructureDefinition-experimental

5.4.28 Generated Narrative: SearchParameter StructureDefinition-experimental

5.4.27 experimental

Parameter experimental : token

For testing purposes, not real usage

Resource StructureDefinition
Expression StructureDefinition.experimental
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/StructureDefinition-ext-context

5.4.29 Generated Narrative: SearchParameter StructureDefinition-ext-context

5.4.28 ext-context

Parameter ext-context : composite

An extension context assigned to the structure definition

Resource StructureDefinition
Expression StructureDefinition.context
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

ext-context-type type
ext-context-expression expression
 
http://hl7.org/fhir/SearchParameter/StructureDefinition-ext-context-expression

5.4.30 Generated Narrative: SearchParameter StructureDefinition-ext-context-expression

5.4.29 ext-context-expression

Parameter ext-context-expression : token

An expression of extension context assigned to the structure definition

Resource StructureDefinition
Expression StructureDefinition.context.expression
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/StructureDefinition-ext-context-type

5.4.31 Generated Narrative: SearchParameter StructureDefinition-ext-context-type

5.4.30 ext-context-type

Parameter ext-context-type : token

A type of extension context assigned to the structure definition

Resource StructureDefinition
Expression StructureDefinition.context.type
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/CanonicalResource-identifier
This search parameter is part of the common search parameter CanonicalResource-identifier

5.4.32 Generated Narrative: SearchParameter CanonicalResource-identifier

5.4.31 identifier TU

Parameter identifier : token

StructureDefinition : External identifier for the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/CanonicalResource-jurisdiction
This search parameter is part of the common search parameter CanonicalResource-jurisdiction

5.4.33 Generated Narrative: SearchParameter CanonicalResource-jurisdiction

5.4.32 jurisdiction TU

Parameter jurisdiction : token

StructureDefinition : Intended jurisdiction for the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/StructureDefinition-keyword

5.4.34 Generated Narrative: SearchParameter StructureDefinition-keyword

5.4.33 keyword XD

Parameter keyword : token

A code for the StructureDefinition

Resource StructureDefinition
Expression StructureDefinition.keyword
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/StructureDefinition-kind

5.4.35 Generated Narrative: SearchParameter StructureDefinition-kind

5.4.34 kind

Parameter kind : token

primitive-type | complex-type | resource | logical

Resource StructureDefinition
Expression StructureDefinition.kind
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/CanonicalResource-name
This search parameter is part of the common search parameter CanonicalResource-name

5.4.36 Generated Narrative: SearchParameter CanonicalResource-name

5.4.35 name TU

Parameter name : string

StructureDefinition : Computationally friendly name of the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/StructureDefinition-path

5.4.37 Generated Narrative: SearchParameter StructureDefinition-path

5.4.36 path

Parameter path : token

A path that is constrained in the StructureDefinition

Resource StructureDefinition
Expression StructureDefinition.snapshot.element.path | StructureDefinition.differential.element.path
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/CanonicalResource-publisher
This search parameter is part of the common search parameter CanonicalResource-publisher

5.4.38 Generated Narrative: SearchParameter CanonicalResource-publisher

5.4.37 publisher TU

Parameter publisher : string

StructureDefinition : Name of the publisher of the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/CanonicalResource-status
This search parameter is part of the common search parameter CanonicalResource-status

5.4.39 Generated Narrative: SearchParameter CanonicalResource-status

5.4.38 status TU

Parameter status : token

StructureDefinition : The current status of the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/CanonicalResource-title
This search parameter is part of the common search parameter CanonicalResource-title

5.4.40 Generated Narrative: SearchParameter CanonicalResource-title

5.4.39 title TU

Parameter title : string

StructureDefinition : The human-friendly name of the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/StructureDefinition-type

5.4.41 Generated Narrative: SearchParameter StructureDefinition-type

5.4.40 type

Parameter type : uri

Type defined or constrained by this structure

Resource StructureDefinition
Expression StructureDefinition.type
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/CanonicalResource-url
This search parameter is part of the common search parameter CanonicalResource-url

5.4.42 Generated Narrative: SearchParameter CanonicalResource-url

5.4.41 url TU

Parameter url : uri

StructureDefinition : The uri that identifies the structure definition

Resource StructureDefinition
Expression StructureDefinition.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/SearchParameter/StructureDefinition-valueset

5.4.43 Generated Narrative: SearchParameter StructureDefinition-valueset

5.4.42 valueset

Parameter valueset : reference

A vocabulary binding reference

Resource StructureDefinition
Expression StructureDefinition.snapshot.element.binding.valueSet
Processing Mode Normal
Target Resources ValueSet
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/CanonicalResource-version
This search parameter is part of the common search parameter CanonicalResource-version

5.4.44 Generated Narrative: SearchParameter CanonicalResource-version

5.4.43 version TU

Parameter version : token

StructureDefinition : The business version of the structure definition

Resource StructureDefinition
Expression StructureDefinition.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