SearchParameter Class Reference


                    
                    
                    resourceType

Search Parameter for a resource.

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

Declaration

Swift

override open class var resourceType: String


                    
                    
                    base

The resource type(s) this search parameter applies to.

Declaration

Swift

public var base: [FHIRString]?


                    
                    
                    chain

Chained names supported.

Declaration

Swift

public var chain: [FHIRString]?


                    
                    
                    code

Code used in URL.

Declaration

Swift

public var code: FHIRString?


                    
                    
                    comparator

Comparators supported for the search parameter.

Declaration

Swift

public var comparator: [SearchComparator]?


                    
                    
                    component

For Composite resources to define the parts.

Declaration

Swift

public var component: [SearchParameterComponent]?


                    
                    
                    contact

Contact details for the publisher.

Declaration

Swift

public var contact: [ContactDetail]?


                    
                    
                    date

Date this was last changed.

Declaration

Swift

public var date: DateTime?


                    
                    
                    derivedFrom

Original Definition for the search parameter.

Declaration

Swift

public var derivedFrom: FHIRURL?


                    
                    
                    description_fhir

Natural language description of the search parameter.

Declaration

Swift

public var description_fhir: FHIRString?


                    
                    
                    experimental

For testing purposes, not real usage.

Declaration

Swift

public var experimental: FHIRBool?


                    
                    
                    expression

FHIRPath expression that extracts the values.

Declaration

Swift

public var expression: FHIRString?


                    
                    
                    jurisdiction

Intended jurisdiction for search parameter (if applicable).

Declaration

Swift

public var jurisdiction: [CodeableConcept]?


                    
                    
                    modifier

A modifier supported for the search parameter.

Declaration

Swift

public var modifier: [SearchModifierCode]?


                    
                    
                    name

Name for this search parameter (computer friendly).

Declaration

Swift

public var name: FHIRString?


                    
                    
                    publisher

Name of the publisher (organization or individual).

Declaration

Swift

public var publisher: FHIRString?


                    
                    
                    purpose

Why this search parameter is defined.

Declaration

Swift

public var purpose: FHIRString?


                    
                    
                    status

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

Declaration

Swift

public var status: PublicationStatus?


                    
                    
                    target

Types of resource (if a resource reference).

Declaration

Swift

public var target: [FHIRString]?


                    
                    
                    type

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

Declaration

Swift

public var type: SearchParamType?

url

Logical URI to reference this search parameter (globally unique).

Declaration

Swift

public var url: FHIRURL?


                    
                    
                    useContext

Context the content is intended to support.

Declaration

Swift

public var useContext: [UsageContext]?


                    
                    
                    version

Business version of the search parameter.

Declaration

Swift

public var version: FHIRString?


                    
                    
                    xpath

XPath that extracts the values.

Declaration

Swift

public var xpath: FHIRString?


                    
                    
                    xpathUsage

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

Declaration

Swift

public var xpathUsage: XPathUsageType?


                    
                    
                    init(base:code:description_fhir:name:status:type:url:)

Convenience initializer, taking all required properties as arguments.

Declaration

Swift

public convenience init(base: [FHIRString], code: FHIRString, description_fhir: FHIRString, name: FHIRString, status: PublicationStatus, type: SearchParamType, url: FHIRURL)


                    
                    
                    populate(from:context:)

Convenience initializer, taking all required properties as arguments.

Declaration

Swift

override open func populate(from json: FHIRJSON, context instCtx: inout FHIRInstantiationContext)


                    
                    
                    decorate(json:errors:)

Undocumented

Declaration

Swift

open class SearchParameter: DomainResource