SearchParameter class
SearchParameter A search parameter that defines a named search item that can be used to search/filter on a resource.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
SearchParameter({@Default(R5ResourceType.SearchParameter) @JsonKey(unknownEnumValue: R5ResourceType.SearchParameter) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? 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, List<Identifier> ? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, String? versionAlgorithmString, @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement, Coding? versionAlgorithmCoding, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, 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, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, String? copyrightLabel, @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement, FhirCanonical? derivedFrom, 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, FhirCode? processingMode, @JsonKey(name: '_processingMode') Element? processingModeElement, String? constraint, @JsonKey(name: '_constraint') Element? constraintElement, 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.
constfactory
-
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 setterinherited
-
baseElement
→ List<
Element> ? -
baseElement ("_base") Extensions for base
no setterinherited
-
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 setterinherited
-
chainElement
→ List<
Element> ? -
chainElement ("_chain") Extensions for chain
no setterinherited
- code → FhirCode?
-
code 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.
no setterinherited
- codeElement → Element?
-
codeElement ("_code") Extensions for code
no setterinherited
-
comparator
→ List<
FhirCode> ? -
comparator Comparators supported for the search parameter.
no setterinherited
-
comparatorElement
→ List<
Element> ? -
comparatorElement ("_comparator") Extensions for comparator
no setterinherited
-
component
→ List<
SearchParameterComponent> ? -
component Used to define the parts of a composite search parameter.
no setterinherited
- constraint → String?
-
constraint FHIRPath expression that defines/sets a complex constraint
for when this SearchParameter is applicable.
no setterinherited
- constraintElement → Element?
-
constraintElement ("_constraint") Extensions for constraint
no setterinherited
-
contact
→ List<
ContactDetail> ? -
contact Contact details to assist a user in finding and communicating
with the publisher.
no setterinherited
-
contained
→ List<
Resource> ? -
contained 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 context/meaning.
no setterinherited
- copyright → FhirMarkdown?
-
copyright 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.
no setterinherited
- copyrightElement → Element?
-
copyrightElement ("_copyright") Extensions for copyright
no setterinherited
- copyrightLabel → String?
-
copyrightLabel 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').
no setterinherited
- copyrightLabelElement → Element?
-
copyrightLabelElement ("_copyrightLabel") Extensions for
copyrightLabel
no setterinherited
-
copyWith
→ $SearchParameterCopyWith<
SearchParameter> -
no setterinherited
- date → FhirDateTime?
-
date 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.
no setterinherited
- dateElement → Element?
-
dateElement ("_date") Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- 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 setterinherited
- description → FhirMarkdown?
-
description And how it used.
no setterinherited
- descriptionElement → Element?
-
descriptionElement ("_description") Extensions for description
no setterinherited
- 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 setterinherited
- experimentalElement → Element?
-
experimentalElement ("_experimental") Extensions for experimental
no setterinherited
- expression → String?
-
expression A FHIRPath expression that returns a set of elements for
the search parameter.
no setterinherited
- expressionElement → Element?
-
expressionElement ("_expression") Extensions for expression
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("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 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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier 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.
no setterinherited
- 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 setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
-
jurisdiction
→ List<
CodeableConcept> ? -
jurisdiction A legal or geographic region in which the search
parameter is intended to be used.
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- 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 setterinherited
-
modifier
→ List<
FhirCode> ? -
modifier A modifier supported for the search parameter.
no setterinherited
-
modifierElement
→ List<
Element> ? -
modifierElement ("_modifier") Extensions for modifier
no setterinherited
-
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 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).
no setterinherited
- 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 setterinherited
- multipleAndElement → Element?
-
multipleAndElement ("_multipleAnd") Extensions for multipleAnd
no setterinherited
- 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 setterinherited
- multipleOrElement → Element?
-
multipleOrElement ("_multipleOr") Extensions for multipleOr
no setterinherited
- 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 setterinherited
- nameElement → Element?
-
nameElement ("_name") Extensions for name
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- processingMode → FhirCode?
-
processingMode How the search parameter relates to the set of
elements returned by evaluating the expression query.
no setterinherited
- processingModeElement → Element?
-
processingModeElement ("_processingMode") Extensions for
processingMode
no setterinherited
- publisher → String?
-
publisher The name of the organization or individual tresponsible for
the release and ongoing maintenance of the search parameter.
no setterinherited
- publisherElement → Element?
-
publisherElement ("_publisher") Extensions for publisher
no setterinherited
- purpose → FhirMarkdown?
-
purpose Explanation of why this search parameter is needed and why it
has been designed as it has.
no setterinherited
- purposeElement → Element?
-
purposeElement ("_purpose") Extensions for purpose
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a SearchParameter resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The status of this search parameter. Enables tracking the
life-cycle of the content.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
-
target
→ List<
FhirCode> ? -
target Types of resource (if a resource is referenced).
no setterinherited
-
targetElement
→ List<
Element> ? -
targetElement ("_target") Extensions for target
no setterinherited
- 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 setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- title → String?
-
title A short, descriptive, user-friendly title for the search
parameter.
no setterinherited
- titleElement → Element?
-
titleElement ("_title") Extensions for title
no setterinherited
- type → FhirCode?
-
type The type of value that a search parameter may contain, and how
the content is interpreted.
no setterinherited
- typeElement → Element?
-
typeElement ("_type") Extensions for type
no setterinherited
- 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 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 setterinherited
- urlElement → Element?
-
urlElement ("_url") Extensions for url
no setterinherited
-
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 setterinherited
- 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 setterinherited
- versionAlgorithmCoding → Coding?
-
versionAlgorithmCoding Indicates the mechanism used to compare
versions to determine which is more current.
no setterinherited
- versionAlgorithmString → String?
-
versionAlgorithmString Indicates the mechanism used to compare
versions to determine which is more current.
no setterinherited
- versionAlgorithmStringElement → Element?
-
versionAlgorithmStringElement ("_versionAlgorithmString") Extensions
for versionAlgorithmString
no setterinherited
- versionElement → Element?
-
versionElement ("_version") Extensions for version
no setterinherited
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
override
-
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