MII IG Meta
2025.0.1-rc.1 - ci-build

MII IG Meta, published by Medizininformatik Initiative. This guide is not an authorized publication; it is the continuous build for version 2025.0.1-rc.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medizininformatik-initiative/kerndatensatz-meta/ and changes regularly. See the Directory of published versions

Resource Profile: MII PR Meta SearchParameter ( Experimental )

Official URL: https://www.medizininformatik-initiative.de/fhir/modul-meta/StructureDefinition/mii-pr-meta-searchparameter Version: 2025.0.1-rc.1
Active as of 2024-07-01 Computable Name: MII_PR_Meta_SearchParameter

Das Profil legt die Mindestanforderungen fest, die SearchParameter-Ressourcen im Kerndatensatz erfüllen müssen.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher (organization or individual)
... contact Σ 1..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the search parameter
... code ΣC 1..1 code Code used in URL
Constraints: search-param-code-regex
... base Σ 1..* code The 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..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
search-param-code-regex error SearchParameter.code In SearchParameter.code DÜRFEN NICHT folgende Zeichen enthalten sein: Leerzeichen, `.`, `$`, `|`. matches('[^\\s.$|]+')
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter 0..* SearchParameter Search parameter for a resource
... version 1..1 string Business version of the search parameter
... experimental 1..1 boolean For testing purposes, not real usage
... date 1..1 dateTime Date last changed
... contact 1..* ContactDetail Contact details for the publisher
... code C 1..1 code Code used in URL
Constraints: search-param-code-regex

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
search-param-code-regex error SearchParameter.code In SearchParameter.code DÜRFEN NICHT folgende Zeichen enthalten sein: Leerzeichen, `.`, `$`, `|`. matches('[^\\s.$|]+')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ 1..1 string Business version of the search parameter
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... derivedFrom 0..1 canonical(SearchParameter) Original definition for the search parameter
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher (organization or individual)
... contact Σ 1..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the search parameter
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this search parameter is defined
... code ΣC 1..1 code Code used in URL
Constraints: search-param-code-regex
... base Σ 1..* code The 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..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... expression C 0..1 string FHIRPath expression that extracts the values
... xpath C 0..1 string XPath that extracts the values
... xpathUsage C 0..1 code normal | 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..* code Types of resource (if a resource reference)
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.
... modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... chain 0..* string Chained names supported
... component 0..* BackboneElement For Composite resources to define the parts
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... definition 1..1 canonical(SearchParameter) Defines how the part works
.... expression 1..1 string Subexpression relative to main expression

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍4.0.1 FHIR Std.
SearchParameter.target Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.comparator Base required SearchComparator 📍4.0.1 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
search-param-code-regex error SearchParameter.code In SearchParameter.code DÜRFEN NICHT folgende Zeichen enthalten sein: Leerzeichen, `.`, `$`, `|`. matches('[^\\s.$|]+')
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'

This structure is derived from SearchParameter

Summary

Mandatory: 5 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher (organization or individual)
... contact Σ 1..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the search parameter
... code ΣC 1..1 code Code used in URL
Constraints: search-param-code-regex
... base Σ 1..* code The 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..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
search-param-code-regex error SearchParameter.code In SearchParameter.code DÜRFEN NICHT folgende Zeichen enthalten sein: Leerzeichen, `.`, `$`, `|`. matches('[^\\s.$|]+')
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'

Differential View

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter 0..* SearchParameter Search parameter for a resource
... version 1..1 string Business version of the search parameter
... experimental 1..1 boolean For testing purposes, not real usage
... date 1..1 dateTime Date last changed
... contact 1..* ContactDetail Contact details for the publisher
... code C 1..1 code Code used in URL
Constraints: search-param-code-regex

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
search-param-code-regex error SearchParameter.code In SearchParameter.code DÜRFEN NICHT folgende Zeichen enthalten sein: Leerzeichen, `.`, `$`, `|`. matches('[^\\s.$|]+')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ 1..1 string Business version of the search parameter
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... derivedFrom 0..1 canonical(SearchParameter) Original definition for the search parameter
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher (organization or individual)
... contact Σ 1..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the search parameter
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this search parameter is defined
... code ΣC 1..1 code Code used in URL
Constraints: search-param-code-regex
... base Σ 1..* code The 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..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... expression C 0..1 string FHIRPath expression that extracts the values
... xpath C 0..1 string XPath that extracts the values
... xpathUsage C 0..1 code normal | 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..* code Types of resource (if a resource reference)
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.
... modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... chain 0..* string Chained names supported
... component 0..* BackboneElement For Composite resources to define the parts
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... definition 1..1 canonical(SearchParameter) Defines how the part works
.... expression 1..1 string Subexpression relative to main expression

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍4.0.1 FHIR Std.
SearchParameter.target Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.comparator Base required SearchComparator 📍4.0.1 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
search-param-code-regex error SearchParameter.code In SearchParameter.code DÜRFEN NICHT folgende Zeichen enthalten sein: Leerzeichen, `.`, `$`, `|`. matches('[^\\s.$|]+')
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'

This structure is derived from SearchParameter

Summary

Mandatory: 5 elements

 

Other representations of profile: CSV, Excel, Schematron