Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_SearchParameter_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-SearchParameter Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_SearchParameter_R4

This cross-version profile allows R5 SearchParameter content to be represented via FHIR R4 SearchParameter resources.

Usages:

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

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(4.0.1) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:identifier 0..* Identifier R5: Additional identifier for the search parameter (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:title 0..1 string R5: Name for this search parameter (human friendly) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Constraints: ext-1
.... extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:constraint 0..1 string R5: FHIRPath expression that constraints the usage of this SearchParamete (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.constraint
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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.
... description Σ 1..1 markdown Natural language description of the search parameter
... code Σ 1..1 code Code used in URL
... 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 tx.fhir.org
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 SearchParameter.implicitRules, SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.name, SearchParameter.status, SearchParameter.description, SearchParameter.code, SearchParameter.base, SearchParameter.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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(4.0.1) Search parameter for a resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the search parameter (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:title 0..1 string R5: Name for this search parameter (human friendly) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:constraint 0..1 string R5: FHIRPath expression that constraints the usage of this SearchParamete (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.constraint
... xpathUsage
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:processingMode 0..1 code R5: normal | phonetic | other additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.processingMode
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its expression query.
... modifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modifier 0..* code R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.modifier
Binding: R5SearchModifierCodeForR4 (0.1.0) (required): A supported modifier for a search parameter.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(4.0.1) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:identifier 0..* Identifier R5: Additional identifier for the search parameter (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:title 0..1 string R5: Name for this search parameter (human friendly) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Constraints: ext-1
.... extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:constraint 0..1 string R5: FHIRPath expression that constraints the usage of this SearchParamete (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.constraint
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ 0..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 Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* 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 Σ 1..1 code Code used in URL
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:processingMode 0..1 code R5: normal | phonetic | other additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.processingMode
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its expression query.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:modifier 0..* code R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.modifier
Binding: R5SearchModifierCodeForR4 (0.1.0) (required): A supported modifier for a search parameter.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 tx.fhir.org
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 tx.fhir.org
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 tx.fhir.org
SearchParameter.comparator Base required SearchComparator 📍4.0.1 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode . 📍4.0.1 tx.fhir.org

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 SearchParameter.meta, SearchParameter.implicitRules, SearchParameter.language, SearchParameter.text, SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.version, SearchParameter.name, SearchParameter.derivedFrom, SearchParameter.status, SearchParameter.experimental, SearchParameter.date, SearchParameter.publisher, SearchParameter.contact, SearchParameter.description, SearchParameter.useContext, SearchParameter.jurisdiction, SearchParameter.purpose, SearchParameter.code, SearchParameter.base, SearchParameter.type, SearchParameter.expression, SearchParameter.xpath, SearchParameter.xpathUsage, SearchParameter.xpathUsage.extension, SearchParameter.xpathUsage.extension:processingMode, SearchParameter.target, SearchParameter.multipleOr, SearchParameter.multipleAnd, SearchParameter.comparator, SearchParameter.modifier, SearchParameter.modifier.extension, SearchParameter.modifier.extension:modifier, SearchParameter.chain, SearchParameter.component, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition, SearchParameter.component.expression All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension, SearchParameter.xpathUsage.extension, SearchParameter.xpathUsage.extension:processingMode, SearchParameter.modifier.extension, SearchParameter.modifier.extension:modifier, SearchParameter.component.extension, SearchParameter.component.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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'

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(4.0.1) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:identifier 0..* Identifier R5: Additional identifier for the search parameter (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:title 0..1 string R5: Name for this search parameter (human friendly) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Constraints: ext-1
.... extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:constraint 0..1 string R5: FHIRPath expression that constraints the usage of this SearchParamete (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.constraint
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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.
... description Σ 1..1 markdown Natural language description of the search parameter
... code Σ 1..1 code Code used in URL
... 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 tx.fhir.org
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 SearchParameter.implicitRules, SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.name, SearchParameter.status, SearchParameter.description, SearchParameter.code, SearchParameter.base, SearchParameter.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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(4.0.1) Search parameter for a resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* Identifier R5: Additional identifier for the search parameter (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:title 0..1 string R5: Name for this search parameter (human friendly) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:constraint 0..1 string R5: FHIRPath expression that constraints the usage of this SearchParamete (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.constraint
... xpathUsage
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:processingMode 0..1 code R5: normal | phonetic | other additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.processingMode
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its expression query.
... modifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modifier 0..* code R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.modifier
Binding: R5SearchModifierCodeForR4 (0.1.0) (required): A supported modifier for a search parameter.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(4.0.1) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:identifier 0..* Identifier R5: Additional identifier for the search parameter (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:title 0..1 string R5: Name for this search parameter (human friendly) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Constraints: ext-1
.... extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:constraint 0..1 string R5: FHIRPath expression that constraints the usage of this SearchParamete (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.constraint
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ 0..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 Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* 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 Σ 1..1 code Code used in URL
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:processingMode 0..1 code R5: normal | phonetic | other additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.processingMode
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its expression query.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:modifier 0..* code R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.modifier
Binding: R5SearchModifierCodeForR4 (0.1.0) (required): A supported modifier for a search parameter.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 tx.fhir.org
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 tx.fhir.org
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 tx.fhir.org
SearchParameter.comparator Base required SearchComparator 📍4.0.1 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode . 📍4.0.1 tx.fhir.org

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 SearchParameter.meta, SearchParameter.implicitRules, SearchParameter.language, SearchParameter.text, SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.version, SearchParameter.name, SearchParameter.derivedFrom, SearchParameter.status, SearchParameter.experimental, SearchParameter.date, SearchParameter.publisher, SearchParameter.contact, SearchParameter.description, SearchParameter.useContext, SearchParameter.jurisdiction, SearchParameter.purpose, SearchParameter.code, SearchParameter.base, SearchParameter.type, SearchParameter.expression, SearchParameter.xpath, SearchParameter.xpathUsage, SearchParameter.xpathUsage.extension, SearchParameter.xpathUsage.extension:processingMode, SearchParameter.target, SearchParameter.multipleOr, SearchParameter.multipleAnd, SearchParameter.comparator, SearchParameter.modifier, SearchParameter.modifier.extension, SearchParameter.modifier.extension:modifier, SearchParameter.chain, SearchParameter.component, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition, SearchParameter.component.expression All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.extension, SearchParameter.extension:identifier, SearchParameter.extension:versionAlgorithm, SearchParameter.extension:title, SearchParameter.extension:copyright, SearchParameter.extension:copyrightLabel, SearchParameter.extension:constraint, SearchParameter.modifierExtension, SearchParameter.xpathUsage.extension, SearchParameter.xpathUsage.extension:processingMode, SearchParameter.modifier.extension, SearchParameter.modifier.extension:modifier, SearchParameter.component.extension, SearchParameter.component.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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'

 

Other representations of profile: CSV, Excel, Schematron