Skip to main content

HS.FHIR.vSTU3.Model.Base.Timing

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
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 = Timing;
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.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property event as list of HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "event", XMLPROJECTION = "ELEMENT");
Identifies specific times when the event occurs.
Property methods: eventBuildValueArray(), eventCollectionToDisplay(), eventCollectionToOdbc(), eventDisplayToCollection(), eventGet(), eventGetObject(), eventGetObjectId(), eventGetSwizzled(), eventIsValid(), eventOdbcToCollection(), eventSet(), eventSetObject(), eventSetObjectId()
property repeat as HS.FHIR.vSTU3.Model.Base.Timing.Repeat (XMLNAME = "repeat", XMLPROJECTION = "ELEMENT");
A set of rules that describe when the event is scheduled.
Property methods: repeatGet(), repeatGetSwizzled(), repeatIsValid(), repeatNewObject(), repeatSet()

Methods

deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText 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.
Set method for the "code" property.
deprecated method SetEvent(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "event" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab