Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| 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_R3 | ||
This cross-version profile allows R5 SearchParameter content to be represented via FHIR STU3 SearchParameter resources.
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:   |
|---|---|---|---|---|
  SearchParameter |
C | 1..1 | SearchParameter | Search Parameter for a resource Constraints: 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 | |
   extension:identifier |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] | R5: Additional identifier for the search parameter (business identifier) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | |
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |
| extension:title |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-title]] | R5: Name for this search parameter (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
| extension:copyright |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | 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 | |
| extension:multipleOr |
0..1 | boolean | R5: Allow multiple values per parameter (or) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleOr | |
 extension:multipleAnd |
0..1 | boolean | R5: Allow multiple parameters (and) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleAnd | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
Σ | 1..1 | uri | Logical URI to reference this search parameter (globally unique) |
| name |
Σ | 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 a Value Set or Concept Map. |
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| 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 FHIR. |
| type |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri Binding: SearchParamType (required): Data types allowed to be used for search parameters. |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:type |
0..1 | code | R5: number | date | string | token | reference | composite | quantity | uri | special URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.type Binding: SearchParamType (required): Data types allowed to be used for search parameters. | |
 description |
Σ | 1..1 | markdown | Natural language description of the search parameter |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| SearchParameter.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| SearchParameter.base | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.type | Base | required | SearchParamType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | SearchParameter | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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: |
|---|---|---|---|---|
| SearchParameter |
1..1 | SearchParameter | Search Parameter for a resource | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] | R5: Additional identifier for the search parameter (business identifier) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | |
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |
| extension:title |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-title]] | R5: Name for this search parameter (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
| extension:copyright |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | 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 | |
| extension:multipleOr |
0..1 | boolean | R5: Allow multiple values per parameter (or) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleOr | |
| extension:multipleAnd |
0..1 | boolean | R5: Allow multiple parameters (and) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleAnd | |
 contact |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.contact | |
| type |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:type |
0..1 | code | R5: number | date | string | token | reference | composite | quantity | uri | special URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.type Binding: SearchParamType (required): Data types allowed to be used for search parameters. | |
| 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: R5SearchModifierCodeForR3 (0.1.0) (required): A supported modifier for a search parameter. | |
| component |
||||
| definition |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:definition |
0..1 | uri | R5: definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.component.definition | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| SearchParameter |
C | 1..1 | SearchParameter | Search Parameter for a resource Constraints: 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: Common Languages (extensible): A human language.
| |||||
| 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 | |||||
| extension:identifier |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] | R5: Additional identifier for the search parameter (business identifier) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | |||||
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
| extension:title |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-title]] | R5: Name for this search parameter (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
| extension:copyright |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |||||
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | 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 | |||||
| extension:multipleOr |
0..1 | boolean | R5: Allow multiple values per parameter (or) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleOr | |||||
| extension:multipleAnd |
0..1 | boolean | R5: Allow multiple parameters (and) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleAnd | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 1..1 | uri | Logical URI to reference this search parameter (globally unique) | ||||
| version |
Σ | 0..1 | string | Business version of the search parameter | ||||
| name |
Σ | 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 a Value Set or Concept Map. | ||||
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date this was last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.contact | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| useContext |
Σ | 0..* | UsageContext | Context 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 FHIR. | ||||
| type |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri Binding: SearchParamType (required): Data types allowed to be used for search parameters. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | code | R5: number | date | string | token | reference | composite | quantity | uri | special URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.type Binding: SearchParamType (required): Data types allowed to be used for search parameters. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| derivedFrom |
0..1 | uri | Original Definition for the search parameter | |||||
| description |
Σ | 1..1 | markdown | Natural language description of the search parameter | ||||
| 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 | |||||
| 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. | |||||
| value |
0..1 | code | 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 FHIR. | |||||
| 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 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 | |||||
| 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: R5SearchModifierCodeForR3 (0.1.0) (required): A supported modifier for a search parameter. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| chain |
0..* | string | Chained names supported | |||||
| component |
0..* | BackboneElement | For Composite resources to define the parts | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
 definition |
1..1 | Reference(SearchParameter) | Defines how the part works | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:definition |
1..1 | uri | R5: definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.component.definition | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| expression |
1..1 | string | Subexpression relative to main expression | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SearchParameter.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| SearchParameter.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍3.0.2 | FHIR Std. |
| SearchParameter.base | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.type | Base | required | SearchParamType | 📍3.0.2 | FHIR Std. |
| SearchParameter.xpathUsage | Base | required | XPathUsageType | 📍3.0.2 | FHIR Std. |
| SearchParameter.target | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.comparator | Base | required | SearchComparator | 📍3.0.2 | FHIR Std. |
| SearchParameter.modifier | Base | required |
SearchModifierCode
|
📍3.0.2 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | SearchParameter | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SearchParameter |
C | 1..1 | SearchParameter | Search Parameter for a resource Constraints: 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 | |
| extension:identifier |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] | R5: Additional identifier for the search parameter (business identifier) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | |
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |
| extension:title |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-title]] | R5: Name for this search parameter (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
| extension:copyright |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | 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 | |
| extension:multipleOr |
0..1 | boolean | R5: Allow multiple values per parameter (or) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleOr | |
| extension:multipleAnd |
0..1 | boolean | R5: Allow multiple parameters (and) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleAnd | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
Σ | 1..1 | uri | Logical URI to reference this search parameter (globally unique) |
| name |
Σ | 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 a Value Set or Concept Map. |
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| 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 FHIR. |
| type |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri Binding: SearchParamType (required): Data types allowed to be used for search parameters. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:type |
0..1 | code | R5: number | date | string | token | reference | composite | quantity | uri | special URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.type Binding: SearchParamType (required): Data types allowed to be used for search parameters. | |
| description |
Σ | 1..1 | markdown | Natural language description of the search parameter |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| SearchParameter.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| SearchParameter.base | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.type | Base | required | SearchParamType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | SearchParameter | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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: |
|---|---|---|---|---|
| SearchParameter |
1..1 | SearchParameter | Search Parameter for a resource | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] | R5: Additional identifier for the search parameter (business identifier) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | |
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |
| extension:title |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-title]] | R5: Name for this search parameter (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
| extension:copyright |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | 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 | |
| extension:multipleOr |
0..1 | boolean | R5: Allow multiple values per parameter (or) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleOr | |
| extension:multipleAnd |
0..1 | boolean | R5: Allow multiple parameters (and) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleAnd | |
| contact |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.contact | |
| type |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:type |
0..1 | code | R5: number | date | string | token | reference | composite | quantity | uri | special URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.type Binding: SearchParamType (required): Data types allowed to be used for search parameters. | |
| 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: R5SearchModifierCodeForR3 (0.1.0) (required): A supported modifier for a search parameter. | |
| component |
||||
| definition |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:definition |
0..1 | uri | R5: definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.component.definition | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| SearchParameter |
C | 1..1 | SearchParameter | Search Parameter for a resource Constraints: 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: Common Languages (extensible): A human language.
| |||||
| 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 | |||||
| extension:identifier |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] | R5: Additional identifier for the search parameter (business identifier) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | |||||
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
| extension:title |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-title]] | R5: Name for this search parameter (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
| extension:copyright |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |||||
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | 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 | |||||
| extension:multipleOr |
0..1 | boolean | R5: Allow multiple values per parameter (or) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleOr | |||||
| extension:multipleAnd |
0..1 | boolean | R5: Allow multiple parameters (and) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.multipleAnd | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 1..1 | uri | Logical URI to reference this search parameter (globally unique) | ||||
| version |
Σ | 0..1 | string | Business version of the search parameter | ||||
| name |
Σ | 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 a Value Set or Concept Map. | ||||
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date this was last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.contact | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| useContext |
Σ | 0..* | UsageContext | Context 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 FHIR. | ||||
| type |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri Binding: SearchParamType (required): Data types allowed to be used for search parameters. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | code | R5: number | date | string | token | reference | composite | quantity | uri | special URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.type Binding: SearchParamType (required): Data types allowed to be used for search parameters. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| derivedFrom |
0..1 | uri | Original Definition for the search parameter | |||||
| description |
Σ | 1..1 | markdown | Natural language description of the search parameter | ||||
| 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 | |||||
| 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. | |||||
| value |
0..1 | code | 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 FHIR. | |||||
| 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 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 | |||||
| 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: R5SearchModifierCodeForR3 (0.1.0) (required): A supported modifier for a search parameter. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| chain |
0..* | string | Chained names supported | |||||
| component |
0..* | BackboneElement | For Composite resources to define the parts | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| definition |
1..1 | Reference(SearchParameter) | Defines how the part works | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:definition |
1..1 | uri | R5: definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SearchParameter.component.definition | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| expression |
1..1 | string | Subexpression relative to main expression | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SearchParameter.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| SearchParameter.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍3.0.2 | FHIR Std. |
| SearchParameter.base | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.type | Base | required | SearchParamType | 📍3.0.2 | FHIR Std. |
| SearchParameter.xpathUsage | Base | required | XPathUsageType | 📍3.0.2 | FHIR Std. |
| SearchParameter.target | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| SearchParameter.comparator | Base | required | SearchComparator | 📍3.0.2 | FHIR Std. |
| SearchParameter.modifier | Base | required |
SearchModifierCode
|
📍3.0.2 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | SearchParameter | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change