SearchParameter class

SearchParameter A search parameter that defines a named search item

Mixed in types

• Resource

Annotations

• @freezed

Constructors

SearchParameter({@Default(R4ResourceType.SearchParameter) @JsonKey(unknownEnumValue: R4ResourceType.SearchParameter) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, String? version, @JsonKey(name: '_version') Element? versionElement, String? name, @JsonKey(name: '_name') Element? nameElement, FhirCanonical? derivedFrom, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail>? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext>? useContext, List<CodeableConcept>? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, FhirCode? code, @JsonKey(name: '_code') Element? codeElement, List<FhirCode>? base, @JsonKey(name: '_base') List<Element?>? baseElement, FhirCode? type, @JsonKey(name: '_type') Element? typeElement, String? expression, @JsonKey(name: '_expression') Element? expressionElement, String? xpath, @JsonKey(name: '_xpath') Element? xpathElement, FhirCode? xpathUsage, @JsonKey(name: '_xpathUsage') Element? xpathUsageElement, List<FhirCode>? target, @JsonKey(name: '_target') List<Element?>? targetElement, FhirBoolean? multipleOr, @JsonKey(name: '_multipleOr') Element? multipleOrElement, FhirBoolean? multipleAnd, @JsonKey(name: '_multipleAnd') Element? multipleAndElement, List<FhirCode>? comparator, @JsonKey(name: '_comparator') List<Element?>? comparatorElement, List<FhirCode>? modifier, @JsonKey(name: '_modifier') List<Element?>? modifierElement, List<String>? chain, @JsonKey(name: '_chain') List<Element?>? chainElement, List<SearchParameterComponent>? component})

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

const

factory

SearchParameter.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

SearchParameter.fromJsonString(String source)

Acts like a constructor, returns a SearchParameter, accepts a String as an argument, mostly because I got tired of typing it out

factory

SearchParameter.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

base → List<FhirCode>?

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

no setter, inherited

baseElement → List<Element?>?

baseElement Extensions for base

no setter, inherited

chain → List<String>?

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

no setter, inherited

chainElement → List<Element?>?

chainElement Extensions for chain

no setter, inherited

code → FhirCode?

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

no setter, inherited

codeElement → Element?

codeElement Extensions for code

no setter, inherited

comparator → List<FhirCode>?

comparator Comparators supported for the search parameter.

no setter, inherited

comparatorElement → List<Element?>?

comparatorElement Extensions for comparator

no setter, inherited

component → List<SearchParameterComponent>?

component Used to define the parts of a composite search parameter.

no setter, inherited

contact → List<ContactDetail>?

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

no setter, inherited

contained → List<Resource>?

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

no setter, inherited

copyWith → $SearchParameterCopyWith<SearchParameter>

no setter, inherited

date → FhirDateTime?

date The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

no setter, inherited

dateElement → Element?

dateElement Extensions for date

no setter, inherited

dbId → int?

no setter, inherited

derivedFrom → FhirCanonical?

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

no setter, inherited

description → FhirMarkdown?

description And how it used.

no setter, inherited

descriptionElement → Element?

descriptionElement Extensions for description

no setter, inherited

experimental → FhirBoolean?

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

no setter, inherited

experimentalElement → Element?

experimentalElement Extensions for experimental

no setter, inherited

expression → String?

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

no setter, inherited

expressionElement → Element?

expressionElement Extensions for expression

no setter, inherited

extension_ → List<FhirExtension>?

extension_ May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

no setter, inherited

fhirId → String?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

implicitRules → FhirUri?

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

no setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

jurisdiction → List<CodeableConcept>?

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

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

meta → FhirMeta?

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

no setter, inherited

modifier → List<FhirCode>?

modifier A modifier supported for the search parameter.

no setter, inherited

modifierElement → List<Element?>?

modifierElement Extensions for modifier

no setter, inherited

modifierExtension → List<FhirExtension>?

modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

no setter, inherited

multipleAnd → FhirBoolean?

multipleAnd Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

no setter, inherited

multipleAndElement → Element?

multipleAndElement Extensions for multipleAnd

no setter, inherited

multipleOr → FhirBoolean?

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

no setter, inherited

multipleOrElement → Element?

multipleOrElement Extensions for multipleOr

no setter, inherited

name → String?

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

no setter, inherited

nameElement → Element?

nameElement Extensions for name

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

publisher → String?

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

no setter, inherited

publisherElement → Element?

publisherElement Extensions for publisher

no setter, inherited

purpose → FhirMarkdown?

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

no setter, inherited

purposeElement → Element?

purposeElement Extensions for purpose

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FhirCode?

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

no setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

target → List<FhirCode>?

target Types of resource (if a resource is referenced).

no setter, inherited

targetElement → List<Element?>?

targetElement Extensions for target

no setter, inherited

text → Narrative?

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

no setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

type → FhirCode?

type The type of value that a search parameter may contain, and how the content is interpreted.

no setter, inherited

typeElement → Element?

typeElement Extensions for type

no setter, inherited

url → FhirUri?

url An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.

no setter, inherited

urlElement → Element?

urlElement Extensions for url

no setter, inherited

useContext → List<UsageContext>?

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

no setter, inherited

version → String?

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

no setter, inherited

versionElement → Element?

versionElement Extensions for version

no setter, inherited

xpath → String?

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

no setter, inherited

xpathElement → Element?

xpathElement Extensions for xpath

no setter, inherited

xpathUsage → FhirCode?

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

no setter, inherited

xpathUsageElement → Element?

xpathUsageElement Extensions for xpathUsage

no setter, inherited

Methods

newId() → Resource

returns the same resource with a new ID (even if there is already an ID present)

inherited

newIdIfNoId() → Resource

returns the same resource with a new ID if there is no current ID

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDbJson() → Map<String, dynamic>

The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids

inherited

toJson() → Map<String, dynamic>

inherited

toJsonString() → String

Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map

override

toString() → String

A string representation of this object.

inherited

toYaml() → String

Produces a Yaml formatted String version of the object

inherited

updateVersion({FhirMeta? oldMeta}) → Resource

Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited