Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

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

Resource Profile: Profile_R4B_SearchParameter_R3 - Detailed Descriptions

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.

ShortSearch 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.

Control1..1
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: 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())
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-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: 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())
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.

ShortA 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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. SearchParameter.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

ShortExtensionAdditional 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on SearchParameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. SearchParameter.extension:multipleOr
    Slice NamemultipleOr
    Definition

    R4B: SearchParameter.multipleOr (new:boolean)

    ShortR4B: Allow multiple values per parameter (or) (new)
    Comments

    Element SearchParameter.multipleOr has a context of SearchParameter based on following the parent source element upwards and mapping to SearchParameter. Element SearchParameter.multipleOr has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Allow multiple values per parameter (or) (new)) (Extension Type: boolean)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. SearchParameter.extension:multipleAnd
    Slice NamemultipleAnd
    Definition

    R4B: SearchParameter.multipleAnd (new:boolean)

    ShortR4B: Allow multiple parameters (and) (new)
    Comments

    Element SearchParameter.multipleAnd has a context of SearchParameter based on following the parent source element upwards and mapping to SearchParameter. Element SearchParameter.multipleAnd has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: Allow multiple parameters (and) (new)) (Extension Type: boolean)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. 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. Usually modifier elements provide negation or qualification. In order 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.

    ShortExtensions 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.

    Control0..*
    TypeExtension
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    12. 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see Technical and Business Versions.

    ShortLogical URI to reference this search parameter (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.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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).

    14. 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.

    ShortName for this search parameter (computer friendly)
    Comments

    The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Support human navigation and code generation.

    16. SearchParameter.status
    Definition

    The status of this search parameter. Enables tracking the life-cycle of the content.

    Shortdraft | active | retired | unknown
    Comments

    Allows filtering of search parameters that are appropriate for use vs. not.
    This is labeled as "Is Modifier" because applications should not use a retired search parameter without due consideration.

    Control1..1
    BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|3.0.2
    (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)

    The lifecycle status of a Value Set or Concept Map.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    18. 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.

    ShortFor testing purposes, not real usage
    Comments

    Allows filtering of search parameter that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental search parameter in production.

    Control0..1
    Typeboolean
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter.

    20. SearchParameter.code
    Definition

    The code used in the URL or the parameter name in a parameters resource for this search parameter.

    ShortCode used in URL
    Comments

    For maximum compatibility, use only lowercase ASCII characters.

    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    22. SearchParameter.base
    Definition

    The base resource type(s) that this search parameter can be used against.

    ShortThe resource type(s) this search parameter applies to
    Comments

    A search parameter must always have at least one type. When search parameters have more than one resource, they can be used against any of the listed resource types, or in a cross-type search (see Cross Resource Search).

    Control1..*
    BindingThe codes SHALL be taken from ResourceType .http://hl7.org/fhir/ValueSet/resource-types|3.0.2
    (required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)

    One of the resource types defined as part of FHIR.

    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    24. SearchParameter.base.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. In order 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.

    ShortExtensionAdditional 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.

    Control0..*
    TypeExtension
    Alternate Namesextensions, user content
    SlicingThis element introduces a set of slices on SearchParameter.base.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 26. SearchParameter.base.extension:base
      Slice Namebase
      Definition

      R4B: SearchParameter.base additional codes

      ShortR4B: base additional codes
      Comments

      Element SearchParameter.base is mapped to FHIR STU3 element SearchParameter.base as RelatedTo. The mappings for SearchParameter.base do not allow expression of the necessary codes, per the bindings on the source and target. 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).

      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(R4B: base additional codes) (Extension Type: code)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      28. SearchParameter.type
      Definition

      The type of value a search parameter refers to, and how the content is interpreted.

      Shortnumber | date | string | token | reference | composite | quantity | uri
      Control1..1
      BindingThe codes SHALL be taken from SearchParamTypehttp://hl7.org/fhir/ValueSet/search-param-type|3.0.2
      (required to http://hl7.org/fhir/ValueSet/search-param-type|3.0.2)

      Data types allowed to be used for search parameters.

      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      30. SearchParameter.type.extension
      Definition

      An Extension


      May be used to represent additional information that is not part of the basic definition of the element. In order 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.

      ShortExtensionAdditional 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.

      Control0..*
      TypeExtension
      Alternate Namesextensions, user content
      SlicingThis element introduces a set of slices on SearchParameter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 32. SearchParameter.type.extension:type
        Slice Nametype
        Definition

        R4B: SearchParameter.type

        ShortR4B: number | date | string | token | reference | composite | quantity | uri | special
        Comments

        Element SearchParameter.type is mapped to FHIR STU3 element SearchParameter.type as SourceIsBroaderThanTarget.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(R4B: number | date | string | token | reference | composite | quantity | uri | special) (Extension Type: code)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        34. SearchParameter.description
        Definition

        A free text natural language description of the search parameter from a consumer's perspective. and how it used.

        ShortNatural 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 profile is presumed to be the predominant language in the place the profile was created).

        Control1..1
        Typemarkdown
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue

        Guidance on how to interpret the contents of this table can be foundhere

        0. SearchParameter
        2. SearchParameter.meta
        4. SearchParameter.meta.extension
        Control0..*
        SlicingThis element introduces a set of slices on SearchParameter.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 6. SearchParameter.meta.extension:meta
          Slice Namemeta
          Definition

          R4B: SearchParameter.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

          ShortR4B: meta additional types
          Comments

          Element SearchParameter.meta is mapped to FHIR STU3 element SearchParameter.meta as SourceIsBroaderThanTarget. The mappings for SearchParameter.meta do not cover the following types: Meta. The mappings for SearchParameter.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

          Control0..1
          TypeExtension(R4B: meta additional types) (Extension Type: Meta)
          8. SearchParameter.text
          10. SearchParameter.text.extension
          Control0..*
          SlicingThis element introduces a set of slices on SearchParameter.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 12. SearchParameter.text.extension:text
            Slice Nametext
            Definition

            R4B: SearchParameter.text additional types (Narrative) additional types from child elements (div, status)

            ShortR4B: text additional types
            Comments

            Element SearchParameter.text is mapped to FHIR STU3 element SearchParameter.text as SourceIsBroaderThanTarget. The mappings for SearchParameter.text do not cover the following types: Narrative. The mappings for SearchParameter.text do not cover the following types based on type expansion: div, status. 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.

            Control0..1
            TypeExtension(R4B: text additional types) (Complex Extension)
            14. SearchParameter.extension
            Control0..*
            SlicingThis element introduces a set of slices on SearchParameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 16. SearchParameter.extension:multipleOr
              Slice NamemultipleOr
              Definition

              R4B: SearchParameter.multipleOr (new:boolean)

              ShortR4B: Allow multiple values per parameter (or) (new)
              Comments

              Element SearchParameter.multipleOr has a context of SearchParameter based on following the parent source element upwards and mapping to SearchParameter. Element SearchParameter.multipleOr has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

              Control0..1
              TypeExtension(R4B: Allow multiple values per parameter (or) (new)) (Extension Type: boolean)
              18. SearchParameter.extension:multipleAnd
              Slice NamemultipleAnd
              Definition

              R4B: SearchParameter.multipleAnd (new:boolean)

              ShortR4B: Allow multiple parameters (and) (new)
              Comments

              Element SearchParameter.multipleAnd has a context of SearchParameter based on following the parent source element upwards and mapping to SearchParameter. Element SearchParameter.multipleAnd has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

              Control0..1
              TypeExtension(R4B: Allow multiple parameters (and) (new)) (Extension Type: boolean)
              20. SearchParameter.contact
              22. SearchParameter.contact.extension
              Control0..*
              SlicingThis element introduces a set of slices on SearchParameter.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 24. SearchParameter.contact.extension:contact
                Slice Namecontact
                Definition

                R4B: SearchParameter.contact additional types (ContactDetail) additional types from child elements (name, telecom)

                ShortR4B: contact additional types
                Comments

                Element SearchParameter.contact is mapped to FHIR STU3 element SearchParameter.contact as SourceIsBroaderThanTarget. The mappings for SearchParameter.contact do not cover the following types: ContactDetail. The mappings for SearchParameter.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

                Control0..*
                TypeExtension(R4B: contact additional types) (Complex Extension)
                26. SearchParameter.useContext
                28. SearchParameter.useContext.extension
                Control0..*
                SlicingThis element introduces a set of slices on SearchParameter.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 30. SearchParameter.useContext.extension:useContext
                  Slice NameuseContext
                  Definition

                  R4B: SearchParameter.useContext additional types (UsageContext) additional types from child elements (code, value[x])

                  ShortR4B: The context that the content is intended to support additional types
                  Comments

                  Element SearchParameter.useContext is mapped to FHIR STU3 element SearchParameter.useContext as SourceIsBroaderThanTarget. The mappings for SearchParameter.useContext do not cover the following types: UsageContext. The mappings for SearchParameter.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

                  Control0..*
                  TypeExtension(R4B: The context that the content is intended to support additional types) (Complex Extension)
                  32. SearchParameter.base
                  34. SearchParameter.base.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on SearchParameter.base.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 36. SearchParameter.base.extension:base
                    Slice Namebase
                    Definition

                    R4B: SearchParameter.base additional codes

                    ShortR4B: base additional codes
                    Comments

                    Element SearchParameter.base is mapped to FHIR STU3 element SearchParameter.base as RelatedTo. The mappings for SearchParameter.base do not allow expression of the necessary codes, per the bindings on the source and target. 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).

                    Control0..*
                    TypeExtension(R4B: base additional codes) (Extension Type: code)
                    38. SearchParameter.type
                    40. SearchParameter.type.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on SearchParameter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 42. SearchParameter.type.extension:type
                      Slice Nametype
                      Definition

                      R4B: SearchParameter.type

                      ShortR4B: number | date | string | token | reference | composite | quantity | uri | special
                      Comments

                      Element SearchParameter.type is mapped to FHIR STU3 element SearchParameter.type as SourceIsBroaderThanTarget.

                      Control0..1
                      TypeExtension(R4B: number | date | string | token | reference | composite | quantity | uri | special) (Extension Type: code)
                      44. SearchParameter.target
                      46. SearchParameter.target.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on SearchParameter.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 48. SearchParameter.target.extension:target
                        Slice Nametarget
                        Definition

                        R4B: SearchParameter.target additional codes

                        ShortR4B: target additional codes
                        Comments

                        Element SearchParameter.target is mapped to FHIR STU3 element SearchParameter.target as RelatedTo. The mappings for SearchParameter.target do not allow expression of the necessary codes, per the bindings on the source and target.

                        Control0..*
                        TypeExtension(R4B: target additional codes) (Extension Type: code)
                        50. SearchParameter.modifier
                        52. SearchParameter.modifier.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on SearchParameter.modifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 54. SearchParameter.modifier.extension:modifier
                          Slice Namemodifier
                          Definition

                          R4B: SearchParameter.modifier

                          ShortR4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
                          Comments

                          Element SearchParameter.modifier is mapped to FHIR STU3 element SearchParameter.modifier as SourceIsBroaderThanTarget.

                          Control0..*
                          TypeExtension(R4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType) (Extension Type: code)
                          56. SearchParameter.component
                          58. SearchParameter.component.definition
                          60. SearchParameter.component.definition.extension
                          Control0..*
                          SlicingThis element introduces a set of slices on SearchParameter.component.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 62. SearchParameter.component.definition.extension:definition
                            Slice Namedefinition
                            Definition

                            R4B: SearchParameter.component.definition additional types (canonical(http://hl7.org/fhir/StructureDefinition/SearchParameter)) additional types from child elements (value)

                            ShortR4B: definition additional types
                            Comments

                            Element SearchParameter.component.definition is mapped to FHIR STU3 element SearchParameter.component.definition as SourceIsBroaderThanTarget. The mappings for SearchParameter.component.definition do not cover the following types: canonical. The mappings for SearchParameter.component.definition do not cover the following types based on type expansion: value.

                            Control0..1
                            TypeExtension(R4B: definition additional types) (Extension Type: uri(Cross-version Profile for R4B.SearchParameter for use in FHIR STU3, SearchParameter))

                            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.

                            ShortSearch 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.

                            Control1..1
                            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                            dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: 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())
                            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.

                            ShortLogical 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.

                            Control0..1
                            Typeid
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            4. SearchParameter.meta
                            Definition

                            The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

                            ShortMetadata about the resource
                            Control0..1
                            TypeMeta
                            Summarytrue
                            6. SearchParameter.meta.id
                            Definition

                            unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            Shortxml:id (or equivalent in JSON)
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            XML FormatIn the XML format, this property is represented as an attribute.
                            8. SearchParameter.meta.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            SlicingThis element introduces a set of slices on SearchParameter.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 10. SearchParameter.meta.extension:meta
                              Slice Namemeta
                              Definition

                              R4B: SearchParameter.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

                              ShortR4B: meta additional types
                              Comments

                              Element SearchParameter.meta is mapped to FHIR STU3 element SearchParameter.meta as SourceIsBroaderThanTarget. The mappings for SearchParameter.meta do not cover the following types: Meta. The mappings for SearchParameter.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

                              Control0..1
                              TypeExtension(R4B: meta additional types) (Extension Type: Meta)
                              12. SearchParameter.meta.versionId
                              Definition

                              The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

                              ShortVersion specific identifier
                              Comments

                              The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                              Control0..1
                              Typeid
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              14. SearchParameter.meta.lastUpdated
                              Definition

                              When the resource last changed - e.g. when the version changed.

                              ShortWhen the resource version last changed
                              Comments

                              This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

                              Control0..1
                              Typeinstant
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              16. SearchParameter.meta.profile
                              Definition

                              A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                              ShortProfiles this resource claims to conform to
                              Comments

                              It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                              Control0..*
                              Typeuri
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              18. SearchParameter.meta.security
                              Definition

                              Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                              ShortSecurity Labels applied to this resource
                              Comments

                              The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                              Control0..*
                              BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                              (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)

                              Security Labels from the Healthcare Privacy and Security Classification System.

                              TypeCoding
                              Summarytrue
                              20. SearchParameter.meta.tag
                              Definition

                              Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                              ShortTags applied to this resource
                              Comments

                              The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                              Control0..*
                              BindingFor example codes, see Common Tags
                              (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)

                              Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

                              TypeCoding
                              Summarytrue
                              22. 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.

                              ShortA 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.

                              This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

                              Control0..1
                              Typeuri
                              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              24. SearchParameter.language
                              Definition

                              The base language in which the resource is written.

                              ShortLanguage 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).

                              Control0..1
                              BindingUnless not suitable, these codes SHALL be taken from Common Languages
                              (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

                              A human language.

                              Additional BindingsPurpose
                              All LanguagesMax Binding
                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              26. SearchParameter.text
                              Definition

                              A human-readable narrative that contains a summary of the resource, and may 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.

                              ShortText 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 in formation is added later.

                              Control0..1
                              This element is affected by the following invariants: dom-1
                              TypeNarrative
                              Alternate Namesnarrative, html, xhtml, display
                              28. SearchParameter.text.id
                              Definition

                              unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              Shortxml:id (or equivalent in JSON)
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              XML FormatIn the XML format, this property is represented as an attribute.
                              30. SearchParameter.text.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              SlicingThis element introduces a set of slices on SearchParameter.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 32. SearchParameter.text.extension:text
                                Slice Nametext
                                Definition

                                R4B: SearchParameter.text additional types (Narrative) additional types from child elements (div, status)

                                ShortR4B: text additional types
                                Comments

                                Element SearchParameter.text is mapped to FHIR STU3 element SearchParameter.text as SourceIsBroaderThanTarget. The mappings for SearchParameter.text do not cover the following types: Narrative. The mappings for SearchParameter.text do not cover the following types based on type expansion: div, status. 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.

                                Control0..1
                                TypeExtension(R4B: text additional types) (Complex Extension)
                                34. SearchParameter.text.status
                                Definition

                                The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                                Shortgenerated | extensions | additional | empty
                                Control1..1
                                BindingThe codes SHALL be taken from NarrativeStatus
                                (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)

                                The status of a resource narrative

                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                36. SearchParameter.text.div
                                Definition

                                The actual narrative content, a stripped down version of XHTML.

                                ShortLimited xhtml content
                                Comments

                                The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                                Control1..1
                                Typexhtml
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Invariantstxt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())
                                txt-2: The narrative SHALL have some non-whitespace content (htmlchecks())
                                38. 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.

                                ShortContained, 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.

                                Control0..*
                                TypeResource
                                Alternate Namesinline resources, anonymous resources, contained resources
                                40. SearchParameter.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                SlicingThis element introduces a set of slices on SearchParameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 42. SearchParameter.extension:multipleOr
                                  Slice NamemultipleOr
                                  Definition

                                  R4B: SearchParameter.multipleOr (new:boolean)

                                  ShortR4B: Allow multiple values per parameter (or) (new)
                                  Comments

                                  Element SearchParameter.multipleOr has a context of SearchParameter based on following the parent source element upwards and mapping to SearchParameter. Element SearchParameter.multipleOr has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(R4B: Allow multiple values per parameter (or) (new)) (Extension Type: boolean)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  44. SearchParameter.extension:multipleAnd
                                  Slice NamemultipleAnd
                                  Definition

                                  R4B: SearchParameter.multipleAnd (new:boolean)

                                  ShortR4B: Allow multiple parameters (and) (new)
                                  Comments

                                  Element SearchParameter.multipleAnd has a context of SearchParameter based on following the parent source element upwards and mapping to SearchParameter. Element SearchParameter.multipleAnd has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(R4B: Allow multiple parameters (and) (new)) (Extension Type: boolean)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  46. 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. Usually modifier elements provide negation or qualification. In order 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.

                                  ShortExtensions 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.

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                  Alternate Namesextensions, user content
                                  48. 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see Technical and Business Versions.

                                  ShortLogical URI to reference this search parameter (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.

                                  Control1..1
                                  Typeuri
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  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).

                                  50. 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.

                                  ShortBusiness 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 refrence to a particular business version of the search parameter with the format [url]|[version].

                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  52. 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.

                                  ShortName for this search parameter (computer friendly)
                                  Comments

                                  The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

                                  Control1..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Support human navigation and code generation.

                                  54. SearchParameter.status
                                  Definition

                                  The status of this search parameter. Enables tracking the life-cycle of the content.

                                  Shortdraft | active | retired | unknown
                                  Comments

                                  Allows filtering of search parameters that are appropriate for use vs. not.
                                  This is labeled as "Is Modifier" because applications should not use a retired search parameter without due consideration.

                                  Control1..1
                                  BindingThe codes SHALL be taken from PublicationStatus
                                  (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)

                                  The lifecycle status of a Value Set or Concept Map.

                                  Typecode
                                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  56. 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.

                                  ShortFor testing purposes, not real usage
                                  Comments

                                  Allows filtering of search parameter that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental search parameter in production.

                                  Control0..1
                                  Typeboolean
                                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter.

                                  58. SearchParameter.date
                                  Definition

                                  The date (and optionally time) when the search parameter was published. The date must change if and 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.

                                  ShortDate this was 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.

                                  Control0..1
                                  TypedateTime
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Alternate NamesRevision Date
                                  60. SearchParameter.publisher
                                  Definition

                                  The name of the individual or organization that published the search parameter.

                                  ShortName 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.

                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Helps establish the "authority/credibility" of the search parameter. May also allow for contact.

                                  62. SearchParameter.contact
                                  Definition

                                  Contact details to assist a user in finding and communicating with the publisher.

                                  ShortContact details for the publisher
                                  Comments

                                  May be a web site, an email address, a telephone number, etc.

                                  Control0..*
                                  TypeContactDetail
                                  Summarytrue
                                  64. SearchParameter.contact.id
                                  Definition

                                  unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  66. SearchParameter.contact.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  SlicingThis element introduces a set of slices on SearchParameter.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 68. SearchParameter.contact.extension:contact
                                    Slice Namecontact
                                    Definition

                                    R4B: SearchParameter.contact additional types (ContactDetail) additional types from child elements (name, telecom)

                                    ShortR4B: contact additional types
                                    Comments

                                    Element SearchParameter.contact is mapped to FHIR STU3 element SearchParameter.contact as SourceIsBroaderThanTarget. The mappings for SearchParameter.contact do not cover the following types: ContactDetail. The mappings for SearchParameter.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

                                    Control0..*
                                    TypeExtension(R4B: contact additional types) (Complex Extension)
                                    70. SearchParameter.contact.name
                                    Definition

                                    The name of an individual to contact.

                                    ShortName of an individual to contact
                                    Comments

                                    If there is no named individual, the telecom information is for the organization as a whole.

                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    72. SearchParameter.contact.telecom
                                    Definition

                                    The contact details for the individual (if a name was provided) or the organization.

                                    ShortContact details for individual or organization
                                    Control0..*
                                    TypeContactPoint
                                    Summarytrue
                                    74. SearchParameter.useContext
                                    Definition

                                    The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.

                                    ShortContext the content is intended to support
                                    Comments

                                    When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

                                    Control0..*
                                    TypeUsageContext
                                    Summarytrue
                                    Requirements

                                    Assist in searching for appropriate content.

                                    76. SearchParameter.useContext.id
                                    Definition

                                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                    Shortxml:id (or equivalent in JSON)
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    78. SearchParameter.useContext.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..*
                                    TypeExtension
                                    SlicingThis element introduces a set of slices on SearchParameter.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 80. SearchParameter.useContext.extension:useContext
                                      Slice NameuseContext
                                      Definition

                                      R4B: SearchParameter.useContext additional types (UsageContext) additional types from child elements (code, value[x])

                                      ShortR4B: The context that the content is intended to support additional types
                                      Comments

                                      Element SearchParameter.useContext is mapped to FHIR STU3 element SearchParameter.useContext as SourceIsBroaderThanTarget. The mappings for SearchParameter.useContext do not cover the following types: UsageContext. The mappings for SearchParameter.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

                                      Control0..*
                                      TypeExtension(R4B: The context that the content is intended to support additional types) (Complex Extension)
                                      82. SearchParameter.useContext.code
                                      Definition

                                      A code that identifies the type of context being specified by this usage context.

                                      ShortType of context being specified
                                      Control1..1
                                      BindingUnless not suitable, these codes SHALL be taken from UsageContextType
                                      (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|3.0.2)

                                      A code that specifies a type of context being specified by a usage context

                                      TypeCoding
                                      Summarytrue
                                      84. SearchParameter.useContext.value[x]
                                      Definition

                                      A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                                      ShortValue that defines the context
                                      Control1..1
                                      BindingFor example codes, see Context of Use ValueSet
                                      (example to http://hl7.org/fhir/ValueSet/use-context|3.0.2)

                                      A code that defines the specific value for the context being specified

                                      TypeChoice of: CodeableConcept, Quantity, Range
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Summarytrue
                                      86. SearchParameter.jurisdiction
                                      Definition

                                      A legal or geographic region in which the search parameter is intended to be used.

                                      ShortIntended 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.

                                      Control0..*
                                      BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
                                      (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2)

                                      Countries and regions within which this artifact is targeted for use

                                      TypeCodeableConcept
                                      Summarytrue
                                      88. SearchParameter.purpose
                                      Definition

                                      Explaination of why this search parameter is needed and why it has been designed as it has.

                                      ShortWhy 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.

                                      Control0..1
                                      Typemarkdown
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      90. SearchParameter.code
                                      Definition

                                      The code used in the URL or the parameter name in a parameters resource for this search parameter.

                                      ShortCode used in URL
                                      Comments

                                      For maximum compatibility, use only lowercase ASCII characters.

                                      Control1..1
                                      Typecode
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      92. SearchParameter.base
                                      Definition

                                      The base resource type(s) that this search parameter can be used against.

                                      ShortThe resource type(s) this search parameter applies to
                                      Comments

                                      A search parameter must always have at least one type. When search parameters have more than one resource, they can be used against any of the listed resource types, or in a cross-type search (see Cross Resource Search).

                                      Control1..*
                                      BindingThe codes SHALL be taken from ResourceType .
                                      (required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)

                                      One of the resource types defined as part of FHIR.

                                      Typecode
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      94. SearchParameter.base.id
                                      Definition

                                      unique id for the element within a resource (for internal references)

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      96. SearchParameter.base.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      SlicingThis element introduces a set of slices on SearchParameter.base.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 98. SearchParameter.base.extension:base
                                        Slice Namebase
                                        Definition

                                        R4B: SearchParameter.base additional codes

                                        ShortR4B: base additional codes
                                        Comments

                                        Element SearchParameter.base is mapped to FHIR STU3 element SearchParameter.base as RelatedTo. The mappings for SearchParameter.base do not allow expression of the necessary codes, per the bindings on the source and target. 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).

                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(R4B: base additional codes) (Extension Type: code)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        100. SearchParameter.base.value
                                        Definition

                                        Primitive value for code

                                        ShortPrimitive value for code
                                        Control0..1
                                        Typecode
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        102. SearchParameter.type
                                        Definition

                                        The type of value a search parameter refers to, and how the content is interpreted.

                                        Shortnumber | date | string | token | reference | composite | quantity | uri
                                        Control1..1
                                        BindingThe codes SHALL be taken from SearchParamType
                                        (required to http://hl7.org/fhir/ValueSet/search-param-type|3.0.2)

                                        Data types allowed to be used for search parameters.

                                        Typecode
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        104. SearchParameter.type.id
                                        Definition

                                        unique id for the element within a resource (for internal references)

                                        Shortxml:id (or equivalent in JSON)
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        106. SearchParameter.type.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        SlicingThis element introduces a set of slices on SearchParameter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 108. SearchParameter.type.extension:type
                                          Slice Nametype
                                          Definition

                                          R4B: SearchParameter.type

                                          ShortR4B: number | date | string | token | reference | composite | quantity | uri | special
                                          Comments

                                          Element SearchParameter.type is mapped to FHIR STU3 element SearchParameter.type as SourceIsBroaderThanTarget.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(R4B: number | date | string | token | reference | composite | quantity | uri | special) (Extension Type: code)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          110. SearchParameter.type.value
                                          Definition

                                          Primitive value for code

                                          ShortPrimitive value for code
                                          Control0..1
                                          Typecode
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          112. 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.

                                          ShortOriginal 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. value-quantity, but detail how it is supported by the server.

                                          Control0..1
                                          Typeuri
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          114. SearchParameter.description
                                          Definition

                                          A free text natural language description of the search parameter from a consumer's perspective. and how it used.

                                          ShortNatural 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 profile is presumed to be the predominant language in the place the profile was created).

                                          Control1..1
                                          Typemarkdown
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          116. SearchParameter.expression
                                          Definition

                                          A FHIRPath expression that returns a set of elements for the search parameter.

                                          ShortFHIRPath 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.

                                          Control0..1
                                          This element is affected by the following invariants: spd-1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          118. SearchParameter.xpath
                                          Definition

                                          An XPath expression that returns a set of elements for the search parameter.

                                          ShortXPath 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.

                                          Control0..1
                                          This element is affected by the following invariants: spd-1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          120. SearchParameter.xpathUsage
                                          Definition

                                          How the search parameter relates to the set of elements returned by evaluating the xpath query.

                                          Shortnormal | phonetic | nearby | distance | other
                                          Control0..1
                                          This element is affected by the following invariants: spd-1
                                          BindingThe codes SHALL be taken from XPathUsageType
                                          (required to http://hl7.org/fhir/ValueSet/search-xpath-usage|3.0.2)

                                          How a search parameter relates to the set of elements returned by evaluating its xpath query.

                                          Typecode
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          122. SearchParameter.target
                                          Definition

                                          Types of resource (if a resource is referenced).

                                          ShortTypes of resource (if a resource reference)
                                          Control0..*
                                          BindingThe codes SHALL be taken from ResourceType .
                                          (required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)

                                          One of the resource types defined as part of FHIR.

                                          Typecode
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          124. SearchParameter.target.id
                                          Definition

                                          unique id for the element within a resource (for internal references)

                                          Shortxml:id (or equivalent in JSON)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          126. SearchParameter.target.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          SlicingThis element introduces a set of slices on SearchParameter.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 128. SearchParameter.target.extension:target
                                            Slice Nametarget
                                            Definition

                                            R4B: SearchParameter.target additional codes

                                            ShortR4B: target additional codes
                                            Comments

                                            Element SearchParameter.target is mapped to FHIR STU3 element SearchParameter.target as RelatedTo. The mappings for SearchParameter.target do not allow expression of the necessary codes, per the bindings on the source and target.

                                            Control0..*
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(R4B: target additional codes) (Extension Type: code)
                                            Is Modifierfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            130. SearchParameter.target.value
                                            Definition

                                            Primitive value for code

                                            ShortPrimitive value for code
                                            Control0..1
                                            Typecode
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            132. SearchParameter.comparator
                                            Definition

                                            Comparators supported for the search parameter.

                                            Shorteq | ne | gt | lt | ge | le | sa | eb | ap
                                            Comments

                                            If no comparators are listed, clients should not expect servers to support any comparators.

                                            Control0..*
                                            BindingThe codes SHALL be taken from SearchComparator
                                            (required to http://hl7.org/fhir/ValueSet/search-comparator|3.0.2)

                                            What Search Comparator Codes are supported in search

                                            Typecode
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            134. SearchParameter.modifier
                                            Definition

                                            A modifier supported for the search parameter.

                                            Shortmissing | exact | contains | not | text | in | not-in | below | above | type
                                            Control0..*
                                            BindingThe codes SHALL be taken from SearchModifierCode
                                            (required to http://hl7.org/fhir/ValueSet/search-modifier-code|3.0.2)

                                            A supported modifier for a search parameter.

                                            Typecode
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            136. SearchParameter.modifier.id
                                            Definition

                                            unique id for the element within a resource (for internal references)

                                            Shortxml:id (or equivalent in JSON)
                                            Control0..1
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            138. SearchParameter.modifier.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            SlicingThis element introduces a set of slices on SearchParameter.modifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 140. SearchParameter.modifier.extension:modifier
                                              Slice Namemodifier
                                              Definition

                                              R4B: SearchParameter.modifier

                                              ShortR4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
                                              Comments

                                              Element SearchParameter.modifier is mapped to FHIR STU3 element SearchParameter.modifier as SourceIsBroaderThanTarget.

                                              Control0..*
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(R4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType) (Extension Type: code)
                                              Is Modifierfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              142. SearchParameter.modifier.value
                                              Definition

                                              Primitive value for code

                                              ShortPrimitive value for code
                                              Control0..1
                                              Typecode
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              144. 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.

                                              ShortChained names supported
                                              Comments

                                              Systems are not required to list all the chain names they support, but if they don't list them, clients may not know to use them.

                                              Control0..*
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              146. SearchParameter.component
                                              Definition

                                              Used to define the parts of a composite search parameter.

                                              ShortFor Composite resources to define the parts
                                              Control0..*
                                              TypeBackboneElement
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                              148. 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.

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              150. SearchParameter.component.extension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element. In order 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.

                                              ShortAdditional 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.

                                              Control0..*
                                              TypeExtension
                                              Alternate Namesextensions, user content
                                              152. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

                                              ShortExtensions 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.

                                              Control0..*
                                              TypeExtension
                                              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                              Summarytrue
                                              Alternate Namesextensions, user content, modifiers
                                              154. SearchParameter.component.definition
                                              Definition

                                              The definition of the search parameter that describes this part.

                                              ShortDefines how the part works
                                              Control1..1
                                              TypeReference(SearchParameter)
                                              156. SearchParameter.component.definition.id
                                              Definition

                                              unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              158. SearchParameter.component.definition.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              SlicingThis element introduces a set of slices on SearchParameter.component.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 160. SearchParameter.component.definition.extension:definition
                                                Slice Namedefinition
                                                Definition

                                                R4B: SearchParameter.component.definition additional types (canonical(http://hl7.org/fhir/StructureDefinition/SearchParameter)) additional types from child elements (value)

                                                ShortR4B: definition additional types
                                                Comments

                                                Element SearchParameter.component.definition is mapped to FHIR STU3 element SearchParameter.component.definition as SourceIsBroaderThanTarget. The mappings for SearchParameter.component.definition do not cover the following types: canonical. The mappings for SearchParameter.component.definition do not cover the following types based on type expansion: value.

                                                Control1..1
                                                TypeExtension(R4B: definition additional types) (Extension Type: uri(Cross-version Profile for R4B.SearchParameter for use in FHIR STU3, SearchParameter))
                                                162. SearchParameter.component.definition.reference
                                                Definition

                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                ShortLiteral reference, Relative, internal or absolute URL
                                                Comments

                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                Control0..1
                                                This element is affected by the following invariants: ref-1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                164. SearchParameter.component.definition.identifier
                                                Definition

                                                An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                ShortLogical reference, when literal reference is not known
                                                Comments

                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..1
                                                TypeIdentifier
                                                Summarytrue
                                                166. SearchParameter.component.definition.display
                                                Definition

                                                Plain text narrative that identifies the resource in addition to the resource reference.

                                                ShortText alternative for the resource
                                                Comments

                                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                168. SearchParameter.component.expression
                                                Definition

                                                A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.

                                                ShortSubexpression 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.

                                                Control1..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension