Smart Bear Implementation Guide
3.2.2 - ci-build

Smart Bear Implementation Guide - Local Development build (v3.2.2). See the Directory of published versions

Resource Profile: SearchParameter Ecounter

Official URL: https://smart-bear.eu/fhir/StructureDefinition/SearchParameterEcounter Version: 3.2.2
Active as of 2022-07-03 Computable Name: SearchParameterEcounter

SearchParameter for Family Member History by Encounter

Usage:

Formal Views of Profile Content

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

This structure is derived from SearchParameter

Summary

Must-Support: 1 element

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraintsdoco
.. SearchParameter 0..*SearchParameterSearch parameter for a resource
... url 1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter
... description S1..1markdownNatural language description of the search parameter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SearchParameter I0..*SearchParameterSearch parameter for a resource
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter
... version Σ0..1stringBusiness version of the search parameter
... name ΣI1..1stringName for this search parameter (computer friendly)
... derivedFrom 0..1canonical(SearchParameter)Original definition for the search parameter
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the search parameter
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this search parameter is defined
... code Σ1..1codeCode used in URL
... base Σ1..*codeThe resource type(s) this search parameter applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... type Σ1..1codenumber | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.

... expression I0..1stringFHIRPath expression that extracts the values
... xpath I0..1stringXPath that extracts the values
... xpathUsage I0..1codenormal | phonetic | nearby | distance | other
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.

... target 0..*codeTypes of resource (if a resource reference)
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... multipleOr 0..1booleanAllow multiple values per parameter (or)
... multipleAnd 0..1booleanAllow multiple parameters (and)
... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.


... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
Binding: SearchModifierCode (required): A supported modifier for a search parameter.


... chain 0..*stringChained names supported
... component 0..*BackboneElementFor Composite resources to define the parts
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... definition 1..1canonical(SearchParameter)Defines how the part works
.... expression 1..1stringSubexpression relative to main expression

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SearchParameter I0..*SearchParameterSearch parameter for a resource
... description Σ1..1markdownNatural language description of the search parameter

doco Documentation for this format

This structure is derived from SearchParameter

Summary

Must-Support: 1 element

Differential View

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraintsdoco
.. SearchParameter 0..*SearchParameterSearch parameter for a resource
... url 1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter
... description S1..1markdownNatural language description of the search parameter

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SearchParameter I0..*SearchParameterSearch parameter for a resource
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter
... version Σ0..1stringBusiness version of the search parameter
... name ΣI1..1stringName for this search parameter (computer friendly)
... derivedFrom 0..1canonical(SearchParameter)Original definition for the search parameter
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the search parameter
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this search parameter is defined
... code Σ1..1codeCode used in URL
... base Σ1..*codeThe resource type(s) this search parameter applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... type Σ1..1codenumber | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.

... expression I0..1stringFHIRPath expression that extracts the values
... xpath I0..1stringXPath that extracts the values
... xpathUsage I0..1codenormal | phonetic | nearby | distance | other
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.

... target 0..*codeTypes of resource (if a resource reference)
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... multipleOr 0..1booleanAllow multiple values per parameter (or)
... multipleAnd 0..1booleanAllow multiple parameters (and)
... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.


... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
Binding: SearchModifierCode (required): A supported modifier for a search parameter.


... chain 0..*stringChained names supported
... component 0..*BackboneElementFor Composite resources to define the parts
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... definition 1..1canonical(SearchParameter)Defines how the part works
.... expression 1..1stringSubexpression relative to main expression

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
SearchParameter.languagepreferredCommonLanguages
Max Binding: AllLanguages
SearchParameter.statusrequiredPublicationStatus
SearchParameter.jurisdictionextensibleJurisdiction ValueSet
SearchParameter.baserequiredResourceType
SearchParameter.typerequiredSearchParamType
SearchParameter.xpathUsagerequiredXPathUsageType
SearchParameter.targetrequiredResourceType
SearchParameter.comparatorrequiredSearchComparator
SearchParameter.modifierrequiredSearchModifierCode