Skip to main content

HS.FHIR.vSTU3.Model.Resource.Provenance

deprecated class HS.FHIR.vSTU3.Model.Resource.Provenance extends HS.FHIR.vSTU3.Model.Base.DomainResource

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.
If the element is present, it must have either a @value, an @id, 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 XMLNAME = Provenance;
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 activity as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "activity", XMLPROJECTION = "ELEMENT");
An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
Property methods: activityGet(), activityGetSwizzled(), activityIsValid(), activityNewObject(), activitySet()
property agent as list of HS.FHIR.vSTU3.Model.Resource.Provenance.Agent (XMLNAME = "agent", XMLPROJECTION = "ELEMENT");
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
Property methods: agentBuildValueArray(), agentCollectionToDisplay(), agentCollectionToOdbc(), agentDisplayToCollection(), agentGet(), agentGetObject(), agentGetObjectId(), agentGetSwizzled(), agentIsValid(), agentOdbcToCollection(), agentSet(), agentSetObject(), agentSetObjectId()
property entity as list of HS.FHIR.vSTU3.Model.Resource.Provenance.Entity (XMLNAME = "entity", XMLPROJECTION = "ELEMENT");
An entity used in this activity.
Property methods: entityBuildValueArray(), entityCollectionToDisplay(), entityCollectionToOdbc(), entityDisplayToCollection(), entityGet(), entityGetObject(), entityGetObjectId(), entityGetSwizzled(), entityIsValid(), entityOdbcToCollection(), entitySet(), entitySetObject(), entitySetObjectId()
property location as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Where the activity occurred, if relevant.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
The period during which the activity occurred.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property policy as list of HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "policy", XMLPROJECTION = "ELEMENT");
Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
Property methods: policyBuildValueArray(), policyCollectionToDisplay(), policyCollectionToOdbc(), policyDisplayToCollection(), policyGet(), policyGetObject(), policyGetObjectId(), policyGetSwizzled(), policyIsValid(), policyOdbcToCollection(), policySet(), policySetObject(), policySetObjectId()
property reason as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
The reason that the activity was taking place.
Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property recorded as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "recorded", XMLPROJECTION = "ELEMENT") [ Required ];
The instant of time at which the activity was recorded.
Property methods: recordedGet(), recordedGetSwizzled(), recordedIsValid(), recordedNewObject(), recordedSet()
property signature as list of HS.FHIR.vSTU3.Model.Base.Signature (XMLNAME = "signature", XMLPROJECTION = "ELEMENT");
A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
Property methods: signatureBuildValueArray(), signatureCollectionToDisplay(), signatureCollectionToOdbc(), signatureDisplayToCollection(), signatureGet(), signatureGetObject(), signatureGetObjectId(), signatureGetSwizzled(), signatureIsValid(), signatureOdbcToCollection(), signatureSet(), signatureSetObject(), signatureSetObjectId()
property target as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "target", XMLPROJECTION = "ELEMENT");
The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
Property methods: targetBuildValueArray(), targetCollectionToDisplay(), targetCollectionToOdbc(), targetDisplayToCollection(), targetGet(), targetGetObject(), targetGetObjectId(), targetGetSwizzled(), targetIsValid(), targetOdbcToCollection(), targetSet(), targetSetObject(), targetSetObjectId()

Methods

deprecated method SetActivity(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 "activity" property.
deprecated method SetLocation(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 "location" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetPolicy(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 "policy" property.
deprecated method SetReason(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.
Insert method for the "reason" property.
deprecated method SetRecorded(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 "recorded" property.
deprecated method SetTarget(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "target" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab