Observation class
Observation Measurements and simple assertions made about a patient, device or other subject.
- Implemented types
- Annotations
-
- @freezed
Constructors
-
Observation.new({@Default(R5ResourceType.Observation) @JsonKey(unknownEnumValue: R5ResourceType.Observation) R5ResourceType resourceType, FhirId? id, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') PrimitiveElement? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') PrimitiveElement? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCanonical? instantiatesCanonical, @JsonKey(name: '_instantiatesCanonical') PrimitiveElement? instantiatesCanonicalElement, Reference? instantiatesReference, List<Reference> ? basedOn, List<ObservationTriggeredBy> ? triggeredBy, List<Reference> ? partOf, FhirCode? status, @JsonKey(name: '_status') PrimitiveElement? statusElement, List<CodeableConcept> ? category, required CodeableConcept code, Reference? subject, List<Reference> ? focus, Reference? encounter, FhirDateTime? effectiveDateTime, @JsonKey(name: '_effectiveDateTime') PrimitiveElement? effectiveDateTimeElement, Period? effectivePeriod, Timing? effectiveTiming, FhirInstant? effectiveInstant, @JsonKey(name: '_effectiveInstant') PrimitiveElement? effectiveInstantElement, FhirInstant? issued, @JsonKey(name: '_issued') PrimitiveElement? issuedElement, List<Reference> ? performer, Quantity? valueQuantity, CodeableConcept? valueCodeableConcept, String? valueString, @JsonKey(name: '_valueString') PrimitiveElement? valueStringElement, FhirBoolean? valueBoolean, @JsonKey(name: '_valueBoolean') PrimitiveElement? valueBooleanElement, FhirInteger? valueInteger, @JsonKey(name: '_valueInteger') PrimitiveElement? valueIntegerElement, Range? valueRange, Ratio? valueRatio, SampledData? valueSampledData, FhirTime? valueTime, @JsonKey(name: '_valueTime') PrimitiveElement? valueTimeElement, FhirDateTime? valueDateTime, @JsonKey(name: '_valueDateTime') PrimitiveElement? valueDateTimeElement, 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}) -
Observation Measurements and simple assertions made about a patient,
device or other subject.
constfactory
-
Observation.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Observation.fromJsonString(String source)
-
Acts like a constructor, returns a Observation, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Observation.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
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.no setterinherited - bodySite → CodeableConcept?
-
bodySite
Indicates the site on the subject's body where the observation was made (i.e. the target site).no setterinherited - bodyStructure → Reference?
-
bodyStructure
Indicates the body structure on the subject's body where the observation was made (i.e. the target site).no setterinherited -
category
→ List<
CodeableConcept> ? -
category
A code that classifies the general type of observation being made.no setterinherited -
children
→ List<
FhirBase> -
no setterinherited
- code → CodeableConcept
-
code
Describes what was observed. Sometimes this is called the observation "name".no setterinherited -
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.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
→ $ObservationCopyWith<
Observation> -
no setterinherited
- dataAbsentReason → CodeableConcept?
-
dataAbsentReason
Provides a reason why the expected value in the element Observation.valuex
is missing.no setterinherited -
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.no setterinherited - device → Reference?
-
device
A reference to the device that generates the measurements or the device settings for the device.no setterinherited - effectiveDateTime → FhirDateTime?
-
effectiveDateTime
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.no setterinherited - effectiveDateTimeElement → PrimitiveElement?
-
effectiveDateTimeElement
("_effectiveDateTime") Extensions for effectiveDateTimeno setterinherited - effectiveInstant → FhirInstant?
-
effectiveInstant
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.no setterinherited - effectiveInstantElement → PrimitiveElement?
-
effectiveInstantElement
("_effectiveInstant") Extensions for effectiveInstantno setterinherited - effectivePeriod → Period?
-
effectivePeriod
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.no setterinherited - effectiveTiming → Timing?
-
effectiveTiming
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.no setterinherited - encounter → Reference?
-
encounter
The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.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 - fhirType → String
-
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.no setterinherited -
formatCommentsPost
→ List<
String> -
no setterinherited
-
formatCommentsPre
→ List<
String> -
no setterinherited
- 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.no setterinherited - id → FhirId?
-
id
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.no setterinherited -
identifier
→ List<
Identifier> ? -
identifier
A unique identifier assigned to this observation.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 → PrimitiveElement?
-
implicitRulesElement
("_implicitRules") Extensions for implicitRulesno setterinherited - instantiatesCanonical → FhirCanonical?
-
instantiatesCanonical
The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.no setterinherited - instantiatesCanonicalElement → PrimitiveElement?
-
instantiatesCanonicalElement
("_instantiatesCanonical") Extensions for instantiatesCanonicalno setterinherited - instantiatesReference → Reference?
-
instantiatesReference
The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.no setterinherited -
interpretation
→ List<
CodeableConcept> ? -
interpretation
A categorical assessment of an observation value. For example, high, low, normal.no setterinherited - isPrimitive → bool
-
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.no setterinherited - issuedElement → PrimitiveElement?
-
issuedElement
("_issued") Extensions for issuedno setterinherited - language → FhirCode?
-
language
The base language in which the resource is written.no setterinherited - languageElement → PrimitiveElement?
-
languageElement
("_language") Extensions for languageno 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 - method → CodeableConcept?
-
method
Indicates the mechanism used to perform the observation.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 -
namedChildren
→ Map<
String, FhirBase> -
no setterinherited
-
note
→ List<
Annotation> ? -
note
Comments about the observation or the results.no setterinherited -
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.no setterinherited - path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setteroverride
-
performer
→ List<
Reference> ? -
performer
Who was responsible for asserting the observed value as "true".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, tworeferenceRange
elements would be used.no setterinherited - resourceType → R5ResourceType
-
resourceType
This is a Observation resourceno setterinherited - resourceTypeString → String
-
produce a string of the resourceType
no setteroverride
- 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.no setterinherited - status → FhirCode?
-
status
The status of the result value.no setterinherited - statusElement → PrimitiveElement?
-
statusElement
("_status") Extensions for statusno setterinherited - 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), thefocus
element or thecode
itself specifies the actual focus of the observation.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 setteroverride
-
triggeredBy
→ List<
ObservationTriggeredBy> ? -
triggeredBy
Identifies the observation(s) that triggered the performance of this observation.no setterinherited - valueAttachment → Attachment?
-
valueAttachment
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueBoolean → FhirBoolean?
-
valueBoolean
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueBooleanElement → PrimitiveElement?
-
valueBooleanElement
("_valueBoolean") Extensions for valueBooleanno setterinherited - valueCodeableConcept → CodeableConcept?
-
valueCodeableConcept
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueDateTime → FhirDateTime?
-
valueDateTime
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueDateTimeElement → PrimitiveElement?
-
valueDateTimeElement
("_valueDateTime") Extensions for valueDateTimeno setterinherited - valueInteger → FhirInteger?
-
valueInteger
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueIntegerElement → PrimitiveElement?
-
valueIntegerElement
("_valueInteger") Extensions for valueIntegerno setterinherited - valuePeriod → Period?
-
valuePeriod
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueQuantity → Quantity?
-
valueQuantity
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueRange → Range?
-
valueRange
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueRatio → Ratio?
-
valueRatio
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueReference → Reference?
-
valueReference
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueSampledData → SampledData?
-
valueSampledData
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueString → String?
-
valueString
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueStringElement → PrimitiveElement?
-
valueStringElement
("_valueString") Extensions for valueStringno setterinherited - valueTime → FhirTime?
-
valueTime
The information determined as a result of making the observation, if the information has a simple value.no setterinherited - valueTimeElement → PrimitiveElement?
-
valueTimeElement
("_valueTime") Extensions for valueTimeno setterinherited
Methods
-
addAnnotation(
dynamic annotation) → void -
inherited
-
addPropertyChangedListener(
String property, void listener()) → void -
inherited
-
annotations(
Type type) → Iterable -
inherited
-
clearUserData(
String name) → void -
inherited
-
clone(
) → FhirBase -
inherited
-
deepCopy(
) → FhirBase -
inherited
-
getUserData(
String name) → dynamic -
inherited
-
getUserInt(
String name) → int -
inherited
-
getUserString(
String name) → String? -
inherited
-
hasFormatComment(
) → bool -
inherited
-
hasUserData(
String name) → bool -
inherited
-
isEmpty(
) → bool -
inherited
-
isExactly(
FhirBase other) → bool -
inherited
-
matches(
FhirBase other) → bool -
inherited
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
override
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyPropertyChanged(
String property) → void -
inherited
-
primitiveValue(
) → String? -
inherited
-
removeAnnotations(
Type type) → void -
inherited
-
removePropertyChangedListener(
String property, void listener()) → void -
inherited
-
setUserData(
String name, dynamic value) → void -
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
-
toJsonWithType(
) → dynamic -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
tryGetValue(
String key, dynamic value) → bool -
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
override
-
validate(
) → List< String> -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited