FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0-ballot: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 5.1.0. For a full list of available versions, see the Directory of published versions

Extension: CapabilityStatement Search Parameter Use

Official URL: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: CSSearchParameterUse
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1045

This extension defines if a search parameter is only allowed in certain contexts

Context of Use

This extension may be used on the following element(s):

  • Element ID CapabilityStatement.rest.resource

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: This extension defines if a search parameter is only allowed in certain contexts

    • required: boolean: Indicate is this search parameter can use used in standalone search.
    • allow-include: boolean: Indicate is this search parameter can use used in _include search.
    • allow-revinclude: boolean: Indicate is this search parameter can use used in _revinclude search.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Search context a search parameter allowed to be used
    ... Slices for extension Content/Rules for all slices
    .... extension:required 1..1 Extension If this search parameter can use used in standalone search.
    ..... extension 0..0
    ..... url 1..1 uri "allow-standalone"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-include 1..1 Extension If this search parameter can use used in _include search.
    ..... extension 0..0
    ..... url 1..1 uri "allow-include"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-revinclude 1..1 Extension If this search parameter can use used in _revinclude search.
    ..... extension 0..0
    ..... url 1..1 uri "allow-revinclude"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Search context a search parameter allowed to be used
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 3..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:required 1..1 Extension If this search parameter can use used in standalone search.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "allow-standalone"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-include 1..1 Extension If this search parameter can use used in _include search.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "allow-include"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-revinclude 1..1 Extension If this search parameter can use used in _revinclude search.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "allow-revinclude"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: This extension defines if a search parameter is only allowed in certain contexts

    • required: boolean: Indicate is this search parameter can use used in standalone search.
    • allow-include: boolean: Indicate is this search parameter can use used in _include search.
    • allow-revinclude: boolean: Indicate is this search parameter can use used in _revinclude search.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Search context a search parameter allowed to be used
    ... Slices for extension Content/Rules for all slices
    .... extension:required 1..1 Extension If this search parameter can use used in standalone search.
    ..... extension 0..0
    ..... url 1..1 uri "allow-standalone"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-include 1..1 Extension If this search parameter can use used in _include search.
    ..... extension 0..0
    ..... url 1..1 uri "allow-include"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-revinclude 1..1 Extension If this search parameter can use used in _revinclude search.
    ..... extension 0..0
    ..... url 1..1 uri "allow-revinclude"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Search context a search parameter allowed to be used
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 3..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:required 1..1 Extension If this search parameter can use used in standalone search.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "allow-standalone"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-include 1..1 Extension If this search parameter can use used in _include search.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "allow-include"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:allow-revinclude 1..1 Extension If this search parameter can use used in _revinclude search.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "allow-revinclude"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)