Skip to main content

HS.FHIR.vDSTU2.Model.Resource.Provenance.Entity

deprecated class HS.FHIR.vDSTU2.Model.Resource.Provenance.Entity extends HS.FHIR.vDSTU2.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 = Provenance.Entity;
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.
parameter XMLTYPE = Provenance.Entity;
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 agent as HS.FHIR.vDSTU2.Model.Resource.Provenance.Agent (XMLNAME = "agent");
The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.
Property methods: agentGet(), agentGetSwizzled(), agentIsValid(), agentNewObject(), agentSet()
property display as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "display");
Human-readable description of the entity.
Property methods: displayGet(), displayGetSwizzled(), displayIsValid(), displayNewObject(), displaySet()
property reference as HS.FHIR.vDSTU2.Model.Datatype.Uri (XMLNAME = "reference") [ Required ];
Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
Property methods: referenceGet(), referenceGetSwizzled(), referenceIsValid(), referenceNewObject(), referenceSet()
property role as HS.FHIR.vDSTU2.Model.Base.ProvenanceEntityRole (XMLNAME = "role") [ SqlFieldName = _role , Required ];
How the entity was used during the activity.
Property methods: roleGet(), roleGetSwizzled(), roleIsValid(), roleNewObject(), roleSet()
property type as HS.FHIR.vDSTU2.Model.Base.Coding (XMLNAME = "type") [ Required ];
The type of the entity. If the entity is a resource, then this is a resource type.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

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 SetReference(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 "reference" property.
deprecated method SetRole(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 "role" property.
deprecated method SetType(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.
Set method for the "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab