Athena Core Implementation Guide
2.33.0 - release

Athena Core Implementation Guide - Local Development build (v2.33.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: athenahealth Search Parameter Metadata

Official URL: https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata Version: 2.33.0
Active as of 2024-04-12 Computable Name: AthenahealthSearchParameterMetadata

This extension contains metadata regarding a resource’s collection of supported search parameters.

Context of Use

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

  • Element ID CapabilityStatement.rest
  • 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

Complex Extension: This extension contains metadata regarding a resource's collection of supported search parameters.

  • requiredSearchParams: string: Collection of 'always required' (REQUIRED) SearchParameters
  • requiredAnySearchParams: string: Collection of 'required any' (CONDITIONAL REQUIRED) SearchParameters

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Search Parameter Metadata
... extension:requiredSearchParams 0..*ExtensionCollection of 'always required' (REQUIRED) SearchParameters
.... extension 0..0
.... url 1..1uri"requiredSearchParams"
.... value[x] 1..1stringSearchParameter.code value for an 'always required' (REQUIRED) SearchParameter
... extension:requiredAnySearchParams 0..*ExtensionCollection of 'required any' (CONDITIONAL REQUIRED) SearchParameters
.... extension 0..0
.... url 1..1uri"requiredAnySearchParams"
.... value[x] 1..1stringSearchParameter.code value for a 'required any' (CONDITIONAL REQUIRED) SearchParameter
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Search Parameter Metadata
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:requiredSearchParams 0..*ExtensionCollection of 'always required' (REQUIRED) SearchParameters
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"requiredSearchParams"
.... value[x] 1..1stringSearchParameter.code value for an 'always required' (REQUIRED) SearchParameter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"requiredAnySearchParams"
.... value[x] 1..1stringSearchParameter.code value for a 'required any' (CONDITIONAL REQUIRED) SearchParameter
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension contains metadata regarding a resource's collection of supported search parameters.

  • requiredSearchParams: string: Collection of 'always required' (REQUIRED) SearchParameters
  • requiredAnySearchParams: string: Collection of 'required any' (CONDITIONAL REQUIRED) SearchParameters

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Search Parameter Metadata
... extension:requiredSearchParams 0..*ExtensionCollection of 'always required' (REQUIRED) SearchParameters
.... extension 0..0
.... url 1..1uri"requiredSearchParams"
.... value[x] 1..1stringSearchParameter.code value for an 'always required' (REQUIRED) SearchParameter
... extension:requiredAnySearchParams 0..*ExtensionCollection of 'required any' (CONDITIONAL REQUIRED) SearchParameters
.... extension 0..0
.... url 1..1uri"requiredAnySearchParams"
.... value[x] 1..1stringSearchParameter.code value for a 'required any' (CONDITIONAL REQUIRED) SearchParameter
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Search Parameter Metadata
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:requiredSearchParams 0..*ExtensionCollection of 'always required' (REQUIRED) SearchParameters
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"requiredSearchParams"
.... value[x] 1..1stringSearchParameter.code value for an 'always required' (REQUIRED) SearchParameter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"requiredAnySearchParams"
.... value[x] 1..1stringSearchParameter.code value for a 'required any' (CONDITIONAL REQUIRED) SearchParameter
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata"

doco Documentation for this format

 

​Other representations of profile: CSV, Excel, Schematron