Data Model Libraries
    Preparing search index...

    Class SearchParameter

    SearchParameter Class

    A search parameter that defines a named search item that can be used to search/filter on a resource.

    FHIR Specification

    • Short: Search parameter for a resource
    • Definition: A search parameter that defines a named search item that can be used to search/filter on a resource.
    • Comment: 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.
    • FHIR Version: 5.0.0

    FHIR SearchParameter

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url identifier? version? versionAlgorithm? name title? derivedFrom? publicationStatusEnum status experimental? date? publisher? contact? description useContext? jurisdiction? purpose? copyright? copyrightLabel? code base searchParamTypeEnum type_ expression? searchProcessingmodeEnum processingMode? constraint? target? multipleOr? multipleAnd? searchComparatorEnum comparator? searchModifierCodeEnum modifier? chain? component?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getVersionAlgorithm setVersionAlgorithm hasVersionAlgorithm getVersionAlgorithmStringType hasVersionAlgorithmStringType getVersionAlgorithmCoding hasVersionAlgorithmCoding getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getDerivedFromElement setDerivedFromElement hasDerivedFromElement getDerivedFrom setDerivedFrom hasDerivedFrom getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getCopyrightLabelElement setCopyrightLabelElement hasCopyrightLabelElement getCopyrightLabel setCopyrightLabel hasCopyrightLabel getCodeElement setCodeElement hasCodeElement getCode setCode hasCode getBaseElement setBaseElement addBaseElement hasBaseElement getBase setBase addBase hasBase getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getExpressionElement setExpressionElement hasExpressionElement getExpression setExpression hasExpression getProcessingModeEnumType setProcessingModeEnumType hasProcessingModeEnumType getProcessingModeElement setProcessingModeElement hasProcessingModeElement getProcessingMode setProcessingMode hasProcessingMode getConstraintElement setConstraintElement hasConstraintElement getConstraint setConstraint hasConstraint getTargetElement setTargetElement addTargetElement hasTargetElement getTarget setTarget addTarget hasTarget getMultipleOrElement setMultipleOrElement hasMultipleOrElement getMultipleOr setMultipleOr hasMultipleOr getMultipleAndElement setMultipleAndElement hasMultipleAndElement getMultipleAnd setMultipleAnd hasMultipleAnd getComparatorEnumType setComparatorEnumType addComparatorEnumType hasComparatorEnumType getComparatorElement setComparatorElement addComparatorElement hasComparatorElement getComparator setComparator addComparator hasComparator getModifierEnumType setModifierEnumType addModifierEnumType hasModifierEnumType getModifierElement setModifierElement addModifierElement hasModifierElement getModifier setModifier addModifier hasModifier getChainElement setChainElement addChainElement hasChainElement getChain setChain addChain hasChain getComponent setComponent addComponent hasComponent fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContact initUseContext initJurisdiction initBase initTarget initComparator initModifier initChain initComponent

    Constructors

    Properties

    url: null | UriType

    SearchParameter.url Element

    FHIR Specification

    • Short: Canonical identifier for this search parameter, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which 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. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • 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).
    • FHIR Type: uri
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    SearchParameter.identifier Element

    FHIR Specification

    • Short: Additional identifier for the search parameter (business identifier)
    • Definition: 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.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    SearchParameter.version Element

    FHIR Specification

    • Short: Business version of the search parameter
    • 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.
    • 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionAlgorithm?: IDataType

    SearchParameter.versionAlgorithm[x] Element

    @ChoiceDataTypesMeta('SearchParameter.versionAlgorithm[x]', ['string','Coding',]

    FHIR Specification

    • Short: How to compare versions
    • Definition: Indicates the mechanism used to compare versions to determine which is more current.
    • Comment: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
    • FHIR Types: 'string', 'Coding',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name: null | StringType

    SearchParameter.name Element

    FHIR Specification

    • Short: Name for this search parameter (computer friendly)
    • 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.
    • 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.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    SearchParameter.title Element

    FHIR Specification

    • Short: Name for this search parameter (human friendly)
    • Definition: 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    derivedFrom?: CanonicalType

    SearchParameter.derivedFrom Element

    FHIR Specification

    • Short: Original definition for the search parameter
    • 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.
    • 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, but detail how it is supported by the server.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    SearchParameter.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: 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.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    SearchParameter.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • 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.
    • Comment: Allows filtering of search parameters that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date?: DateTimeType

    SearchParameter.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: 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.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    SearchParameter.publisher Element

    FHIR Specification

    • Short: Name of the publisher/steward (organization or individual)
    • Definition: 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.
    • Requirements: Helps establish the "authority/credibility" of the search parameter. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    SearchParameter.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: 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.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description: null | MarkdownType

    SearchParameter.description Element

    FHIR Specification

    • Short: Natural language description of the search parameter
    • Definition: 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).
    • FHIR Type: markdown
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    useContext?: UsageContext[]

    SearchParameter.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    SearchParameter.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for search parameter (if applicable)
    • Definition: 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.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    SearchParameter.purpose Element

    FHIR Specification

    • Short: Why this search parameter is defined
    • Definition: 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.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    SearchParameter.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the search parameter and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the search parameter.
    • Comment: ...
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the search parameter and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyrightLabel?: StringType

    SearchParameter.copyrightLabel Element

    FHIR Specification

    • Short: Copyright holder and year(s)
    • Definition: 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.
    • Requirements: Defines the content expected to be rendered in all representations of the artifact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code: null | CodeType

    SearchParameter.code Element

    FHIR Specification

    • Short: Recommended name for parameter in search url
    • Definition: 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.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    base: null | CodeType[]

    SearchParameter.base Element

    FHIR Specification

    • Short: The resource type(s) this search parameter applies to
    • Definition: 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).
    • FHIR Type: code
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true
    searchParamTypeEnum: SearchParamTypeEnum

    FHIR CodeSystem: SearchParamType

    SearchParamTypeEnum

    Privatetype_

    type_: null | EnumCodeType

    SearchParameter.type Element

    FHIR Specification

    • Short: number | date | string | token | reference | composite | quantity | uri | special
    • Definition: The type of value that a search parameter may contain, and how the content is interpreted.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SearchParamTypeEnum

    expression?: StringType

    SearchParameter.expression Element

    FHIR Specification

    • Short: FHIRPath expression that extracts the values
    • Definition: 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 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    searchProcessingmodeEnum: SearchProcessingmodeEnum

    FHIR CodeSystem: SearchProcessingmode

    SearchProcessingmodeEnum

    processingMode?: EnumCodeType

    SearchParameter.processingMode Element

    FHIR Specification

    • Short: normal | phonetic | other
    • Definition: How the search parameter relates to the set of elements returned by evaluating the expression query.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: SearchProcessingmodeEnum

    constraint?: StringType

    SearchParameter.constraint Element

    FHIR Specification

    • Short: FHIRPath expression that constraints the usage of this SearchParamete
    • Definition: FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicable.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    target?: CodeType[]

    SearchParameter.target Element

    FHIR Specification

    • Short: Types of resource (if a resource reference)
    • Definition: 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.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    multipleOr?: BooleanType

    SearchParameter.multipleOr Element

    FHIR Specification

    • Short: Allow multiple values per parameter (or)
    • Definition: Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    multipleAnd?: BooleanType

    SearchParameter.multipleAnd Element

    FHIR Specification

    • Short: Allow multiple parameters (and)
    • Definition: Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    searchComparatorEnum: SearchComparatorEnum

    FHIR CodeSystem: SearchComparator

    SearchComparatorEnum

    comparator?: EnumCodeType[]

    SearchParameter.comparator Element

    FHIR Specification

    • Short: eq | ne | gt | lt | ge | le | sa | eb | ap
    • Definition: Comparators supported for the search parameter.
    • Comment: If no comparators are listed, clients should not expect servers to support any comparators.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: SearchComparatorEnum

    searchModifierCodeEnum: SearchModifierCodeEnum

    FHIR CodeSystem: SearchModifierCode

    SearchModifierCodeEnum

    modifier?: EnumCodeType[]

    SearchParameter.modifier Element

    FHIR Specification

    • Short: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
    • Definition: A modifier supported for the search parameter.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: SearchModifierCodeEnum

    chain?: StringType[]

    SearchParameter.chain Element

    FHIR Specification

    • Short: Chained names supported
    • 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.
    • 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
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    component?: SearchParameterComponentComponent[]

    SearchParameter.component Element

    FHIR Specification

    • Short: For Composite resources to define the parts
    • Definition: Used to define the parts of a composite search parameter.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided SearchParameter JSON to instantiate the SearchParameter data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR SearchParameter

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SearchParameter

      Returns undefined | SearchParameter

      SearchParameter data model or undefined for SearchParameter

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetVersionAlgorithmsetVersionAlgorithmhasVersionAlgorithmgetVersionAlgorithmStringTypehasVersionAlgorithmStringTypegetVersionAlgorithmCodinghasVersionAlgorithmCodinggetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetDerivedFromElementsetDerivedFromElementhasDerivedFromElementgetDerivedFromsetDerivedFromhasDerivedFromgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetCopyrightLabelElementsetCopyrightLabelElementhasCopyrightLabelElementgetCopyrightLabelsetCopyrightLabelhasCopyrightLabelgetCodeElementsetCodeElementhasCodeElementgetCodesetCodehasCodegetBaseElementsetBaseElementaddBaseElementhasBaseElementgetBasesetBaseaddBasehasBasegetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetExpressionElementsetExpressionElementhasExpressionElementgetExpressionsetExpressionhasExpressiongetProcessingModeEnumTypesetProcessingModeEnumTypehasProcessingModeEnumTypegetProcessingModeElementsetProcessingModeElementhasProcessingModeElementgetProcessingModesetProcessingModehasProcessingModegetConstraintElementsetConstraintElementhasConstraintElementgetConstraintsetConstrainthasConstraintgetTargetElementsetTargetElementaddTargetElementhasTargetElementgetTargetsetTargetaddTargethasTargetgetMultipleOrElementsetMultipleOrElementhasMultipleOrElementgetMultipleOrsetMultipleOrhasMultipleOrgetMultipleAndElementsetMultipleAndElementhasMultipleAndElementgetMultipleAndsetMultipleAndhasMultipleAndgetComparatorEnumTypesetComparatorEnumTypeaddComparatorEnumTypehasComparatorEnumTypegetComparatorElementsetComparatorElementaddComparatorElementhasComparatorElementgetComparatorsetComparatoraddComparatorhasComparatorgetModifierEnumTypesetModifierEnumTypeaddModifierEnumTypehasModifierEnumTypegetModifierElementsetModifierElementaddModifierElementhasModifierElementgetModifiersetModifieraddModifierhasModifiergetChainElementsetChainElementaddChainElementhasChainElementgetChainsetChainaddChainhasChaingetComponentsetComponentaddComponenthasComponentfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitContactinitUseContextinitJurisdictioninitBaseinitTargetinitComparatorinitModifierinitChaininitComponent