Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.ObservationDefinition

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

Definition of an observation.

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 = ObservationDefinition;
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 = ObservationDefinition;
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 abnormalCodedValueSet as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "abnormalCodedValueSet", XMLPROJECTION = "ELEMENT");
Reference

Value set of abnormal coded values for the observations conforming to this ObservationDefinition.

ValueSet

Property methods: abnormalCodedValueSetGet(), abnormalCodedValueSetGetSwizzled(), abnormalCodedValueSetIsValid(), abnormalCodedValueSetNewObject(), abnormalCodedValueSetSet()
property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Category of observation.

any FHIR4 code may be used; observation-category shows EXAMPLE codes, but 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 criticalCodedValueSet as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "criticalCodedValueSet", XMLPROJECTION = "ELEMENT");
Reference

Value set of critical coded values for the observations conforming to this ObservationDefinition.

ValueSet

Property methods: criticalCodedValueSetGet(), criticalCodedValueSetGetSwizzled(), criticalCodedValueSetIsValid(), criticalCodedValueSetNewObject(), criticalCodedValueSetSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business identifier for this ObservationDefinition instance.

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

Method used to produce the observation.

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 multipleResultsAllowed as %Boolean (XMLNAME = "multipleResultsAllowed", XMLPROJECTION = "ATTRIBUTE");
boolean

Multiple results allowed.

Property methods: multipleResultsAllowedDisplayToLogical(), multipleResultsAllowedGet(), multipleResultsAllowedIsValid(), multipleResultsAllowedLogicalToDisplay(), multipleResultsAllowedLogicalToXSD(), multipleResultsAllowedNormalize(), multipleResultsAllowedSet(), multipleResultsAllowedXSDToLogical()
property normalCodedValueSet as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "normalCodedValueSet", XMLPROJECTION = "ELEMENT");
Reference

Value set of normal coded values for the observations conforming to this ObservationDefinition.

ValueSet

Property methods: normalCodedValueSetGet(), normalCodedValueSetGetSwizzled(), normalCodedValueSetIsValid(), normalCodedValueSetNewObject(), normalCodedValueSetSet()
property permittedDataType as list of %String (MAXLEN = 1000000, XMLNAME = "permittedDataType", XMLPROJECTION = "ELEMENT");
code

Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period

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

Property methods: permittedDataTypeBuildValueArray(), permittedDataTypeCollectionToDisplay(), permittedDataTypeCollectionToOdbc(), permittedDataTypeDisplayToCollection(), permittedDataTypeDisplayToLogical(), permittedDataTypeGet(), permittedDataTypeGetObject(), permittedDataTypeGetObjectId(), permittedDataTypeGetSwizzled(), permittedDataTypeIsValid(), permittedDataTypeLogicalToDisplay(), permittedDataTypeLogicalToOdbc(), permittedDataTypeNormalize(), permittedDataTypeOdbcToCollection(), permittedDataTypeSet(), permittedDataTypeSetObject(), permittedDataTypeSetObjectId()
property preferredReportName as %String (MAXLEN = 1000000, XMLNAME = "preferredReportName", XMLPROJECTION = "ATTRIBUTE");
string

Preferred report name.

Property methods: preferredReportNameDisplayToLogical(), preferredReportNameGet(), preferredReportNameIsValid(), preferredReportNameLogicalToDisplay(), preferredReportNameLogicalToOdbc(), preferredReportNameNormalize(), preferredReportNameSet()
property qualifiedInterval as list of HS.FHIR.DTL.vR4.Model.Element.ObservationDefinition.qualifiedInterval (XMLNAME = "qualifiedInterval", XMLPROJECTION = "ELEMENT");
BackboneElement

Qualified range for continuous and ordinal observation results.

Property methods: qualifiedIntervalBuildValueArray(), qualifiedIntervalCollectionToDisplay(), qualifiedIntervalCollectionToOdbc(), qualifiedIntervalDisplayToCollection(), qualifiedIntervalGet(), qualifiedIntervalGetObject(), qualifiedIntervalGetObjectId(), qualifiedIntervalGetSwizzled(), qualifiedIntervalIsValid(), qualifiedIntervalOdbcToCollection(), qualifiedIntervalSet(), qualifiedIntervalSetObject(), qualifiedIntervalSetObjectId()
property quantitativeDetails as HS.FHIR.DTL.vR4.Model.Element.ObservationDefinition.quantitativeDetails (XMLNAME = "quantitativeDetails", XMLPROJECTION = "ELEMENT");
BackboneElement

Characteristics of quantitative results.

Property methods: quantitativeDetailsGet(), quantitativeDetailsGetSwizzled(), quantitativeDetailsIsValid(), quantitativeDetailsNewObject(), quantitativeDetailsSet()
property validCodedValueSet as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "validCodedValueSet", XMLPROJECTION = "ELEMENT");
Reference

Value set of valid coded values for the observations conforming to this ObservationDefinition.

ValueSet

Property methods: validCodedValueSetGet(), validCodedValueSetGetSwizzled(), validCodedValueSetIsValid(), validCodedValueSetNewObject(), validCodedValueSetSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab