FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

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

Parameter abstract:token

Whether the structure is abstract

ResourceStructureDefinition
ExpressionStructureDefinition.abstract
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/SearchParameter/StructureDefinition-base

Parameter base:reference

Definition that this type is constrained/specialized from

ResourceStructureDefinition
ExpressionStructureDefinition.baseDefinition
Processing ModeNormal
Target ResourcesStructureDefinition
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/SearchParameter/StructureDefinition-base-path

Parameter base-path:token

Path that identifies the base element

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

Parameter context:token

StructureDefinition: A use context assigned to the structure definition

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

Parameter context-quantity:quantity

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

ResourceStructureDefinition
Expression(StructureDefinition.useContext.value.ofType(Quantity)) | (StructureDefinition.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
ComparatorsAllowed: 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

Parameter context-type:token

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

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

Parameter context-type-quantity:composite

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

ResourceStructureDefinition
ExpressionStructureDefinition.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: The parameter may only have one value (no comma separators)

Components

context-typecode
context-quantityvalue.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

Parameter context-type-value:composite

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

ResourceStructureDefinition
ExpressionStructureDefinition.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: The parameter may only have one value (no comma separators)

Components

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

Parameter date:date

StructureDefinition: The structure definition publication date

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

Parameter derivation:token

specialization | constraint - How relates to base definition

ResourceStructureDefinition
ExpressionStructureDefinition.derivation
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/SearchParameter/CanonicalResource-description
This search parameter is part of the common search parameter CanonicalResource-description

Parameter description:string

StructureDefinition: The description of the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.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/SearchParameter/StructureDefinition-experimental

Parameter experimental:token

For testing purposes, not real usage

ResourceStructureDefinition
ExpressionStructureDefinition.experimental
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/SearchParameter/StructureDefinition-ext-context

Parameter ext-context:composite

An extension context assigned to the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.context
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: The parameter may only have one value (no comma separators)

Components

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

Parameter ext-context-expression:token

An expression of extension context assigned to the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.context.expression
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/SearchParameter/StructureDefinition-ext-context-type

Parameter ext-context-type:token

A type of extension context assigned to the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.context.type
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/SearchParameter/CanonicalResource-identifier
This search parameter is part of the common search parameter CanonicalResource-identifier

Parameter identifier:token

StructureDefinition: External identifier for the structure definition

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

Parameter jurisdiction:token

StructureDefinition: Intended jurisdiction for the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.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/SearchParameter/StructureDefinition-keyword

Parameter keyword:token

A code for the StructureDefinition

ResourceStructureDefinition
ExpressionStructureDefinition.keyword
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/SearchParameter/StructureDefinition-kind

Parameter kind:token

primitive-type | complex-type | resource | logical

ResourceStructureDefinition
ExpressionStructureDefinition.kind
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/SearchParameter/CanonicalResource-name
This search parameter is part of the common search parameter CanonicalResource-name

Parameter name:string

StructureDefinition: Computationally friendly name of the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.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/SearchParameter/StructureDefinition-path

Parameter path:token

A path that is constrained in the StructureDefinition

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

Parameter publisher:string

StructureDefinition: Name of the publisher of the structure definition

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

Parameter status:token

StructureDefinition: The current status of the structure definition

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

Parameter title:string

StructureDefinition: The human-friendly name of the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.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/SearchParameter/StructureDefinition-type

Parameter type:uri

Type defined or constrained by this structure

ResourceStructureDefinition
ExpressionStructureDefinition.type
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/SearchParameter/CanonicalResource-url
This search parameter is part of the common search parameter CanonicalResource-url

Parameter url:uri

StructureDefinition: The uri that identifies the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.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/SearchParameter/StructureDefinition-valueset

Parameter valueset:reference

A vocabulary binding reference

ResourceStructureDefinition
ExpressionStructureDefinition.snapshot.element.binding.valueSet
Processing ModeNormal
Target ResourcesValueSet
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/SearchParameter/CanonicalResource-version
This search parameter is part of the common search parameter CanonicalResource-version

Parameter version:token

StructureDefinition: The business version of the structure definition

ResourceStructureDefinition
ExpressionStructureDefinition.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