Skip to main content

HS.FHIRModel.R4.Coding

class HS.FHIRModel.R4.Coding extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Coding generated class schema
*****************************************
A reference to a code defined by a terminology system.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_CODING;
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 _code as HS.FHIRModel.R4.Element;
Extensions for code
Property methods: _codeGet(), _codeGetSwizzled(), _codeIsValid(), _codeNewObject(), _codeSet()
property _display as HS.FHIRModel.R4.Element;
Extensions for display
Property methods: _displayGet(), _displayGetSwizzled(), _displayIsValid(), _displayNewObject(), _displaySet()
property _system as HS.FHIRModel.R4.Element;
Extensions for system
Property methods: _systemGet(), _systemGetSwizzled(), _systemIsValid(), _systemNewObject(), _systemSet()
property _userSelected as HS.FHIRModel.R4.Element;
Extensions for userSelected
Property methods: _userSelectedGet(), _userSelectedGetSwizzled(), _userSelectedIsValid(), _userSelectedNewObject(), _userSelectedSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property code as %String;
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property display as %String;
A representation of the meaning of the code in the system, following the rules of the system.
Property methods: displayDisplayToLogical(), displayGet(), displayIsValid(), displayLogicalToDisplay(), displayLogicalToOdbc(), displayNormalize(), displaySet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. 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;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property system as %String;
The identification of the code system that defines the meaning of the symbol in the code.
Property methods: systemDisplayToLogical(), systemGet(), systemIsValid(), systemLogicalToDisplay(), systemLogicalToOdbc(), systemNormalize(), systemSet()
property userSelected as %Boolean;
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Property methods: userSelectedDisplayToLogical(), userSelectedGet(), userSelectedIsValid(), userSelectedLogicalToDisplay(), userSelectedLogicalToXSD(), userSelectedNormalize(), userSelectedSet(), userSelectedXSDToLogical()
property version as %String;
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods

method IncludeExtension()
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