Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Observation

class HS.FHIR.DTL.vR4.Model.Resource.Observation extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Measurements and simple assertions.

Property 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 XMLPROJECTION = ELEMENT;
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.
parameter XMLTYPE = 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 basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Fulfills plan, proposal or order.

CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property bodySite as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
CodeableConcept

Observed body part.

any FHIR4 code may be used; body-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Classification of type of observation.

observation-category is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in observation-category, you may use codes from any ValueSet.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property code as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Type of observation (code / type)

any FHIR4 code may be used; observation-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property component as list of HS.FHIR.DTL.vR4.Model.Element.Observation.component (XMLNAME = "component", XMLPROJECTION = "ELEMENT");
BackboneElement

Component results.

Property methods: componentBuildValueArray(), componentCollectionToDisplay(), componentCollectionToOdbc(), componentDisplayToCollection(), componentGet(), componentGetObject(), componentGetObjectId(), componentGetSwizzled(), componentIsValid(), componentOdbcToCollection(), componentSet(), componentSetObject(), componentSetObjectId()
property dataAbsentReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "dataAbsentReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why the result is missing.

data-absent-reason is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in data-absent-reason, you may formally EXTEND data-absent-reason to add codes to it.

Property methods: dataAbsentReasonGet(), dataAbsentReasonGetSwizzled(), dataAbsentReasonIsValid(), dataAbsentReasonNewObject(), dataAbsentReasonSet()
property derivedFrom as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "derivedFrom", XMLPROJECTION = "ELEMENT");
Reference

Related measurements the observation is made from.

DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence

Property methods: derivedFromBuildValueArray(), derivedFromCollectionToDisplay(), derivedFromCollectionToOdbc(), derivedFromDisplayToCollection(), derivedFromGet(), derivedFromGetObject(), derivedFromGetObjectId(), derivedFromGetSwizzled(), derivedFromIsValid(), derivedFromOdbcToCollection(), derivedFromSet(), derivedFromSetObject(), derivedFromSetObjectId()
property device as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "device", XMLPROJECTION = "ELEMENT");
Reference

(Measurement) Device.

Device | DeviceMetric

Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNewObject(), deviceSet()
property effectiveDateTime as %String (MAXLEN = 1000000, XMLNAME = "effectiveDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

Clinically relevant time/time-period for observation.

Property methods: effectiveDateTimeDisplayToLogical(), effectiveDateTimeGet(), effectiveDateTimeIsValid(), effectiveDateTimeLogicalToDisplay(), effectiveDateTimeLogicalToOdbc(), effectiveDateTimeNormalize(), effectiveDateTimeSet()
property effectiveInstant as %String (MAXLEN = 1000000, XMLNAME = "effectiveInstant", XMLPROJECTION = "ATTRIBUTE");
instant

Clinically relevant time/time-period for observation.

Property methods: effectiveInstantDisplayToLogical(), effectiveInstantGet(), effectiveInstantIsValid(), effectiveInstantLogicalToDisplay(), effectiveInstantLogicalToOdbc(), effectiveInstantNormalize(), effectiveInstantSet()
property effectivePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");
Period

Clinically relevant time/time-period for observation.

Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property effectiveTiming as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "effectiveTiming", XMLPROJECTION = "ELEMENT");
Timing

Clinically relevant time/time-period for observation.

Property methods: effectiveTimingGet(), effectiveTimingGetSwizzled(), effectiveTimingIsValid(), effectiveTimingNewObject(), effectiveTimingSet()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Healthcare event during which this observation is made.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property focus as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "focus", XMLPROJECTION = "ELEMENT");
Reference

What the observation is about, when it is not about the subject of record.

Any FHIR4 Resource may be indicated by this Reference

Property methods: focusBuildValueArray(), focusCollectionToDisplay(), focusCollectionToOdbc(), focusDisplayToCollection(), focusGet(), focusGetObject(), focusGetObjectId(), focusGetSwizzled(), focusIsValid(), focusOdbcToCollection(), focusSet(), focusSetObject(), focusSetObjectId()
property hasMember as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "hasMember", XMLPROJECTION = "ELEMENT");
Reference

Related resource that belongs to the Observation group.

Observation | QuestionnaireResponse | MolecularSequence

Property methods: hasMemberBuildValueArray(), hasMemberCollectionToDisplay(), hasMemberCollectionToOdbc(), hasMemberDisplayToCollection(), hasMemberGet(), hasMemberGetObject(), hasMemberGetObjectId(), hasMemberGetSwizzled(), hasMemberIsValid(), hasMemberOdbcToCollection(), hasMemberSet(), hasMemberSetObject(), hasMemberSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business Identifier for observation.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property interpretation as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "interpretation", XMLPROJECTION = "ELEMENT");
CodeableConcept

High, low, normal, etc.

observation-interpretation is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in observation-interpretation, you may formally EXTEND observation-interpretation to add codes to it.

Property methods: interpretationBuildValueArray(), interpretationCollectionToDisplay(), interpretationCollectionToOdbc(), interpretationDisplayToCollection(), interpretationGet(), interpretationGetObject(), interpretationGetObjectId(), interpretationGetSwizzled(), interpretationIsValid(), interpretationOdbcToCollection(), interpretationSet(), interpretationSetObject(), interpretationSetObjectId()
property issued as %String (MAXLEN = 1000000, XMLNAME = "issued", XMLPROJECTION = "ATTRIBUTE");
instant

Date/Time this version was made available.

Property methods: issuedDisplayToLogical(), issuedGet(), issuedIsValid(), issuedLogicalToDisplay(), issuedLogicalToOdbc(), issuedNormalize(), issuedSet()
property method as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "method", XMLPROJECTION = "ELEMENT");
CodeableConcept

How it was done.

any FHIR4 code may be used; observation-methods shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments about the observation.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property partOf as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Part of referenced event.

MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performer as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Who is responsible for the observation.

Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property referenceRange as list of HS.FHIR.DTL.vR4.Model.Element.Observation.referenceRange (XMLNAME = "referenceRange", XMLPROJECTION = "ELEMENT");
BackboneElement

Provides guide for interpretation.

Property methods: referenceRangeBuildValueArray(), referenceRangeCollectionToDisplay(), referenceRangeCollectionToOdbc(), referenceRangeDisplayToCollection(), referenceRangeGet(), referenceRangeGetObject(), referenceRangeGetObjectId(), referenceRangeGetSwizzled(), referenceRangeIsValid(), referenceRangeOdbcToCollection(), referenceRangeSet(), referenceRangeSetObject(), referenceRangeSetObjectId()
property specimen as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "specimen", XMLPROJECTION = "ELEMENT");
Reference

Specimen used for this observation.

Specimen

Property methods: specimenGet(), specimenGetSwizzled(), specimenIsValid(), specimenNewObject(), specimenSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

registered | preliminary | final | amended +

observation-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend observation-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

Who and/or what the observation is about.

Patient | Group | Device | Location

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property valueBoolean as %Boolean (XMLNAME = "valueBoolean", XMLPROJECTION = "ATTRIBUTE");
boolean

Actual result.

Property methods: valueBooleanDisplayToLogical(), valueBooleanGet(), valueBooleanIsValid(), valueBooleanLogicalToDisplay(), valueBooleanLogicalToXSD(), valueBooleanNormalize(), valueBooleanSet(), valueBooleanXSDToLogical()
property valueCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "valueCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Actual result.

any FHIR4 code from any ValueSet may be used.

Property methods: valueCodeableConceptGet(), valueCodeableConceptGetSwizzled(), valueCodeableConceptIsValid(), valueCodeableConceptNewObject(), valueCodeableConceptSet()
property valueDateTime as %String (MAXLEN = 1000000, XMLNAME = "valueDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

Actual result.

Property methods: valueDateTimeDisplayToLogical(), valueDateTimeGet(), valueDateTimeIsValid(), valueDateTimeLogicalToDisplay(), valueDateTimeLogicalToOdbc(), valueDateTimeNormalize(), valueDateTimeSet()
property valueInteger as %Integer (XMLNAME = "valueInteger", XMLPROJECTION = "ATTRIBUTE");
integer

Actual result.

Property methods: valueIntegerDisplayToLogical(), valueIntegerGet(), valueIntegerIsValid(), valueIntegerLogicalToDisplay(), valueIntegerNormalize(), valueIntegerSet(), valueIntegerXSDToLogical()
property valuePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "valuePeriod", XMLPROJECTION = "ELEMENT");
Period

Actual result.

Property methods: valuePeriodGet(), valuePeriodGetSwizzled(), valuePeriodIsValid(), valuePeriodNewObject(), valuePeriodSet()
property valueQuantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "valueQuantity", XMLPROJECTION = "ELEMENT");
Quantity

Actual result.

Property methods: valueQuantityGet(), valueQuantityGetSwizzled(), valueQuantityIsValid(), valueQuantityNewObject(), valueQuantitySet()
property valueRange as HS.FHIR.DTL.vR4.Model.Datatype.Range (XMLNAME = "valueRange", XMLPROJECTION = "ELEMENT");
Range

Actual result.

Property methods: valueRangeGet(), valueRangeGetSwizzled(), valueRangeIsValid(), valueRangeNewObject(), valueRangeSet()
property valueRatio as HS.FHIR.DTL.vR4.Model.Datatype.Ratio (XMLNAME = "valueRatio", XMLPROJECTION = "ELEMENT");
Ratio

Actual result.

Property methods: valueRatioGet(), valueRatioGetSwizzled(), valueRatioIsValid(), valueRatioNewObject(), valueRatioSet()
property valueSampledData as HS.FHIR.DTL.vR4.Model.Datatype.SampledData (XMLNAME = "valueSampledData", XMLPROJECTION = "ELEMENT");
SampledData

Actual result.

Property methods: valueSampledDataGet(), valueSampledDataGetSwizzled(), valueSampledDataIsValid(), valueSampledDataNewObject(), valueSampledDataSet()
property valueString as %String (MAXLEN = 1000000, XMLNAME = "valueString", XMLPROJECTION = "ATTRIBUTE");
string

Actual result.

Property methods: valueStringDisplayToLogical(), valueStringGet(), valueStringIsValid(), valueStringLogicalToDisplay(), valueStringLogicalToOdbc(), valueStringNormalize(), valueStringSet()
property valueTime as %String (MAXLEN = 1000000, XMLNAME = "valueTime", XMLPROJECTION = "ATTRIBUTE");
time

Actual result.

Property methods: valueTimeDisplayToLogical(), valueTimeGet(), valueTimeIsValid(), valueTimeLogicalToDisplay(), valueTimeLogicalToOdbc(), valueTimeNormalize(), valueTimeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab