Skip to main content

HS.FHIR.vSTU3.Model.Base.RelatedArtifact

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Related artifacts such as additional documentation, justification, or bibliographic references.
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 = RelatedArtifact;
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 citation as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "citation", XMLPROJECTION = "ELEMENT");
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Property methods: citationGet(), citationGetSwizzled(), citationIsValid(), citationNewObject(), citationSet()
property display as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "display", XMLPROJECTION = "ELEMENT");
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Property methods: displayGet(), displayGetSwizzled(), displayIsValid(), displayNewObject(), displaySet()
property document as HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "document", XMLPROJECTION = "ELEMENT");
The document being referenced, represented as an attachment. This is exclusive with the resource element.
Property methods: documentGet(), documentGetSwizzled(), documentIsValid(), documentNewObject(), documentSet()
property resource as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "resource", XMLPROJECTION = "ELEMENT");
The related resource, such as a library, value set, profile, or other knowledge resource.
Property methods: resourceGet(), resourceGetSwizzled(), resourceIsValid(), resourceNewObject(), resourceSet()
property type as HS.FHIR.vSTU3.Model.Base.RelatedArtifactType (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
The type of relationship to the related artifact.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT");
A url for the artifact that can be followed to access the actual content.
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()

Methods

deprecated method SetCitation(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 "citation" 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 SetDocument(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation 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 "document" property.
deprecated method SetResource(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "resource" property.
deprecated method SetType(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 "type" property.
deprecated method SetUrl(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 "url" property.

Inherited Members

Inherited Properties

Inherited Methods

Feedback