import { CodeableConcept } from './CodeableConcept.js';
import { Coding } from './Coding.js';
import { ContactDetail } from './ContactDetail.js';
import { Extension } from './Extension.js';
import { FhirPrimitive } from './FhirPrimitive.js';
import { Identifier } from './Identifier.js';
import { Meta } from './Meta.js';
import { Narrative } from './Narrative.js';
import { Resource } from './Resource.js';
import { SearchParameter_Component } from './SearchParameter_Component.js';
import { UsageContext } from './UsageContext.js';
export interface SearchParameter {
    /**
     * @description The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
     * @comment Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
     * @short Logical id of this artifact
     */
    id?: string;
    /**
     * @description The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
     * @short Metadata about the resource
     */
    meta?: Meta;
    /**
     * @description A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
     * @comment 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 andor specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
     * @short A set of rules under which this content was created
     */
    implicitRules?: FhirPrimitive<string>;
    /**
     * @description The base language in which the resource is written.
     * @comment 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).
     * @short Language of the resource content
     */
    language?: FhirPrimitive<string>;
    /**
     * @description A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
     * @comment Contained resources do not have a 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.
     * @short Text summary of the resource, for human interpretation
     */
    text?: Narrative;
    /**
     * @description These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides contextmeaning.
     * @comment This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
     * @short Contained, inline Resources
     */
    contained?: Resource[];
    /**
     * @description May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
     * @comment 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.
     * @short Additional content defined by implementations
     */
    extension?: Extension[];
    /**
     * @description 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 andor the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
  
  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
     * @comment 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.
     * @short Extensions that cannot be ignored
     */
    modifierExtension?: Extension[];
    /**
     * @description An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.
     * @comment Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred.  Multiple instances may share the same URL if they have a distinct version.
  
  The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author.  Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
  
  In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
     * @short Canonical identifier for this search parameter, represented as a URI (globally unique)
     */
    url: FhirPrimitive<string>;
    /**
     * @description A formal identifier that is used to identify this search parameter when it is represented in other formats, or referenced in a specification, model, design or an instance.
     * @short Additional identifier for the search parameter (business identifier)
     */
    identifier?: Identifier[];
    /**
     * @description 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.
     * @comment There may be different search parameter instances that have the same identifier but different versions.  The version can be appended to the url in a reference to allow a reference to a particular business version of the search parameter with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).
     * @short Business version of the search parameter
     */
    version?: FhirPrimitive<string>;
    /**
     * @choice This is part of the versionAlgorithm[x] choice.
     * @oneOf versionAlgorithmString, versionAlgorithmCoding
     */
    versionAlgorithmString?: FhirPrimitive<string>;
    /**
     * @choice This is part of the versionAlgorithm[x] choice.
     * @oneOf versionAlgorithmString, versionAlgorithmCoding
     */
    versionAlgorithmCoding?: Coding;
    /**
     * @description 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.
     * @comment The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
     * @short Name for this search parameter (computer friendly)
     */
    name: FhirPrimitive<string>;
    /**
     * @description A short, descriptive, user-friendly title for the search parameter.
     * @comment This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
     * @short Name for this search parameter (human friendly)
     */
    title?: FhirPrimitive<string>;
    /**
     * @description 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.
     * @comment 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`](http:hl7.orgfhirSearchParameterObservation-value-quantity), but detail how it is supported by the server.
     * @short Original definition for the search parameter
     */
    derivedFrom?: FhirPrimitive<string>;
    /**
     * @description The status of this search parameter. Enables tracking the life-cycle of the content.
     * @comment Allows filtering of search parameters that are appropriate for use versus not.
  
  See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
     * @short draft | active | retired | unknown
     */
    status: FhirPrimitive<string>;
    /**
     * @description A Boolean value to indicate that this search parameter is authored for testing purposes (or educationevaluationmarketing) and is not intended to be used for genuine usage.
     * @comment Allows filtering of search parameters that are appropriate for use versus not.
     * @short For testing purposes, not real usage
     */
    experimental?: FhirPrimitive<boolean>;
    /**
     * @description The date  (and optionally time) when the search parameter was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
     * @comment The date is often not tracked until the resource is published, but may be present on draft content. 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.
  
  See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
     * @short Date last changed
     */
    date?: FhirPrimitive<string>;
    /**
     * @description The name of the organization or individual tresponsible for the release and ongoing maintenance of the search parameter.
     * @comment 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.
     * @short Name of the publishersteward (organization or individual)
     */
    publisher?: FhirPrimitive<string>;
    /**
     * @description Contact details to assist a user in finding and communicating with the publisher.
     * @comment May be a web site, an email address, a telephone number, etc.
  
  See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
     * @short Contact details for the publisher
     */
    contact?: ContactDetail[];
    /**
     * @description And how it used.
     * @comment This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the search parameter as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the search parameter is presumed to be the predominant language in the place the search parameter was created).
     * @short Natural language description of the search parameter
     */
    description: FhirPrimitive<string>;
    /**
     * @description The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.
     * @comment When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
     * @short The context that the content is intended to support
     */
    useContext?: UsageContext[];
    /**
     * @description A legal or geographic region in which the search parameter is intended to be used.
     * @comment It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended.
  
  DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element.  (I.e. useContext.code indicating http:terminology.hl7.orgCodeSystemusage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
     * @short Intended jurisdiction for search parameter (if applicable)
     */
    jurisdiction?: CodeableConcept[];
    /**
     * @description Explanation of why this search parameter is needed and why it has been designed as it has.
     * @comment 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.
     * @short Why this search parameter is defined
     */
    purpose?: FhirPrimitive<string>;
    /**
     * @description A copyright statement relating to the search parameter andor its contents. Copyright statements are generally legal restrictions on the use and publishing of the search parameter.
     * @comment ...
     * @short Use andor publishing restrictions
     */
    copyright?: FhirPrimitive<string>;
    /**
     * @description A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
     * @comment The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
     * @short Copyright holder and year(s)
     */
    copyrightLabel?: FhirPrimitive<string>;
    /**
     * @description The label that is recommended to be used in the URL or the parameter name in a parameters resource for this search parameter.  In some cases, servers may need to use a different CapabilityStatement searchParam.name to differentiate between multiple SearchParameters that happen to have the same code.
     * @comment For maximum compatibility, use only lowercase ASCII characters. Note that HL7 will never define multiple search parameters with the same code.
     * @short Recommended name for parameter in search url
     */
    code: FhirPrimitive<string>;
    /**
     * @description The base resource type(s) that this search parameter can be used against.
     * @comment 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](http.html#xres-search)).
     * @short The resource type(s) this search parameter applies to
     */
    base: FhirPrimitive<string>[];
    /**
     * @description The type of value that a search parameter may contain, and how the content is interpreted.
     * @short number | date | string | token | reference | composite | quantity | uri | special
     */
    type: FhirPrimitive<string>;
    /**
     * @description A FHIRPath expression that returns a set of elements for the search parameter.
     * @comment 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 andor 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.
     * @short FHIRPath expression that extracts the values
     */
    expression?: FhirPrimitive<string>;
    /**
     * @description How the search parameter relates to the set of elements returned by evaluating the expression query.
     * @short normal | phonetic | other
     */
    processingMode?: FhirPrimitive<string>;
    /**
     * @description FHIRPath expression that definessets a complex constraint for when this SearchParameter is applicable.
     * @short FHIRPath expression that constraints the usage of this SearchParamete
     */
    constraint?: FhirPrimitive<string>;
    /**
     * @description Types of resource (if a resource is referenced).
     * @comment In some cases, targets may exist for a search parameter that do not exist for the specified FHIRPath for all of the resources identified in SearchParameter.base.  For example, the core clinical-encounter search parameter allows both Encounter and EpisodeOfCare as targets, even though not all of the base resources have EpisodeOfCare as a valid target.
  
  However, the list of targets SHOULD cover all targets that might appear that are permitted by the specified FHIRPath.
     * @short Types of resource (if a resource reference)
     */
    target?: FhirPrimitive<string>[];
    /**
     * @description Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
     * @short Allow multiple values per parameter (or)
     */
    multipleOr?: FhirPrimitive<boolean>;
    /**
     * @description Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
     * @short Allow multiple parameters (and)
     */
    multipleAnd?: FhirPrimitive<boolean>;
    /**
     * @description Comparators supported for the search parameter.
     * @comment If no comparators are listed, clients should not expect servers to support any comparators.
     * @short eq | ne | gt | lt | ge | le | sa | eb | ap
     */
    comparator?: FhirPrimitive<string>[];
    /**
     * @description A modifier supported for the search parameter.
     * @short missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
     */
    modifier?: FhirPrimitive<string>[];
    /**
     * @description 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.
     * @comment Notes:
  
   Not all systems will declare chain values.  If no chain values are specified at all, then no presumptions can be made about the degree of chaining support available
   A server may use a single chain value of '' to mean that all reference search types supported can be chained rather than enumerating all chain values
    If a particular reference search parameter is supported, but not subsequent chaining, then just list that search parameter name - e.g. for Patient.practitioner, the chain value would be ```practitioner```
   If a particular reference search parameter is supported with unlimited chaining beneath it, then follow the search parameter name with '.'.  E.g. ```practitioner.```
   If there are specific (not unlimited) chaining paths allowed they can be explicitly enumerated.  E.g. ```practitioner.organization```
     * @short Chained names supported
     */
    chain?: FhirPrimitive<string>[];
    /**
     * @backbone Nested BackboneElement: component [0..*]
     */
    component?: SearchParameter_Component[];
    /**
     * @const Auto-injected fixed value: SearchParameter
     */
    resourceType: "SearchParameter";
}
//# sourceMappingURL=SearchParameter.d.ts.map