Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.AuditEvent

class HS.FHIR.DTL.vR4.Model.Resource.AuditEvent extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Event record kept for security purposes.

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;
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;
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 action as %String (MAXLEN = 1000000, XMLNAME = "action", XMLPROJECTION = "ATTRIBUTE");
code

Type of action performed during the event.

audit-event-action|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend audit-event-action|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: actionDisplayToLogical(), actionGet(), actionIsValid(), actionLogicalToDisplay(), actionLogicalToOdbc(), actionNormalize(), actionSet()
property agent as list of HS.FHIR.DTL.vR4.Model.Element.AuditEvent.agent (XMLNAME = "agent", XMLPROJECTION = "ELEMENT") [ Required ];
BackboneElement

Actor involved in the event.

Property methods: agentBuildValueArray(), agentCollectionToDisplay(), agentCollectionToOdbc(), agentDisplayToCollection(), agentGet(), agentGetObject(), agentGetObjectId(), agentGetSwizzled(), agentIsValid(), agentOdbcToCollection(), agentSet(), agentSetObject(), agentSetObjectId()
property entity as list of HS.FHIR.DTL.vR4.Model.Element.AuditEvent.entity (XMLNAME = "entity", XMLPROJECTION = "ELEMENT");
BackboneElement

Data or objects used.

Property methods: entityBuildValueArray(), entityCollectionToDisplay(), entityCollectionToOdbc(), entityDisplayToCollection(), entityGet(), entityGetObject(), entityGetObjectId(), entityGetSwizzled(), entityIsValid(), entityOdbcToCollection(), entitySet(), entitySetObject(), entitySetObjectId()
property outcome as %String (MAXLEN = 1000000, XMLNAME = "outcome", XMLPROJECTION = "ATTRIBUTE");
code

Whether the event succeeded or failed.

audit-event-outcome|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend audit-event-outcome|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: outcomeDescDisplayToLogical(), outcomeDescGet(), outcomeDescIsValid(), outcomeDescLogicalToDisplay(), outcomeDescLogicalToOdbc(), outcomeDescNormalize(), outcomeDescSet(), outcomeDisplayToLogical(), outcomeGet(), outcomeIsValid(), outcomeLogicalToDisplay(), outcomeLogicalToOdbc(), outcomeNormalize(), outcomeSet()
property outcomeDesc as %String (MAXLEN = 1000000, XMLNAME = "outcomeDesc", XMLPROJECTION = "ATTRIBUTE");
string

Description of the event outcome.

Property methods: outcomeDescDisplayToLogical(), outcomeDescGet(), outcomeDescIsValid(), outcomeDescLogicalToDisplay(), outcomeDescLogicalToOdbc(), outcomeDescNormalize(), outcomeDescSet()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

When the activity occurred.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property purposeOfEvent as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "purposeOfEvent", XMLPROJECTION = "ELEMENT");
CodeableConcept

The purposeOfUse of the event.

v3-PurposeOfUse is the REQUIRED FHIR4 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: purposeOfEventBuildValueArray(), purposeOfEventCollectionToDisplay(), purposeOfEventCollectionToOdbc(), purposeOfEventDisplayToCollection(), purposeOfEventGet(), purposeOfEventGetObject(), purposeOfEventGetObjectId(), purposeOfEventGetSwizzled(), purposeOfEventIsValid(), purposeOfEventOdbcToCollection(), purposeOfEventSet(), purposeOfEventSetObject(), purposeOfEventSetObjectId()
property recorded as %String (MAXLEN = 1000000, XMLNAME = "recorded", XMLPROJECTION = "ATTRIBUTE") [ Required ];
instant

Time when the event was recorded.

Property methods: recordedDisplayToLogical(), recordedGet(), recordedIsValid(), recordedLogicalToDisplay(), recordedLogicalToOdbc(), recordedNormalize(), recordedSet()
property source as HS.FHIR.DTL.vR4.Model.Element.AuditEvent.source (XMLNAME = "source", XMLPROJECTION = "ELEMENT") [ Required ];
BackboneElement

Audit Event Reporter.

Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property subtype as list of HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "subtype", XMLPROJECTION = "ELEMENT");
Coding

More specific type/id for the event.

audit-event-sub-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in audit-event-sub-type, you may formally EXTEND audit-event-sub-type to add codes to it.

Property methods: subtypeBuildValueArray(), subtypeCollectionToDisplay(), subtypeCollectionToOdbc(), subtypeDisplayToCollection(), subtypeGet(), subtypeGetObject(), subtypeGetObjectId(), subtypeGetSwizzled(), subtypeIsValid(), subtypeOdbcToCollection(), subtypeSet(), subtypeSetObject(), subtypeSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
Coding

Type/identifier of event.

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

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab