Observation class

Observation Measurements and simple assertions made about a patient, device or other subject.

Inheritance
Available extensions

Constructors

Observation({FhirString? id, FhirMeta? meta, FhirUri? implicitRules, AllLanguages? language, Narrative? text, List<Resource>? contained, List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<Identifier>? identifier, InstantiatesXObservation? instantiatesX, FhirCanonical? instantiatesCanonical, Reference? instantiatesReference, List<Reference>? basedOn, List<ObservationTriggeredBy>? triggeredBy, List<Reference>? partOf, required ObservationStatus status, List<CodeableConcept>? category, required CodeableConcept code, Reference? subject, List<Reference>? focus, Reference? encounter, EffectiveXObservation? effectiveX, FhirDateTime? effectiveDateTime, Period? effectivePeriod, Timing? effectiveTiming, FhirInstant? effectiveInstant, FhirInstant? issued, List<Reference>? performer, ValueXObservation? valueX, Quantity? valueQuantity, CodeableConcept? valueCodeableConcept, FhirString? valueString, FhirBoolean? valueBoolean, FhirInteger? valueInteger, Range? valueRange, Ratio? valueRatio, SampledData? valueSampledData, FhirTime? valueTime, FhirDateTime? valueDateTime, Period? valuePeriod, Attachment? valueAttachment, Reference? valueReference, CodeableConcept? dataAbsentReason, List<CodeableConcept>? interpretation, List<Annotation>? note, CodeableConcept? bodySite, Reference? bodyStructure, CodeableConcept? method, Reference? specimen, Reference? device, List<ObservationReferenceRange>? referenceRange, List<Reference>? hasMember, List<Reference>? derivedFrom, List<ObservationComponent>? component})
Primary constructor for Observation
const
Observation.fromJson(Map<String, dynamic> json)
Factory constructor that accepts Map<String, dynamic> as an argument
factory
Observation.fromJsonString(String source)
Factory constructor for Observation that takes in a String Convenience method to avoid the json Encoding/Decoding normally required to get data from a String
factory
Observation.fromYaml(dynamic yaml)
Deserialize Observation from a String or YamlMap object
factory

Properties

basedOn → List<Reference>?
basedOn A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
final
bodySite → CodeableConcept?
bodySite Indicates the site on the subject's body where the observation was made (i.e. the target site).
final
bodyStructure → Reference?
bodyStructure Indicates the body structure on the subject's body where the observation was made (i.e. the target site).
final
category → List<CodeableConcept>?
category A code that classifies the general type of observation being made.
final
code → CodeableConcept
code Describes what was observed. Sometimes this is called the observation "name".
final
component → List<ObservationComponent>?
component Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
final
contained → List<Resource>?
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
finalinherited
copyWith → $ObservationCopyWith<Observation>

Available on Observation, provided by the ObservationCopyWithExtension extension

no setter
copyWith → $ObservationCopyWith<Observation>
Copy function for Observation Returns a copy of the current instance with the provided fields modified. If a field is not provided, it will retain its original value. If a null is provided, this will clearn the field, unless the field is required, in which case it will keep its current value.
no setteroverride
dataAbsentReason → CodeableConcept?
dataAbsentReason Provides a reason why the expected value in the element Observation.valuex is missing.
final
derivedFrom → List<Reference>?
derivedFrom The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
final
device → Reference?
device A reference to the device that generates the measurements or the device settings for the device.
final
effectiveDateTime → FhirDateTime?
Getter for effectiveDateTime as a FhirDateTime
no setter
effectiveInstant → FhirInstant?
Getter for effectiveInstant as a FhirInstant
no setter
effectivePeriod → Period?
Getter for effectivePeriod as a Period
no setter
effectiveTiming → Timing?
Getter for effectiveTiming as a Timing
no setter
effectiveX → EffectiveXObservation?
effectiveX The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
final
encounter → Reference?
encounter The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
final
extension_ → List<FhirExtension>?
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.",
finalinherited
fhirType → String
Returns the FHIR type of the object.
no setteroverride
focus → List<Reference>?
focus The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
final
hashCode → int
The hash code for this object.
no setterinherited
hasMember → List<Reference>?
hasMember This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
final
hasPrimitiveValue → bool
Checks if the object has a primitive value.
no setterinherited
id → FhirString?
The logical id of the resource, as used in the URL for the resource.
finalinherited
identifier → List<Identifier>?
identifier A unique identifier assigned to this observation.
final
implicitRules → FhirUri?
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.
finalinherited
instantiatesCanonical → FhirCanonical?
Getter for instantiatesCanonical as a FhirCanonical
no setter
instantiatesReference → Reference?
Getter for instantiatesReference as a Reference
no setter
instantiatesX → InstantiatesXObservation?
instantiatesX The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.
final
interpretation → List<CodeableConcept>?
interpretation A categorical assessment of an observation value. For example, high, low, normal.
final
isMetadataBased → bool
All FhirBases and Resources are NOT metadata based
no setterinherited
isPrimitive → bool
Checks if the object is primitive.
no setterinherited
issued → FhirInstant?
issued The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
final
language → AllLanguages?
The base language in which the resource is written. This should be the language of the text value in the content element when a text value is present.
finalinherited
meta → FhirMeta?
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.
finalinherited
method → CodeableConcept?
method Indicates the mechanism used to perform the observation.
final
modifierExtension → List<FhirExtension>?
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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
finalinherited
note → List<Annotation>?
note Comments about the observation or the results.
final
partOf → List<Reference>?
partOf A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
final
path → String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
performer → List<Reference>?
performer Who was responsible for asserting the observed value as "true".
final
primitiveValue → String?
Retrieves the primitive value of the object.
no setterinherited
referenceRange → List<ObservationReferenceRange>?
referenceRange Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.
final
resourceType → R5ResourceType
The type of resource
finalinherited
resourceTypeString → String
produce a string of the resourceType
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
specimen → Reference?
specimen The specimen that was used when this observation was made.
final
status → ObservationStatus
status The status of the result value.
final
subject → Reference?
subject The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.
final
text → Narrative?
A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
finalinherited
thisReference → Reference
Convenience method to return a Reference referring to that Resource
no setterinherited
triggeredBy → List<ObservationTriggeredBy>?
triggeredBy Identifies the observation(s) that triggered the performance of this observation.
final
valueAttachment → Attachment?
Getter for valueAttachment as a Attachment
no setter
valueBoolean → FhirBoolean?
Getter for valueBoolean as a FhirBoolean
no setter
valueCodeableConcept → CodeableConcept?
Getter for valueCodeableConcept as a CodeableConcept
no setter
valueDateTime → FhirDateTime?
Getter for valueDateTime as a FhirDateTime
no setter
valueInteger → FhirInteger?
Getter for valueInteger as a FhirInteger
no setter
valuePeriod → Period?
Getter for valuePeriod as a Period
no setter
valueQuantity → Quantity?
Getter for valueQuantity as a Quantity
no setter
valueRange → Range?
Getter for valueRange as a Range
no setter
valueRatio → Ratio?
Getter for valueRatio as a Ratio
no setter
valueReference → Reference?
Getter for valueReference as a Reference
no setter
valueSampledData → SampledData?
Getter for valueSampledData as a SampledData
no setter
valueString → FhirString?
Getter for valueString as a FhirString
no setter
valueTime → FhirTime?
Getter for valueTime as a FhirTime
no setter
valueX → ValueXObservation?
valueX The information determined as a result of making the observation, if the information has a simple value.
final

Methods

clone() → Observation
Subclasses must implement the clone method.
override
compareDeepStrings(String? s1, String? s2, bool allowNull) → bool
Checks if the object is equal to another object.
inherited
equalsDeep(FhirBase? o) → bool
Performs a deep comparison between two instances.
override
getChildByName(String name) → FhirBase?
Retrieves a single field value by its name.
override
getChildrenByName(String fieldName, [bool checkValid = false]) → List<FhirBase>
Retrieves all matching child fields by name. Optionally validates the name.
override
hasType(List<String> names) → bool
Checks if the object has a given type.
inherited
hasValues() → bool
Checks if the object has values.
inherited
isAs<T extends FhirBase>() → T?
Returns an Object cast as a Type if it is that type.
inherited
isEmpty() → bool
Checks if the object is empty.
inherited
listChildrenNames() → List<String>
Lists the JSON keys for the object.
override
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
prettyPrint() → String
Converts the object to a pretty JSON string.
inherited
toJson() → Map<String, dynamic>
Returns a Map<String, dynamic> of the DomainResource
override
toJsonString() → String
Converts the object to a JSON string.
inherited
toString() → String
A string representation of this object.
inherited
toYaml() → String
Converts the object to a YAML string.
inherited
updateVersion({FhirMeta? oldMeta, bool versionIdAsTime = false}) → 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