HS.FHIRModel.R4.Observation
class HS.FHIRModel.R4.Observation extends HS.FHIRModel.FHIRClassSuper
******************************************* Observation generated class schema
*****************************************
Measurements and simple assertions made about a patient, device or other subject.
Property Inventory
- _effectiveDateTime
- _effectiveInstant
- _implicitRules
- _issued
- _language
- _status
- _valueBoolean
- _valueDateTime
- _valueInteger
- _valueString
- _valueTime
- basedOn
- bodySite
- category
- code
- component
- contained
- dataAbsentReason
- derivedFrom
- device
- effectiveDateTime
- effectiveInstant
- effectivePeriod
- effectiveTiming
- encounter
- extension
- fhirID
- focus
- hasMember
- identifier
- implicitRules
- interpretation
- issued
- language
- meta
- method
- modifierExtension
- note
- partOf
- performer
- referenceRange
- resourceType
- specimen
- status
- subject
- text
- valueBoolean
- valueCodeableConcept
- valueDateTime
- valueInteger
- valuePeriod
- valueQuantity
- valueRange
- valueRatio
- valueSampledData
- valueString
- valueTime
Method Inventory
- IncludeBasedOn()
- IncludeBodySite()
- IncludeCategory()
- IncludeCode()
- IncludeComponent()
- IncludeContained()
- IncludeDataAbsentReason()
- IncludeDerivedFrom()
- IncludeDevice()
- IncludeEffectivePeriod()
- IncludeEffectiveTiming()
- IncludeEncounter()
- IncludeExtension()
- IncludeFocus()
- IncludeHasMember()
- IncludeIdentifier()
- IncludeInterpretation()
- IncludeMeta()
- IncludeMethod()
- IncludeModifierExtension()
- IncludeNote()
- IncludePartOf()
- IncludePerformer()
- IncludeReferenceRange()
- IncludeSpecimen()
- IncludeSubject()
- IncludeText()
- IncludeValueCodeableConcept()
- IncludeValuePeriod()
- IncludeValueQuantity()
- IncludeValueRange()
- IncludeValueRatio()
- IncludeValueSampledData()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_OBSERVATION;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _effectiveDateTime as HS.FHIRModel.R4.Element;
Extensions for effectiveDateTime
Property methods: _effectiveDateTimeGet(), _effectiveDateTimeGetSwizzled(), _effectiveDateTimeIsValid(), _effectiveDateTimeNewObject(), _effectiveDateTimeSet()
property _effectiveInstant as HS.FHIRModel.R4.Element;
Extensions for effectiveInstant
Property methods: _effectiveInstantGet(), _effectiveInstantGetSwizzled(), _effectiveInstantIsValid(), _effectiveInstantNewObject(), _effectiveInstantSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _issued as HS.FHIRModel.R4.Element;
Extensions for issued
Property methods: _issuedGet(), _issuedGetSwizzled(), _issuedIsValid(), _issuedNewObject(), _issuedSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _valueBoolean as HS.FHIRModel.R4.Element;
Extensions for valueBoolean
Property methods: _valueBooleanGet(), _valueBooleanGetSwizzled(), _valueBooleanIsValid(), _valueBooleanNewObject(), _valueBooleanSet()
property _valueDateTime as HS.FHIRModel.R4.Element;
Extensions for valueDateTime
Property methods: _valueDateTimeGet(), _valueDateTimeGetSwizzled(), _valueDateTimeIsValid(), _valueDateTimeNewObject(), _valueDateTimeSet()
property _valueInteger as HS.FHIRModel.R4.Element;
Extensions for valueInteger
Property methods: _valueIntegerGet(), _valueIntegerGetSwizzled(), _valueIntegerIsValid(), _valueIntegerNewObject(), _valueIntegerSet()
property _valueString as HS.FHIRModel.R4.Element;
Extensions for valueString
Property methods: _valueStringGet(), _valueStringGetSwizzled(), _valueStringIsValid(), _valueStringNewObject(), _valueStringSet()
property _valueTime as HS.FHIRModel.R4.Element;
Extensions for valueTime
Property methods: _valueTimeGet(), _valueTimeGetSwizzled(), _valueTimeIsValid(), _valueTimeNewObject(), _valueTimeSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property bodySite as HS.FHIRModel.R4.CodeableConcept;
Indicates the site on the subject's body where the observation was
made (i.e. the target site).
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
A code that classifies the general type of observation being made.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property code as HS.FHIRModel.R4.CodeableConcept [ Required ];
Describes what was observed. Sometimes this is called the observation
"name".
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property component as HS.FHIRModel.R4.ObservationX.SeqOfObservationXComponent;
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.
Property methods: componentGet(), componentGetSwizzled(), componentIsValid(), componentNewObject(), componentSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property dataAbsentReason as HS.FHIRModel.R4.CodeableConcept;
Provides a reason why the expected value in the element Observation.value[x]
is missing.
Property methods: dataAbsentReasonGet(), dataAbsentReasonGetSwizzled(), dataAbsentReasonIsValid(), dataAbsentReasonNewObject(), dataAbsentReasonSet()
property derivedFrom as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: derivedFromGet(), derivedFromGetSwizzled(), derivedFromIsValid(), derivedFromNewObject(), derivedFromSet()
property device as HS.FHIRModel.R4.Reference;
The device used to generate the observation data.
Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNewObject(), deviceSet()
property effectiveDateTime as %String;
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.
Property methods: effectiveDateTimeDisplayToLogical(), effectiveDateTimeGet(), effectiveDateTimeIsValid(), effectiveDateTimeLogicalToDisplay(), effectiveDateTimeLogicalToOdbc(), effectiveDateTimeNormalize(), effectiveDateTimeSet()
property effectiveInstant as %String;
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.
Property methods: effectiveInstantDisplayToLogical(), effectiveInstantGet(), effectiveInstantIsValid(), effectiveInstantLogicalToDisplay(), effectiveInstantLogicalToOdbc(), effectiveInstantNormalize(), effectiveInstantSet()
property effectivePeriod as HS.FHIRModel.R4.Period;
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.
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property effectiveTiming as HS.FHIRModel.R4.Timing;
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.
Property methods: effectiveTimingGet(), effectiveTimingGetSwizzled(), effectiveTimingIsValid(), effectiveTimingNewObject(), effectiveTimingSet()
property encounter as HS.FHIRModel.R4.Reference;
The healthcare event (e.g. a patient and healthcare provider interaction)
during which this observation is made.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property focus as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: focusGet(), focusGetSwizzled(), focusIsValid(), focusNewObject(), focusSet()
property hasMember as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: hasMemberGet(), hasMemberGetSwizzled(), hasMemberIsValid(), hasMemberNewObject(), hasMemberSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A unique identifier assigned to this observation.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property interpretation as HS.FHIRModel.R4.SeqOfCodeableConcept;
A categorical assessment of an observation value. For example, high,
low, normal.
Property methods: interpretationGet(), interpretationGetSwizzled(), interpretationIsValid(), interpretationNewObject(), interpretationSet()
property issued as %String;
The date and time this version of the observation was made available
to providers, typically after the results have been reviewed and
verified.
Property methods: issuedDisplayToLogical(), issuedGet(), issuedIsValid(), issuedLogicalToDisplay(), issuedLogicalToOdbc(), issuedNormalize(), issuedSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property method as HS.FHIRModel.R4.CodeableConcept;
Indicates the mechanism used to perform the observation.
Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property note as HS.FHIRModel.R4.SeqOfAnnotation;
Comments about the observation or the results.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
A larger event of which this particular Observation is a component
or step. For example, an observation as part of a procedure.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property performer as HS.FHIRModel.R4.SeqOfReference;
Who was responsible for asserting the observed value as "true".
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property referenceRange as HS.FHIRModel.R4.ObservationX.SeqOfObservationXReferenceRange;
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.
Property methods: referenceRangeGet(), referenceRangeGetSwizzled(), referenceRangeIsValid(), referenceRangeNewObject(), referenceRangeSet()
property resourceType as %String [ InitialExpression = "Observation" , Required ];
This is a Observation resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property specimen as HS.FHIRModel.R4.Reference;
The specimen that was used when this observation was made.
Property methods: specimenGet(), specimenGetSwizzled(), specimenIsValid(), specimenNewObject(), specimenSet()
property status as %String (VALUELIST = ",registered,preliminary,final,amended,corrected,cancelled,entered-in-error,unknown");
The status of the result value.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference;
The patient, or group of patients, location, or device this observation
is about and into whose 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.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property valueBoolean as %Boolean;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueBooleanDisplayToLogical(), valueBooleanGet(), valueBooleanIsValid(), valueBooleanLogicalToDisplay(), valueBooleanLogicalToXSD(), valueBooleanNormalize(), valueBooleanSet(), valueBooleanXSDToLogical()
property valueCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueCodeableConceptGet(), valueCodeableConceptGetSwizzled(), valueCodeableConceptIsValid(), valueCodeableConceptNewObject(), valueCodeableConceptSet()
property valueDateTime as %String;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueDateTimeDisplayToLogical(), valueDateTimeGet(), valueDateTimeIsValid(), valueDateTimeLogicalToDisplay(), valueDateTimeLogicalToOdbc(), valueDateTimeNormalize(), valueDateTimeSet()
property valueInteger as %Integer;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueIntegerDisplayToLogical(), valueIntegerGet(), valueIntegerIsValid(), valueIntegerLogicalToDisplay(), valueIntegerNormalize(), valueIntegerSet(), valueIntegerXSDToLogical()
property valuePeriod as HS.FHIRModel.R4.Period;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valuePeriodGet(), valuePeriodGetSwizzled(), valuePeriodIsValid(), valuePeriodNewObject(), valuePeriodSet()
property valueQuantity as HS.FHIRModel.R4.Quantity;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueQuantityGet(), valueQuantityGetSwizzled(), valueQuantityIsValid(), valueQuantityNewObject(), valueQuantitySet()
property valueRange as HS.FHIRModel.R4.Range;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueRangeGet(), valueRangeGetSwizzled(), valueRangeIsValid(), valueRangeNewObject(), valueRangeSet()
property valueRatio as HS.FHIRModel.R4.Ratio;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueRatioGet(), valueRatioGetSwizzled(), valueRatioIsValid(), valueRatioNewObject(), valueRatioSet()
property valueSampledData as HS.FHIRModel.R4.SampledData;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueSampledDataGet(), valueSampledDataGetSwizzled(), valueSampledDataIsValid(), valueSampledDataNewObject(), valueSampledDataSet()
property valueString as %String;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueStringDisplayToLogical(), valueStringGet(), valueStringIsValid(), valueStringLogicalToDisplay(), valueStringLogicalToOdbc(), valueStringNormalize(), valueStringSet()
property valueTime as %String;
The information determined as a result of making the observation,
if the information has a simple value.
Property methods: valueTimeDisplayToLogical(), valueTimeGet(), valueTimeIsValid(), valueTimeLogicalToDisplay(), valueTimeLogicalToOdbc(), valueTimeNormalize(), valueTimeSet()
Methods
method IncludeBasedOn()
method IncludeBodySite()
method IncludeCategory()
method IncludeCode()
method IncludeComponent()
method IncludeContained()
method IncludeDataAbsentReason()
method IncludeDerivedFrom()
method IncludeDevice()
method IncludeEffectivePeriod()
method IncludeEffectiveTiming()
method IncludeEncounter()
method IncludeExtension()
method IncludeFocus()
method IncludeHasMember()
method IncludeIdentifier()
method IncludeInterpretation()
method IncludeMeta()
method IncludeMethod()
method IncludeModifierExtension()
method IncludeNote()
method IncludePartOf()
method IncludePerformer()
method IncludeReferenceRange()
method IncludeSpecimen()
method IncludeSubject()
method IncludeText()
method IncludeValueCodeableConcept()
method IncludeValuePeriod()
method IncludeValueQuantity()
method IncludeValueRange()
method IncludeValueRatio()
method IncludeValueSampledData()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Observation
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()