FHIR General Extensions IG
0.1.0 - Working Copy International flag

This page is part of the FHIR Core Extensions Registry (v0.1.0: Releases Draft) based on FHIR v5.0.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: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: CSSearchParameterUse
Other Identifiers: id: urn: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

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

Mandatory: 6 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionSearch context a search parameter allowed to be used
... extension:required 1..1ExtensionIf this search parameter can use used in standalone search.
.... extension 0..0
.... url 1..1uri"allow-standalone"
.... value[x] 1..1booleanValue of extension
... extension:allow-include 1..1ExtensionIf this search parameter can use used in _include search.
.... extension 0..0
.... url 1..1uri"allow-include"
.... value[x] 1..1booleanValue of extension
... extension:allow-revinclude 1..1ExtensionIf this search parameter can use used in _revinclude search.
.... extension 0..0
.... url 1..1uri"allow-revinclude"
.... value[x] 1..1booleanValue of extension
... value[x] 0..0

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

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 6 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionSearch context a search parameter allowed to be used
... extension:required 1..1ExtensionIf this search parameter can use used in standalone search.
.... extension 0..0
.... url 1..1uri"allow-standalone"
.... value[x] 1..1booleanValue of extension
... extension:allow-include 1..1ExtensionIf this search parameter can use used in _include search.
.... extension 0..0
.... url 1..1uri"allow-include"
.... value[x] 1..1booleanValue of extension
... extension:allow-revinclude 1..1ExtensionIf this search parameter can use used in _revinclude search.
.... extension 0..0
.... url 1..1uri"allow-revinclude"
.... value[x] 1..1booleanValue of extension
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionSearch context a search parameter allowed to be used
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:required 1..1ExtensionIf this search parameter can use used in standalone search.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-standalone"
.... value[x] 1..1booleanValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-include"
.... value[x] 1..1booleanValue of extension
... extension:allow-revinclude 1..1ExtensionIf this search parameter can use used in _revinclude search.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-revinclude"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"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)

;