Skip to main content

HS.FHIR.vSTU3.Model.Resource.Provenance.Entity

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

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 list of HS.FHIR.vSTU3.Model.Resource.Provenance.Agent (XMLNAME = "agent", XMLPROJECTION = "ELEMENT");
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: agentBuildValueArray(), agentCollectionToDisplay(), agentCollectionToOdbc(), agentDisplayToCollection(), agentGet(), agentGetObject(), agentGetObjectId(), agentGetSwizzled(), agentIsValid(), agentOdbcToCollection(), agentSet(), agentSetObject(), agentSetObjectId()
property role as HS.FHIR.vSTU3.Model.Base.ProvenanceEntityRole (XMLNAME = "role", XMLPROJECTION = "ELEMENT") [ Required ];
How the entity was used during the activity.
Property methods: roleGet(), roleGetSwizzled(), roleIsValid(), roleNewObject(), roleSet()
property whatIdentifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "whatIdentifier", XMLPROJECTION = "ELEMENT");
Property methods: whatIdentifierGet(), whatIdentifierGetSwizzled(), whatIdentifierIsValid(), whatIdentifierNewObject(), whatIdentifierSet()
property whatReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "whatReference", XMLPROJECTION = "ELEMENT");
Property methods: whatReferenceGet(), whatReferenceGetSwizzled(), whatReferenceIsValid(), whatReferenceNewObject(), whatReferenceSet()
property whatUri as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "whatUri", XMLPROJECTION = "ELEMENT");
Property methods: whatUriGet(), whatUriGetSwizzled(), whatUriIsValid(), whatUriNewObject(), whatUriSet()

Methods

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 SetWhatIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "whatIdentifier" property.
deprecated method SetWhatReference(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 "whatReference" property.
deprecated method SetWhatUri(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 "whatUri" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab