Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

5.3.15 5.3.14 Resource CapabilityStatement - Search Parameters

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

Search parameters for the Resource CapabilityStatement - 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/CanonicalResource-context
This search parameter is part of the common search parameter CanonicalResource-context

5.3.16 Generated Narrative: SearchParameter CanonicalResource-context

5.3.15 context TU

Parameter context : token

CapabilityStatement : A use context assigned to the capability statement

Resource CapabilityStatement
Expression (CapabilityStatement.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.3.17 Generated Narrative: SearchParameter CanonicalResource-context-quantity

5.3.16 context-quantity TU

Parameter context-quantity : quantity

CapabilityStatement : A quantity- or range-valued use context assigned to the capability statement

Resource CapabilityStatement
Expression (CapabilityStatement.useContext.value.ofType(Quantity)) | (CapabilityStatement.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.3.18 Generated Narrative: SearchParameter CanonicalResource-context-type

5.3.17 context-type TU

Parameter context-type : token

CapabilityStatement : A type of use context assigned to the capability statement

Resource CapabilityStatement
Expression CapabilityStatement.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.3.19 Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

5.3.18 context-type-quantity TU

Parameter context-type-quantity : composite

CapabilityStatement : A use context type and quantity- or range-based value assigned to the capability statement

Resource CapabilityStatement
Expression CapabilityStatement.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.3.20 Generated Narrative: SearchParameter CanonicalResource-context-type-value

5.3.19 context-type-value TU

Parameter context-type-value : composite

CapabilityStatement : A use context type and value assigned to the capability statement

Resource CapabilityStatement
Expression CapabilityStatement.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.3.21 Generated Narrative: SearchParameter CanonicalResource-date

5.3.20 date TU

Parameter date : date

CapabilityStatement : The capability statement publication date

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

5.3.22 Generated Narrative: SearchParameter CanonicalResource-description

5.3.21 description TU

Parameter description : string

CapabilityStatement : The description of the capability statement

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

Generated Narrative: SearchParameter CapabilityStatement-experimental

5.3.22 experimental

Parameter experimental : token

Whether the CapabilityStatement is experimental

Resource CapabilityStatement
Expression CapabilityStatement.experimental
Processing Mode Normal
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/CapabilityStatement-fhirversion

Generated Narrative: SearchParameter CapabilityStatement-fhirversion

5.3.23 fhirversion

Parameter fhirversion : token

The version of FHIR

Resource CapabilityStatement
Expression CapabilityStatement.fhirVersion
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/CapabilityStatement-format

Generated Narrative: SearchParameter CapabilityStatement-format

5.3.24 format

Parameter format : token

formats supported (xml | json | ttl | mime type)

Resource CapabilityStatement
Expression CapabilityStatement.format
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/CapabilityStatement-guide

Generated Narrative: SearchParameter CapabilityStatement-guide

5.3.25 guide

Parameter guide : reference

Implementation guides supported

Resource CapabilityStatement
Expression CapabilityStatement.implementationGuide
Processing Mode Normal
Target Resources ImplementationGuide
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

Generated Narrative: SearchParameter CanonicalResource-identifier

5.3.26 identifier TU

Parameter identifier : token

CapabilityStatement : External identifier for the capability statement

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

Generated Narrative: SearchParameter CanonicalResource-jurisdiction

5.3.27 jurisdiction TU

Parameter jurisdiction : token

CapabilityStatement : Intended jurisdiction for Jurisdiction of the authority that maintains the the capability statement

Resource CapabilityStatement
Expression CapabilityStatement.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/CapabilityStatement-mode

Generated Narrative: SearchParameter CapabilityStatement-mode

5.3.28 mode

Parameter mode : token

Mode - restful (server/client) or messaging (sender/receiver)

Resource CapabilityStatement
Expression CapabilityStatement.rest.mode
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

Generated Narrative: SearchParameter CanonicalResource-name

5.3.29 name TU

Parameter name : string

CapabilityStatement : Computationally friendly name of the capability statement

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

Generated Narrative: SearchParameter CanonicalResource-publisher

5.3.30 publisher TU

Parameter publisher : string

CapabilityStatement : Name of the publisher of the capability statement

Resource CapabilityStatement
Expression CapabilityStatement.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/CapabilityStatement-resource

Generated Narrative: SearchParameter CapabilityStatement-resource

5.3.31 resource

Parameter resource : token uri

Name of a resource mentioned in a capability statement

Resource CapabilityStatement
Expression CapabilityStatement.rest.resource.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/CapabilityStatement-resource-profile

Generated Narrative: SearchParameter CapabilityStatement-resource-profile

5.3.32 resource-profile

Parameter resource-profile : reference

A profile id invoked in a capability statement

Resource CapabilityStatement
Expression CapabilityStatement.rest.resource.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/CapabilityStatement-security-service

Generated Narrative: SearchParameter CapabilityStatement-security-service

5.3.33 security-service TU

Parameter security-service : token

OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates

Resource CapabilityStatement
Expression CapabilityStatement.rest.security.service
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/CapabilityStatement-software

Generated Narrative: SearchParameter CapabilityStatement-software

5.3.34 software

Parameter software : string

Part of the name of a software application

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

Generated Narrative: SearchParameter CanonicalResource-status

5.3.35 status TU

Parameter status : token

CapabilityStatement : The current status of the capability statement

Resource CapabilityStatement
Expression CapabilityStatement.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/CapabilityStatement-supported-profile

Generated Narrative: SearchParameter CapabilityStatement-supported-profile

5.3.36 supported-profile TU

Parameter supported-profile : reference

Profiles for use cases supported

Resource CapabilityStatement
Expression CapabilityStatement.rest.resource.supportedProfile
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/CanonicalResource-title
This search parameter is part of the common search parameter CanonicalResource-title

Generated Narrative: SearchParameter CanonicalResource-title

5.3.37 title TU

Parameter title : string

CapabilityStatement : The human-friendly name of the capability statement

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

Generated Narrative: SearchParameter CanonicalResource-url

5.3.38 url TU

Parameter url : uri

CapabilityStatement : The uri that identifies the capability statement

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

Generated Narrative: SearchParameter CanonicalResource-version

5.3.39 version TU

Parameter version : token

CapabilityStatement : The business version of the capability statement

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