Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-SearchParameter resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. SearchParameter | |
| Definition | A search parameter that defines a named search item that can be used to search/filter on a resource. |
| Short | Search parameter for a resource |
| Comments | In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content. |
| Control | 0..* |
| Is Modifier | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())spd-0: 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: If an xpath is present, there SHALL be an xpathUsage ( xpath.empty() or xpathUsage.exists())spd-2: Search parameters can only have chain names when the search parameter type is 'reference' ( chain.empty() or type = 'reference')dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) spd-0: 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: If an xpath is present, there SHALL be an xpathUsage (xpath.empty() or xpathUsage.exists()) spd-2: Search parameters can only have chain names when the search parameter type is 'reference' (chain.empty() or type = 'reference') |
| 2. SearchParameter.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. SearchParameter.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on SearchParameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. SearchParameter.extension:identifier | |
| Slice Name | identifier |
| Definition | R5: |
| Short | R5: Additional identifier for the search parameter (business identifier) (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(Artifact Identifier) (Extension Type: Identifier) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 8. SearchParameter.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. SearchParameter.extension:title | |
| Slice Name | title |
| Definition | R5: |
| Short | R5: Name for this search parameter (human friendly) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Title) (Extension Type: string) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 12. SearchParameter.extension:copyright | |
| Slice Name | copyright |
| Definition | R5: |
| Short | R5: Use and/or publishing restrictions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Copyright) (Extension Type: markdown) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 14. SearchParameter.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Copyright Label) (Extension Type: string) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 16. SearchParameter.extension:constraint | |
| Slice Name | constraint |
| Definition | R5: |
| Short | R5: FHIRPath expression that constraints the usage of this SearchParamete (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: FHIRPath expression that constraints the usage of this SearchParamete (new)) (Extension Type: string) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 18. SearchParameter.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Summary | false |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 20. SearchParameter.url | |
| Definition | An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers. |
| Short | Canonical identifier for this search parameter, represented as a URI (globally unique) |
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. SearchParameter.name | |
| Definition | A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Short | Name for this search parameter (computer friendly) |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
| Control | 1..1 This element is affected by the following invariants: inv-0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Support human navigation and code generation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. SearchParameter.status | |
| Definition | The status of this search parameter. Enables tracking the life-cycle of the content. |
| Short | draft | active | retired | unknown |
| Comments | Allows filtering of search parameters that are appropriate for use versus not. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)The lifecycle status of an artifact. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. SearchParameter.description | |
| Definition | And how it used. |
| Short | Natural language description of the search parameter |
| Comments | This description can be used to capture details such as why the search parameter was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the search parameter as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the search parameter is presumed to be the predominant language in the place the search parameter was created). |
| Control | 1..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. SearchParameter.code | |
| Definition | The code used in the URL or the parameter name in a parameters resource for this search parameter. |
| Short | Code used in URL |
| Comments | For maximum compatibility, use only lowercase ASCII characters. |
| Control | 1..1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. SearchParameter.base | |
| Definition | The base resource type(s) that this search parameter can be used against. |
| Short | The resource type(s) this search parameter applies to |
| Comments | A search parameter must always apply to at least one resource type. When search parameters apply to more than one resource type, they can be used against any of the listed resource types, or in a cross-type search (see Cross Resource Search). |
| Control | 1..* |
| Binding | The codes SHALL be taken from ResourceType  http://hl7.org/fhir/ValueSet/resource-types|4.0.1(required to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)One of the resource types defined as part of this version of FHIR. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. SearchParameter.type | |
| Definition | The type of value that a search parameter may contain, and how the content is interpreted. |
| Short | number | date | string | token | reference | composite | quantity | uri | special |
| Control | 1..1 |
| Binding | The codes SHALL be taken from SearchParamTypehttp://hl7.org/fhir/ValueSet/search-param-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/search-param-type|4.0.1)Data types allowed to be used for search parameters. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SearchParameter | |
| 2. SearchParameter.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SearchParameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. SearchParameter.extension:identifier | |
| Slice Name | identifier |
| Definition | R5: |
| Short | R5: Additional identifier for the search parameter (business identifier) (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(Artifact Identifier) (Extension Type: Identifier) |
| 6. SearchParameter.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding) |
| 8. SearchParameter.extension:title | |
| Slice Name | title |
| Definition | R5: |
| Short | R5: Name for this search parameter (human friendly) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Title) (Extension Type: string) |
| 10. SearchParameter.extension:copyright | |
| Slice Name | copyright |
| Definition | R5: |
| Short | R5: Use and/or publishing restrictions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Copyright) (Extension Type: markdown) |
| 12. SearchParameter.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Artifact Copyright Label) (Extension Type: string) |
| 14. SearchParameter.extension:constraint | |
| Slice Name | constraint |
| Definition | R5: |
| Short | R5: FHIRPath expression that constraints the usage of this SearchParamete (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: FHIRPath expression that constraints the usage of this SearchParamete (new)) (Extension Type: string) |
| 16. SearchParameter.xpathUsage | |
| 18. SearchParameter.xpathUsage.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SearchParameter.xpathUsage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. SearchParameter.xpathUsage.extension:processingMode | |
| Slice Name | processingMode |
| Definition | R5: |
| Short | R5: normal | phonetic | other additional codes |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: normal | phonetic | other additional codes) (Extension Type: code) |
| 22. SearchParameter.modifier | |
| 24. SearchParameter.modifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on SearchParameter.modifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. SearchParameter.modifier.extension:modifier | |
| Slice Name | modifier |
| Definition | R5: |
| Short | R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes) (Extension Type: code) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SearchParameter | |||||
| Definition | A search parameter that defines a named search item that can be used to search/filter on a resource. | ||||
| Short | Search parameter for a resource | ||||
| Comments | In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content. | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())spd-0: 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: If an xpath is present, there SHALL be an xpathUsage ( xpath.empty() or xpathUsage.exists())spd-2: Search parameters can only have chain names when the search parameter type is 'reference' ( chain.empty() or type = 'reference') | ||||
| 2. SearchParameter.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. SearchParameter.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. SearchParameter.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. SearchParameter.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. SearchParameter.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. SearchParameter.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. SearchParameter.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on SearchParameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. SearchParameter.extension:identifier | |||||
| Slice Name | identifier | ||||
| Definition | R5: | ||||
| Short | R5: Additional identifier for the search parameter (business identifier) (new) | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(Artifact Identifier) (Extension Type: Identifier) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. SearchParameter.extension:versionAlgorithm | |||||
| Slice Name | versionAlgorithm | ||||
| Definition | R5: | ||||
| Short | R5: How to compare versions (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. SearchParameter.extension:title | |||||
| Slice Name | title | ||||
| Definition | R5: | ||||
| Short | R5: Name for this search parameter (human friendly) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Title) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. SearchParameter.extension:copyright | |||||
| Slice Name | copyright | ||||
| Definition | R5: | ||||
| Short | R5: Use and/or publishing restrictions (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Copyright) (Extension Type: markdown) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. SearchParameter.extension:copyrightLabel | |||||
| Slice Name | copyrightLabel | ||||
| Definition | R5: | ||||
| Short | R5: Copyright holder and year(s) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(Artifact Copyright Label) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. SearchParameter.extension:constraint | |||||
| Slice Name | constraint | ||||
| Definition | R5: | ||||
| Short | R5: FHIRPath expression that constraints the usage of this SearchParamete (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: FHIRPath expression that constraints the usage of this SearchParamete (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 28. SearchParameter.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 30. SearchParameter.url | |||||
| Definition | An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers. | ||||
| Short | Canonical identifier for this search parameter, represented as a URI (globally unique) | ||||
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash). | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. SearchParameter.version | |||||
| Definition | The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | ||||
| Short | Business version of the search parameter | ||||
| Comments | There may be different search parameter instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the search parameter with the format [url]|[version]. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 34. SearchParameter.name | |||||
| Definition | A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||
| Short | Name for this search parameter (computer friendly) | ||||
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||
| Control | 1..1 This element is affected by the following invariants: inv-0 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Support human navigation and code generation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. SearchParameter.derivedFrom | |||||
| Definition | Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter. | ||||
| Short | Original definition for the search parameter | ||||
| Comments | The intent of this is that a server can designate that it provides support for a search parameter defined in the specification itself (e.g. | ||||
| Control | 0..1 | ||||
| Type | canonical(SearchParameter) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. SearchParameter.status | |||||
| Definition | The status of this search parameter. Enables tracking the life-cycle of the content. | ||||
| Short | draft | active | retired | unknown | ||||
| Comments | Allows filtering of search parameters that are appropriate for use versus not. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)The lifecycle status of an artifact. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. SearchParameter.experimental | |||||
| Definition | A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | ||||
| Short | For testing purposes, not real usage | ||||
| Comments | Allows filtering of search parameters that are appropriate for use versus not. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. SearchParameter.date | |||||
| Definition | The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes. | ||||
| Short | Date last changed | ||||
| Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the search parameter. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Revision Date | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. SearchParameter.publisher | |||||
| Definition | The name of the organization or individual that published the search parameter. | ||||
| Short | Name of the publisher (organization or individual) | ||||
| Comments | Usually an organization but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the search parameter. This item SHOULD be populated unless the information is available from context. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Helps establish the "authority/credibility" of the search parameter. May also allow for contact. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. SearchParameter.contact | |||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||
| Short | Contact details for the publisher | ||||
| Comments | May be a web site, an email address, a telephone number, etc. | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. SearchParameter.description | |||||
| Definition | And how it used. | ||||
| Short | Natural language description of the search parameter | ||||
| Comments | This description can be used to capture details such as why the search parameter was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the search parameter as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the search parameter is presumed to be the predominant language in the place the search parameter was created). | ||||
| Control | 1..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. SearchParameter.useContext | |||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances. | ||||
| Short | The context that the content is intended to support | ||||
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||
| Control | 0..* | ||||
| Type | UsageContext | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Assist in searching for appropriate content. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. SearchParameter.jurisdiction | |||||
| Definition | A legal or geographic region in which the search parameter is intended to be used. | ||||
| Short | Intended jurisdiction for search parameter (if applicable) | ||||
| Comments | It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1)Countries and regions within which this artifact is targeted for use. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. SearchParameter.purpose | |||||
| Definition | Explanation of why this search parameter is needed and why it has been designed as it has. | ||||
| Short | Why this search parameter is defined | ||||
| Comments | This element does not describe the usage of the search parameter. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this search parameter. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. SearchParameter.code | |||||
| Definition | The code used in the URL or the parameter name in a parameters resource for this search parameter. | ||||
| Short | Code used in URL | ||||
| Comments | For maximum compatibility, use only lowercase ASCII characters. | ||||
| Control | 1..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. SearchParameter.base | |||||
| Definition | The base resource type(s) that this search parameter can be used against. | ||||
| Short | The resource type(s) this search parameter applies to | ||||
| Comments | A search parameter must always apply to at least one resource type. When search parameters apply to more than one resource type, they can be used against any of the listed resource types, or in a cross-type search (see Cross Resource Search). | ||||
| Control | 1..* | ||||
| Binding | The codes SHALL be taken from ResourceType (required to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)One of the resource types defined as part of this version of FHIR. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. SearchParameter.type | |||||
| Definition | The type of value that a search parameter may contain, and how the content is interpreted. | ||||
| Short | number | date | string | token | reference | composite | quantity | uri | special | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from SearchParamType (required to http://hl7.org/fhir/ValueSet/search-param-type|4.0.1)Data types allowed to be used for search parameters. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. SearchParameter.expression | |||||
| Definition | A FHIRPath expression that returns a set of elements for the search parameter. | ||||
| Short | FHIRPath expression that extracts the values | ||||
| Comments | Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived. | ||||
| Control | 0..1 This element is affected by the following invariants: spd-1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. SearchParameter.xpath | |||||
| Definition | An XPath expression that returns a set of elements for the search parameter. | ||||
| Short | XPath that extracts the values | ||||
| Comments | Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. | ||||
| Control | 0..1 This element is affected by the following invariants: spd-1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. SearchParameter.xpathUsage | |||||
| Definition | How the search parameter relates to the set of elements returned by evaluating the xpath query. | ||||
| Short | normal | phonetic | nearby | distance | other | ||||
| Control | 0..1 This element is affected by the following invariants: spd-1 | ||||
| Binding | The codes SHALL be taken from XPathUsageType (required to http://hl7.org/fhir/ValueSet/search-xpath-usage|4.0.1)How a search parameter relates to the set of elements returned by evaluating its xpath query. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. SearchParameter.xpathUsage.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 70. SearchParameter.xpathUsage.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on SearchParameter.xpathUsage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 72. SearchParameter.xpathUsage.extension:processingMode | |||||
| Slice Name | processingMode | ||||
| Definition | R5: | ||||
| Short | R5: normal | phonetic | other additional codes | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: normal | phonetic | other additional codes) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 74. SearchParameter.xpathUsage.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 76. SearchParameter.target | |||||
| Definition | Types of resource (if a resource is referenced). | ||||
| Short | Types of resource (if a resource reference) | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from ResourceType (required to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)One of the resource types defined as part of this version of FHIR. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. SearchParameter.multipleOr | |||||
| Definition | Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match. | ||||
| Short | Allow multiple values per parameter (or) | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. SearchParameter.multipleAnd | |||||
| Definition | Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match. | ||||
| Short | Allow multiple parameters (and) | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. SearchParameter.comparator | |||||
| Definition | Comparators supported for the search parameter. | ||||
| Short | eq | ne | gt | lt | ge | le | sa | eb | ap | ||||
| Comments | If no comparators are listed, clients should not expect servers to support any comparators. | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from SearchComparator (required to http://hl7.org/fhir/ValueSet/search-comparator|4.0.1)What Search Comparator Codes are supported in search. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. SearchParameter.modifier | |||||
| Definition | A modifier supported for the search parameter. | ||||
| Short | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from SearchModifierCode (required to http://hl7.org/fhir/ValueSet/search-modifier-code|4.0.1)A supported modifier for a search parameter. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. SearchParameter.modifier.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 88. SearchParameter.modifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on SearchParameter.modifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 90. SearchParameter.modifier.extension:modifier | |||||
| Slice Name | modifier | ||||
| Definition | R5: | ||||
| Short | R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate additional codes) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 92. SearchParameter.modifier.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 94. SearchParameter.chain | |||||
| Definition | Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type. | ||||
| Short | Chained names supported | ||||
| Comments | Systems are not required to list all the chain names they support, but if they don't list them, clients might not know to use them. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. SearchParameter.component | |||||
| Definition | Used to define the parts of a composite search parameter. | ||||
| Short | For Composite resources to define the parts | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. SearchParameter.component.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 100. SearchParameter.component.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 102. SearchParameter.component.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 104. SearchParameter.component.definition | |||||
| Definition | The definition of the search parameter that describes this part. | ||||
| Short | Defines how the part works | ||||
| Control | 1..1 | ||||
| Type | canonical(SearchParameter) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 106. SearchParameter.component.expression | |||||
| Definition | A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression. | ||||
| Short | Subexpression relative to main expression | ||||
| Comments | This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change