Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.vSTU3.Model.Base.Coding

deprecated class HS.FHIR.vSTU3.Model.Base.Coding extends HS.FHIR.vSTU3.Model.Base.Element

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A reference to a code defined by a terminology system.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, 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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Coding;
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 code as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
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: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property display as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "display", XMLPROJECTION = "ELEMENT");
A representation of the meaning of the code in the system, following the rules of the system.
Property methods: displayGet(), displayGetSwizzled(), displayIsValid(), displayNewObject(), displaySet()
property system as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "system", XMLPROJECTION = "ELEMENT");
The identification of the code system that defines the meaning of the symbol in the code.
Property methods: systemGet(), systemGetSwizzled(), systemIsValid(), systemNewObject(), systemSet()
property userSelected as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "userSelected", XMLPROJECTION = "ELEMENT");
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Property methods: userSelectedGet(), userSelectedGetSwizzled(), userSelectedIsValid(), userSelectedNewObject(), userSelectedSet()
property version as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "version", XMLPROJECTION = "ELEMENT");
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: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method %OnNew(pCode As %String, pDisplay As %String, pSystem 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.
Get new object, populated with specified data.
deprecated method SetCode(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 "code" property.
deprecated method SetDisplay(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 "display" property.
deprecated method SetSystem(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 "system" property.
deprecated method SetUserSelected(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 "userSelected" property.
deprecated method SetVersion(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 "version" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab