FhirList class
FhirList A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
FhirList({@Default(R5ResourceType.List) @JsonKey(unknownEnumValue: R5ResourceType.List) 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, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirCode? mode, @JsonKey(name: '_mode') Element? modeElement, String? title, @JsonKey(name: '_title') Element? titleElement, CodeableConcept? code, List<Reference> ? subject, Reference? encounter, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, Reference? source, CodeableConcept? orderedBy, List<Annotation> ? note, List<FhirListEntry> ? entry, CodeableConcept? emptyReason}) -
FhirList A List is a curated collection of resources, for things such
as problem lists, allergy lists, facility list, organization list, etc.
constfactory
-
FhirList.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- FhirList.fromJsonString(String source)
-
Acts like a constructor, returns a FhirList, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- FhirList.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- code → CodeableConcept?
-
code This code defines the purpose of the list - why it was created.
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
-
copyWith
→ $FhirListCopyWith<
FhirList> -
no setterinherited
- date → FhirDateTime?
-
date Date list was last reviewed/revised and determined to be
'current'.
no setterinherited
- dateElement → Element?
-
dateElement ("_date") Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- emptyReason → CodeableConcept?
-
emptyReason If the list is empty, why the list is empty.
no setterinherited
- encounter → Reference?
-
encounter The encounter that is the context in which this list was
created.
no setterinherited
-
entry
→ List<
FhirListEntry> ? -
entry Entries in this list.
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 Identifier for the List assigned for business purposes
outside the context of FHIR.
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
- 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
- mode → FhirCode?
-
mode How this list was prepared - whether it is a working list that
is suitable for being maintained on an ongoing basis, or if it
represents a snapshot of a list of items from another source, or
whether it is a prepared list where items may be marked as added,
modified or deleted.
no setterinherited
- modeElement → Element?
-
modeElement ("_mode") Extensions for mode
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
-
note
→ List<
Annotation> ? -
note Comments that apply to the overall list.
no setterinherited
- orderedBy → CodeableConcept?
-
orderedBy What order applies to the items in the list.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a List 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
- source → Reference?
-
source The entity responsible for deciding what the contents of the
list were. Where the list was created by a human, this is the same as
the author of the list.
no setterinherited
- status → FhirCode?
-
status Indicates the current state of this list.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
-
subject
→ List<
Reference> ? -
subject The common subject(s) (or patient(s)) of the resources that
are in the list if there is one (or a set of subjects).
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 label for the list assigned by the author.
no setterinherited
- titleElement → Element?
-
titleElement ("_title") Extensions for title
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