Skip to main content

HS.FHIR.DTL.vSTU3.Model.Element.AuditEvent.agent

class HS.FHIR.DTL.vSTU3.Model.Element.AuditEvent.agent extends HS.FHIR.DTL.vSTU3.Model.Base.BackboneElement

Actor involved in the event.

Property 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 = AuditEvent.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 XMLPROJECTION = ELEMENT;
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 = AuditEvent.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 altId as %String (MAXLEN = 1000000, XMLNAME = "altId", XMLPROJECTION = "ATTRIBUTE");
string

Alternative User id e.g. authentication.

Property methods: altIdDisplayToLogical(), altIdGet(), altIdIsValid(), altIdLogicalToDisplay(), altIdLogicalToOdbc(), altIdNormalize(), altIdSet()
property location as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Where.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property media as HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "media", XMLPROJECTION = "ELEMENT");
Coding

Type of media.

dicm-405-mediatype is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in dicm-405-mediatype, you may formally EXTEND dicm-405-mediatype to add codes to it.

Property methods: mediaGet(), mediaGetSwizzled(), mediaIsValid(), mediaNewObject(), mediaSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Human-meaningful name for the agent.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property network as HS.FHIR.DTL.vSTU3.Model.Element.AuditEvent.agent.network (XMLNAME = "network", XMLPROJECTION = "ELEMENT");
BackboneElement

Logical network location for application activity.

Property methods: networkGet(), networkGetSwizzled(), networkIsValid(), networkNewObject(), networkSet()
property policy as list of %String (MAXLEN = 1000000, XMLNAME = "policy", XMLPROJECTION = "ELEMENT");
uri

Policy that authorized event.

Property methods: policyBuildValueArray(), policyCollectionToDisplay(), policyCollectionToOdbc(), policyDisplayToCollection(), policyDisplayToLogical(), policyGet(), policyGetObject(), policyGetObjectId(), policyGetSwizzled(), policyIsValid(), policyLogicalToDisplay(), policyLogicalToOdbc(), policyNormalize(), policyOdbcToCollection(), policySet(), policySetObject(), policySetObjectId()
property purposeOfUse as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "purposeOfUse", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason given for this user.

v3-PurposeOfUse is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in v3-PurposeOfUse, you may formally EXTEND v3-PurposeOfUse to add codes to it.

Property methods: purposeOfUseBuildValueArray(), purposeOfUseCollectionToDisplay(), purposeOfUseCollectionToOdbc(), purposeOfUseDisplayToCollection(), purposeOfUseGet(), purposeOfUseGetObject(), purposeOfUseGetObjectId(), purposeOfUseGetSwizzled(), purposeOfUseIsValid(), purposeOfUseOdbcToCollection(), purposeOfUseSet(), purposeOfUseSetObject(), purposeOfUseSetObjectId()
property reference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "reference", XMLPROJECTION = "ELEMENT");
Reference

Direct reference to resource.

Practitioner | Organization | Device | Patient | RelatedPerson

Property methods: referenceGet(), referenceGetSwizzled(), referenceIsValid(), referenceNewObject(), referenceSet()
property requestor as %Boolean (XMLNAME = "requestor", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Whether user is initiator.

Property methods: requestorDisplayToLogical(), requestorGet(), requestorIsValid(), requestorLogicalToDisplay(), requestorLogicalToXSD(), requestorNormalize(), requestorSet(), requestorXSDToLogical()
property role as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "role", XMLPROJECTION = "ELEMENT");
CodeableConcept

Agent role in the event.

security-role-type is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in security-role-type, you may formally EXTEND security-role-type to add codes to it.

Property methods: roleBuildValueArray(), roleCollectionToDisplay(), roleCollectionToOdbc(), roleDisplayToCollection(), roleGet(), roleGetObject(), roleGetObjectId(), roleGetSwizzled(), roleIsValid(), roleOdbcToCollection(), roleSet(), roleSetObject(), roleSetObjectId()
property userId as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "userId", XMLPROJECTION = "ELEMENT");
Identifier

Unique identifier for the user.

Property methods: userIdGet(), userIdGetSwizzled(), userIdIsValid(), userIdNewObject(), userIdSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab