Skip to main content

HS.FHIRModel.R4.ObservationDefinition

class HS.FHIRModel.R4.ObservationDefinition extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ObservationDefinition generated class schema
*****************************************
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _multipleResultsAllowed as HS.FHIRModel.R4.Element;
Extensions for multipleResultsAllowed
Property methods: _multipleResultsAllowedGet(), _multipleResultsAllowedGetSwizzled(), _multipleResultsAllowedIsValid(), _multipleResultsAllowedNewObject(), _multipleResultsAllowedSet()
property _permittedDataType as HS.FHIRModel.R4.SeqOfElement;
Extensions for permittedDataType
Property methods: _permittedDataTypeGet(), _permittedDataTypeGetSwizzled(), _permittedDataTypeIsValid(), _permittedDataTypeNewObject(), _permittedDataTypeSet()
property _preferredReportName as HS.FHIRModel.R4.Element;
Extensions for preferredReportName
Property methods: _preferredReportNameGet(), _preferredReportNameGetSwizzled(), _preferredReportNameIsValid(), _preferredReportNameNewObject(), _preferredReportNameSet()
property abnormalCodedValueSet as HS.FHIRModel.R4.Reference;
The set of abnormal coded results for the observation conforming to this ObservationDefinition.
Property methods: abnormalCodedValueSetGet(), abnormalCodedValueSetGetSwizzled(), abnormalCodedValueSetIsValid(), abnormalCodedValueSetNewObject(), abnormalCodedValueSetSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
A code that classifies the general type of observation.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property code as HS.FHIRModel.R4.CodeableConcept [ Required ];
Describes what will be observed. Sometimes this is called the observation "name".
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
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 criticalCodedValueSet as HS.FHIRModel.R4.Reference;
The set of critical coded results for the observation conforming to this ObservationDefinition.
Property methods: criticalCodedValueSetGet(), criticalCodedValueSetGetSwizzled(), criticalCodedValueSetIsValid(), criticalCodedValueSetNewObject(), criticalCodedValueSetSet()
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 identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A unique identifier assigned to this ObservationDefinition artifact.
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 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;
The method or technique 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 multipleResultsAllowed as %Boolean;
Multiple results allowed for observations conforming to this ObservationDefinition.
Property methods: multipleResultsAllowedDisplayToLogical(), multipleResultsAllowedGet(), multipleResultsAllowedIsValid(), multipleResultsAllowedLogicalToDisplay(), multipleResultsAllowedLogicalToXSD(), multipleResultsAllowedNormalize(), multipleResultsAllowedSet(), multipleResultsAllowedXSDToLogical()
property normalCodedValueSet as HS.FHIRModel.R4.Reference;
The set of normal coded results for the observations conforming to this ObservationDefinition.
Property methods: normalCodedValueSetGet(), normalCodedValueSetGetSwizzled(), normalCodedValueSetIsValid(), normalCodedValueSetNewObject(), normalCodedValueSetSet()
property permittedDataType as %String (VALUELIST = ",Quantity,CodeableConcept,string,boolean,integer,Range,Ratio,SampledData,time,dateTime,Period");
The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
Property methods: permittedDataTypeDisplayToLogical(), permittedDataTypeGet(), permittedDataTypeIsValid(), permittedDataTypeLogicalToDisplay(), permittedDataTypeLogicalToOdbc(), permittedDataTypeNormalize(), permittedDataTypeSet()
property preferredReportName as %String;
The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
Property methods: preferredReportNameDisplayToLogical(), preferredReportNameGet(), preferredReportNameIsValid(), preferredReportNameLogicalToDisplay(), preferredReportNameLogicalToOdbc(), preferredReportNameNormalize(), preferredReportNameSet()
Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
Property methods: qualifiedIntervalGet(), qualifiedIntervalGetSwizzled(), qualifiedIntervalIsValid(), qualifiedIntervalNewObject(), qualifiedIntervalSet()
Characteristics for quantitative results of this observation.
Property methods: quantitativeDetailsGet(), quantitativeDetailsGetSwizzled(), quantitativeDetailsIsValid(), quantitativeDetailsNewObject(), quantitativeDetailsSet()
property resourceType as %String [ InitialExpression = "ObservationDefinition" , Required ];
This is a ObservationDefinition resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
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 validCodedValueSet as HS.FHIRModel.R4.Reference;
The set of valid coded results for the observations conforming to this ObservationDefinition.
Property methods: validCodedValueSetGet(), validCodedValueSetGetSwizzled(), validCodedValueSetIsValid(), validCodedValueSetNewObject(), validCodedValueSetSet()

Methods

method IncludeAbnormalCodedValueSet()
method IncludeCategory()
method IncludeCode()
method IncludeContained()
method IncludeCriticalCodedValueSet()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeMethod()
method IncludeModifierExtension()
method IncludeNormalCodedValueSet()
method IncludeQualifiedInterval()
method IncludeQuantitativeDetails()
method IncludeText()
method IncludeValidCodedValueSet()
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
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab