Skip to main content

HS.FHIR.vSTU3.Model.Resource.Observation

deprecated class HS.FHIR.vSTU3.Model.Resource.Observation extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Measurements and simple assertions made about a patient, device or other subject.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Observation;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property basedOn as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
A plan, proposal or order that is fulfilled in whole or in part by this event.
Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property bodySite as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
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 list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
A code that classifies the general type of observation being made.
Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
Describes what was observed. Sometimes this is called the observation "name".
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property comment as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "comment", XMLPROJECTION = "ELEMENT");
May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
Property methods: commentGet(), commentGetSwizzled(), commentIsValid(), commentNewObject(), commentSet()
property component as list of HS.FHIR.vSTU3.Model.Resource.Observation.Component (XMLNAME = "component", XMLPROJECTION = "ELEMENT");
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: componentBuildValueArray(), componentCollectionToDisplay(), componentCollectionToOdbc(), componentDisplayToCollection(), componentGet(), componentGetObject(), componentGetObjectId(), componentGetSwizzled(), componentIsValid(), componentOdbcToCollection(), componentSet(), componentSetObject(), componentSetObjectId()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property dataAbsentReason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "dataAbsentReason", XMLPROJECTION = "ELEMENT");
Provides a reason why the expected value in the element Observation.value[x] is missing.
Property methods: dataAbsentReasonGet(), dataAbsentReasonGetSwizzled(), dataAbsentReasonIsValid(), dataAbsentReasonNewObject(), dataAbsentReasonSet()
property device as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "device", XMLPROJECTION = "ELEMENT");
The device used to generate the observation data.
Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNewObject(), deviceSet()
property effectiveDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "effectiveDateTime", XMLPROJECTION = "ELEMENT");
Property methods: effectiveDateTimeGet(), effectiveDateTimeGetSwizzled(), effectiveDateTimeIsValid(), effectiveDateTimeNewObject(), effectiveDateTimeSet()
property effectivePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A unique identifier assigned to this observation.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property interpretation as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "interpretation", XMLPROJECTION = "ELEMENT");
The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
Property methods: interpretationGet(), interpretationGetSwizzled(), interpretationIsValid(), interpretationNewObject(), interpretationSet()
property issued as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "issued", XMLPROJECTION = "ELEMENT");
The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
Property methods: issuedGet(), issuedGetSwizzled(), issuedIsValid(), issuedNewObject(), issuedSet()
property method as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "method", XMLPROJECTION = "ELEMENT");
Indicates the mechanism used to perform the observation.
Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property performer as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Who was responsible for asserting the observed value as "true".
Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property referenceRange as list of HS.FHIR.vSTU3.Model.Resource.Observation.ReferenceRange (XMLNAME = "referenceRange", XMLPROJECTION = "ELEMENT");
Guidance on how to interpret the value by comparison to a normal or recommended range.
Property methods: referenceRangeBuildValueArray(), referenceRangeCollectionToDisplay(), referenceRangeCollectionToOdbc(), referenceRangeDisplayToCollection(), referenceRangeGet(), referenceRangeGetObject(), referenceRangeGetObjectId(), referenceRangeGetSwizzled(), referenceRangeIsValid(), referenceRangeOdbcToCollection(), referenceRangeSet(), referenceRangeSetObject(), referenceRangeSetObjectId()
A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
Property methods: relatedBuildValueArray(), relatedCollectionToDisplay(), relatedCollectionToOdbc(), relatedDisplayToCollection(), relatedGet(), relatedGetObject(), relatedGetObjectId(), relatedGetSwizzled(), relatedIsValid(), relatedOdbcToCollection(), relatedSet(), relatedSetObject(), relatedSetObjectId()
property specimen as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "specimen", XMLPROJECTION = "ELEMENT");
The specimen that was used when this observation was made.
Property methods: specimenGet(), specimenGetSwizzled(), specimenIsValid(), specimenNewObject(), specimenSet()
property status as HS.FHIR.vSTU3.Model.Base.ObservationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of the result value.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property valueAttachment as HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "valueAttachment", XMLPROJECTION = "ELEMENT");
Property methods: valueAttachmentGet(), valueAttachmentGetSwizzled(), valueAttachmentIsValid(), valueAttachmentNewObject(), valueAttachmentSet()
property valueBoolean as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "valueBoolean", XMLPROJECTION = "ELEMENT");
Property methods: valueBooleanGet(), valueBooleanGetSwizzled(), valueBooleanIsValid(), valueBooleanNewObject(), valueBooleanSet()
property valueCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "valueCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: valueCodeableConceptGet(), valueCodeableConceptGetSwizzled(), valueCodeableConceptIsValid(), valueCodeableConceptNewObject(), valueCodeableConceptSet()
property valueDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "valueDateTime", XMLPROJECTION = "ELEMENT");
Property methods: valueDateTimeGet(), valueDateTimeGetSwizzled(), valueDateTimeIsValid(), valueDateTimeNewObject(), valueDateTimeSet()
property valuePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "valuePeriod", XMLPROJECTION = "ELEMENT");
Property methods: valuePeriodGet(), valuePeriodGetSwizzled(), valuePeriodIsValid(), valuePeriodNewObject(), valuePeriodSet()
property valueQuantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "valueQuantity", XMLPROJECTION = "ELEMENT");
Property methods: valueQuantityGet(), valueQuantityGetSwizzled(), valueQuantityIsValid(), valueQuantityNewObject(), valueQuantitySet()
property valueRange as HS.FHIR.vSTU3.Model.Base.Range (XMLNAME = "valueRange", XMLPROJECTION = "ELEMENT");
Property methods: valueRangeGet(), valueRangeGetSwizzled(), valueRangeIsValid(), valueRangeNewObject(), valueRangeSet()
property valueRatio as HS.FHIR.vSTU3.Model.Base.Ratio (XMLNAME = "valueRatio", XMLPROJECTION = "ELEMENT");
Property methods: valueRatioGet(), valueRatioGetSwizzled(), valueRatioIsValid(), valueRatioNewObject(), valueRatioSet()
property valueSampledData as HS.FHIR.vSTU3.Model.Base.SampledData (XMLNAME = "valueSampledData", XMLPROJECTION = "ELEMENT");
Property methods: valueSampledDataGet(), valueSampledDataGetSwizzled(), valueSampledDataIsValid(), valueSampledDataNewObject(), valueSampledDataSet()
property valueString as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "valueString", XMLPROJECTION = "ELEMENT");
Property methods: valueStringGet(), valueStringGetSwizzled(), valueStringIsValid(), valueStringNewObject(), valueStringSet()
property valueTime as HS.FHIR.vSTU3.Model.Datatype.Time (XMLNAME = "valueTime", XMLPROJECTION = "ELEMENT");
Property methods: valueTimeGet(), valueTimeGetSwizzled(), valueTimeIsValid(), valueTimeNewObject(), valueTimeSet()

Methods

deprecated method SetBasedOn(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "basedOn" property.
deprecated method SetBodySite(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "bodySite" property.
deprecated method SetCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "category" property.
deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "code" property.
deprecated method SetComment(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "comment" property.
deprecated method SetContext(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "context" property.
deprecated method SetDataAbsentReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "dataAbsentReason" property.
deprecated method SetDevice(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "device" property.
deprecated method SetEffectiveDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "effectiveDateTime" property.
deprecated method SetEffectivePeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "effectivePeriod" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetInterpretation(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "interpretation" property.
deprecated method SetIssued(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "issued" property.
deprecated method SetMethod(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "method" property.
deprecated method SetPerformer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "performer" property.
deprecated method SetSpecimen(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "specimen" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetValueAttachment(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueAttachment" property.
deprecated method SetValueBoolean(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueBoolean" property.
deprecated method SetValueCodeableConcept(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueCodeableConcept" property.
deprecated method SetValueDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueDateTime" property.
deprecated method SetValuePeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valuePeriod" property.
deprecated method SetValueQuantity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueQuantity" property.
deprecated method SetValueString(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueString" property.
deprecated method SetValueTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "valueTime" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab