HS.FHIR.vSTU3.Model.Resource.Provenance.Agent

deprecated class HS.FHIR.vSTU3.Model.Resource.Provenance.Agent 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

• onBehalfOfReference
• onBehalfOfUri
• relatedAgentType
• role
• whoReference
• whoUri

Method Inventory

• SetOnBehalfOfReference()
• SetOnBehalfOfUri()
• SetRelatedAgentType()
• SetRole()
• SetWhoReference()
• SetWhoUri()

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.Agent;

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.Agent;

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 onBehalfOfReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "onBehalfOfReference", XMLPROJECTION = "ELEMENT");

Property methods: onBehalfOfReferenceGet(), onBehalfOfReferenceGetSwizzled(), onBehalfOfReferenceIsValid(), onBehalfOfReferenceNewObject(), onBehalfOfReferenceSet()

property onBehalfOfUri as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "onBehalfOfUri", XMLPROJECTION = "ELEMENT");

Property methods: onBehalfOfUriGet(), onBehalfOfUriGetSwizzled(), onBehalfOfUriIsValid(), onBehalfOfUriNewObject(), onBehalfOfUriSet()

property relatedAgentType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "relatedAgentType", XMLPROJECTION = "ELEMENT");

The type of relationship between agents.

Property methods: relatedAgentTypeGet(), relatedAgentTypeGetSwizzled(), relatedAgentTypeIsValid(), relatedAgentTypeNewObject(), relatedAgentTypeSet()

property role as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "role", XMLPROJECTION = "ELEMENT");

The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

Property methods: roleBuildValueArray(), roleCollectionToDisplay(), roleCollectionToOdbc(), roleDisplayToCollection(), roleGet(), roleGetObject(), roleGetObjectId(), roleGetSwizzled(), roleIsValid(), roleOdbcToCollection(), roleSet(), roleSetObject(), roleSetObjectId()

property whoReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "whoReference", XMLPROJECTION = "ELEMENT");

Property methods: whoReferenceGet(), whoReferenceGetSwizzled(), whoReferenceIsValid(), whoReferenceNewObject(), whoReferenceSet()

property whoUri as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "whoUri", XMLPROJECTION = "ELEMENT");

Property methods: whoUriGet(), whoUriGetSwizzled(), whoUriIsValid(), whoUriNewObject(), whoUriSet()

Methods

deprecated method SetOnBehalfOfReference(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 "onBehalfOfReference" property.

deprecated method SetOnBehalfOfUri(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 "onBehalfOfUri" property.

deprecated method SetRelatedAgentType(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 "relatedAgentType" property.

deprecated method SetRole(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.
Insert method for the "role" property.

deprecated method SetWhoReference(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 "whoReference" property.

deprecated method SetWhoUri(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 "whoUri" property.

Inherited Members

Inherited Properties

• extension
• id
• modifierExtension

Inherited Methods

• %AddToSaveSet()
• %ClassIsLatestVersion()
• %ClassName()
• %ConstructClone()
• %CreateProxy()
• %DispatchClassMethod()
• %DispatchGetModified()
• %DispatchGetProperty()
• %DispatchMethod()
• %DispatchSetModified()
• %DispatchSetMultidimProperty()
• %DispatchSetProperty()
• %Extends()
• %FHIRObjectHasValue()
• %FromFHIRJSON()
• %FromFHIRXML()
• %GetClassName()
• %GetJSONType()
• %GetParameter()
• %IsA()
• %IsModified()
• %New()
• %NormalizeObject()
• %ObjectModified()
• %OriginalNamespace()
• %PackageName()
• %RemoveFromSaveSet()
• %SerializeObject()
• %SetModified()
• %ToFHIRJSON()
• %ToFHIRXML()
• %ValidateObject()
• GetReferenceMap()
• UpdateReferences()
• XMLDTD()
• XMLExport()
• XMLExportToStream()
• XMLExportToString()
• XMLNew()
• XMLSchema()
• XMLSchemaNamespace()
• XMLSchemaType()