Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablesearchparameter | Version: 2.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIShareableSearchParameter | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.57 |
Enforces the minimum information set for the search parameter metadata required by HL7 and other organizations that share and publish search parameters
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | SearchParameter | Search parameter for a resource Constraints: spd-0, spd-1, spd-2 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) |
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the search parameter |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this search parameter (computer friendly) |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the search parameter |
![]() ![]() ![]() |
Σ | 1..1 | code | Code used in URL |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (required): Data types allowed to be used for search parameters. |
![]() |
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. |
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()
|
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | SearchParameter | Search parameter for a resource | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
![]() ![]() ![]() |
S | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) |
![]() ![]() ![]() |
S | 1..1 | string | Business version of the search parameter |
![]() ![]() ![]() |
S | 1..1 | string | Name for this search parameter (computer friendly) |
![]() ![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown |
![]() ![]() ![]() |
S | 1..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
S | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() |
S | 1..1 | markdown | Natural language description of the search parameter |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | SearchParameter | Search parameter for a resource Constraints: spd-0, spd-1, spd-2 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the search parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this search parameter (computer friendly) | ||||
![]() ![]() ![]() |
0..1 | canonical(SearchParameter) | Original definition for the search parameter | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the search parameter | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this search parameter is defined | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | Code used in URL | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (required): Data types allowed to be used for search parameters. | ||||
![]() ![]() ![]() |
C | 0..1 | string | FHIRPath expression that extracts the values | ||||
![]() ![]() ![]() |
C | 0..1 | string | XPath that extracts the values | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | boolean | Allow multiple values per parameter (or) | |||||
![]() ![]() ![]() |
0..1 | boolean | Allow multiple parameters (and) | |||||
![]() ![]() ![]() |
0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: SearchComparator (required): What Search Comparator Codes are supported in search. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | string | Chained names supported | |||||
![]() ![]() ![]() |
0..* | BackboneElement | For Composite resources to define the parts | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | canonical(SearchParameter) | Defines how the part works | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Subexpression relative to main expression | |||||
![]() |
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. |
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()
|
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
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | SearchParameter | Search parameter for a resource Constraints: spd-0, spd-1, spd-2 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) |
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the search parameter |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this search parameter (computer friendly) |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the search parameter |
![]() ![]() ![]() |
Σ | 1..1 | code | Code used in URL |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (required): Data types allowed to be used for search parameters. |
![]() |
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. |
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()
|
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | SearchParameter | Search parameter for a resource | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
![]() ![]() ![]() |
S | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) |
![]() ![]() ![]() |
S | 1..1 | string | Business version of the search parameter |
![]() ![]() ![]() |
S | 1..1 | string | Name for this search parameter (computer friendly) |
![]() ![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown |
![]() ![]() ![]() |
S | 1..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
S | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() |
S | 1..1 | markdown | Natural language description of the search parameter |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | SearchParameter | Search parameter for a resource Constraints: spd-0, spd-1, spd-2 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the search parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this search parameter (computer friendly) | ||||
![]() ![]() ![]() |
0..1 | canonical(SearchParameter) | Original definition for the search parameter | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the search parameter | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this search parameter is defined | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | Code used in URL | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (required): Data types allowed to be used for search parameters. | ||||
![]() ![]() ![]() |
C | 0..1 | string | FHIRPath expression that extracts the values | ||||
![]() ![]() ![]() |
C | 0..1 | string | XPath that extracts the values | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | boolean | Allow multiple values per parameter (or) | |||||
![]() ![]() ![]() |
0..1 | boolean | Allow multiple parameters (and) | |||||
![]() ![]() ![]() |
0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: SearchComparator (required): What Search Comparator Codes are supported in search. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | string | Chained names supported | |||||
![]() ![]() ![]() |
0..* | BackboneElement | For Composite resources to define the parts | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | canonical(SearchParameter) | Defines how the part works | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Subexpression relative to main expression | |||||
![]() |
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. |
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()
|
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
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron