
Class AuditEvent
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic classstatic classstatic classstatic enumstatic classstatic classstatic classstatic enumstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Enumeration<AuditEvent.AuditEventAction> Indicator for type of action performed during the event that generated the audit.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for actionstatic final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for addressprotected List<AuditEvent.AuditEventAgentComponent> An actor taking an active role in the event or activity that is logged.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for agentstatic final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for agent-namestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for agent-rolestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for altidstatic final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for dateprotected List<AuditEvent.AuditEventEntityComponent> Specific instances of data or objects that have been accessed.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for entitystatic final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for entity-namestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for entity-rolestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for entity-typestatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected Enumeration<AuditEvent.AuditEventOutcome> Indicates whether the event succeeded or failed.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for outcomeprotected StringTypeA free text description of the outcome of the event.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientprotected PeriodThe period during which the activity occurred.static final ca.uhn.fhir.rest.gclient.UriClientParamFluent Client search parameter constant for policyprotected List<CodeableConcept> The purposeOfUse (reason) that was used during the event being recorded.protected InstantTypeThe time when the event was recorded.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for siteprotected AuditEvent.AuditEventSourceComponentThe system that is reporting the event.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for sourcestatic final StringSearch parameter: actionstatic final StringSearch parameter: addressstatic final StringSearch parameter: agentstatic final StringSearch parameter: agent-namestatic final StringSearch parameter: agent-rolestatic final StringSearch parameter: altidstatic final StringSearch parameter: datestatic final StringSearch parameter: entitystatic final StringSearch parameter: entity-namestatic final StringSearch parameter: entity-rolestatic final StringSearch parameter: entity-typestatic final StringSearch parameter: outcomestatic final StringSearch parameter: patientstatic final StringSearch parameter: policystatic final StringSearch parameter: sitestatic final StringSearch parameter: sourcestatic final StringSearch parameter: subtypestatic final StringSearch parameter: typeIdentifier for the category of event.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for subtypeprotected CodingIdentifier for a family of the event.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for typeFields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorAuditEvent(Coding type, InstantType recorded, AuditEvent.AuditEventSourceComponent source) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddAgent()addSubtype(Coding t) copy()voidcopyValues(AuditEvent dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getAgent()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) getType()String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanhasAgent()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasType()booleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setAgent(List<AuditEvent.AuditEventAgentComponent> theAgent) setEntity(List<AuditEvent.AuditEventEntityComponent> theEntity) setOutcomeDesc(String value) setOutcomeDescElement(StringType value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setPurposeOfEvent(List<CodeableConcept> thePurposeOfEvent) setRecorded(Date value) setRecordedElement(InstantType value) setSubtype(List<Coding> theSubtype) protected AuditEventMethods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
type
Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. -
subtype
Identifier for the category of event. -
action
Indicator for type of action performed during the event that generated the audit. -
period
The period during which the activity occurred. -
recorded
The time when the event was recorded. -
outcome
Indicates whether the event succeeded or failed. -
outcomeDesc
A free text description of the outcome of the event. -
purposeOfEvent
The purposeOfUse (reason) that was used during the event being recorded. -
agent
An actor taking an active role in the event or activity that is logged. -
source
The system that is reporting the event. -
entity
Specific instances of data or objects that have been accessed. -
SP_DATE
Search parameter: dateDescription: Time when the event was recorded
Type: date
Path: AuditEvent.recorded
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Time when the event was recorded
Type: date
Path: AuditEvent.recorded
-
SP_ENTITY_TYPE
Search parameter: entity-typeDescription: Type of entity involved
Type: token
Path: AuditEvent.entity.type
- See Also:
-
ENTITY_TYPE
Fluent Client search parameter constant for entity-typeDescription: Type of entity involved
Type: token
Path: AuditEvent.entity.type
-
SP_AGENT
Search parameter: agentDescription: Identifier of who
Type: reference
Path: AuditEvent.agent.who
- See Also:
-
AGENT
Fluent Client search parameter constant for agentDescription: Identifier of who
Type: reference
Path: AuditEvent.agent.who
-
INCLUDE_AGENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:agent". -
SP_ADDRESS
Search parameter: addressDescription: Identifier for the network access point of the user device
Type: string
Path: AuditEvent.agent.network.address
- See Also:
-
ADDRESS
Fluent Client search parameter constant for addressDescription: Identifier for the network access point of the user device
Type: string
Path: AuditEvent.agent.network.address
-
SP_ENTITY_ROLE
Search parameter: entity-roleDescription: What role the entity played
Type: token
Path: AuditEvent.entity.role
- See Also:
-
ENTITY_ROLE
Fluent Client search parameter constant for entity-roleDescription: What role the entity played
Type: token
Path: AuditEvent.entity.role
-
SP_SOURCE
Search parameter: sourceDescription: The identity of source detecting the event
Type: reference
Path: AuditEvent.source.observer
- See Also:
-
SOURCE
Fluent Client search parameter constant for sourceDescription: The identity of source detecting the event
Type: reference
Path: AuditEvent.source.observer
-
INCLUDE_SOURCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:source". -
SP_TYPE
Search parameter: typeDescription: Type/identifier of event
Type: token
Path: AuditEvent.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Type/identifier of event
Type: token
Path: AuditEvent.type
-
SP_ALTID
Search parameter: altidDescription: Alternative User identity
Type: token
Path: AuditEvent.agent.altId
- See Also:
-
ALTID
Fluent Client search parameter constant for altidDescription: Alternative User identity
Type: token
Path: AuditEvent.agent.altId
-
SP_SITE
Search parameter: siteDescription: Logical source location within the enterprise
Type: token
Path: AuditEvent.source.site
- See Also:
-
SITE
Fluent Client search parameter constant for siteDescription: Logical source location within the enterprise
Type: token
Path: AuditEvent.source.site
-
SP_AGENT_NAME
Search parameter: agent-nameDescription: Human friendly name for the agent
Type: string
Path: AuditEvent.agent.name
- See Also:
-
AGENT_NAME
Fluent Client search parameter constant for agent-nameDescription: Human friendly name for the agent
Type: string
Path: AuditEvent.agent.name
-
SP_ENTITY_NAME
Search parameter: entity-nameDescription: Descriptor for entity
Type: string
Path: AuditEvent.entity.name
- See Also:
-
ENTITY_NAME
Fluent Client search parameter constant for entity-nameDescription: Descriptor for entity
Type: string
Path: AuditEvent.entity.name
-
SP_SUBTYPE
Search parameter: subtypeDescription: More specific type/id for the event
Type: token
Path: AuditEvent.subtype
- See Also:
-
SUBTYPE
Fluent Client search parameter constant for subtypeDescription: More specific type/id for the event
Type: token
Path: AuditEvent.subtype
-
SP_PATIENT
Search parameter: patientDescription: Identifier of who
Type: reference
Path: AuditEvent.agent.who, AuditEvent.entity.what
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Identifier of who
Type: reference
Path: AuditEvent.agent.who, AuditEvent.entity.what
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:patient". -
SP_ACTION
Search parameter: actionDescription: Type of action performed during the event
Type: token
Path: AuditEvent.action
- See Also:
-
ACTION
Fluent Client search parameter constant for actionDescription: Type of action performed during the event
Type: token
Path: AuditEvent.action
-
SP_AGENT_ROLE
Search parameter: agent-roleDescription: Agent role in the event
Type: token
Path: AuditEvent.agent.role
- See Also:
-
AGENT_ROLE
Fluent Client search parameter constant for agent-roleDescription: Agent role in the event
Type: token
Path: AuditEvent.agent.role
-
SP_ENTITY
Search parameter: entityDescription: Specific instance of resource
Type: reference
Path: AuditEvent.entity.what
- See Also:
-
ENTITY
Fluent Client search parameter constant for entityDescription: Specific instance of resource
Type: reference
Path: AuditEvent.entity.what
-
INCLUDE_ENTITY
Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:entity". -
SP_OUTCOME
Search parameter: outcomeDescription: Whether the event succeeded or failed
Type: token
Path: AuditEvent.outcome
- See Also:
-
OUTCOME
Fluent Client search parameter constant for outcomeDescription: Whether the event succeeded or failed
Type: token
Path: AuditEvent.outcome
-
SP_POLICY
Search parameter: policyDescription: Policy that authorized event
Type: uri
Path: AuditEvent.agent.policy
- See Also:
-
POLICY
Fluent Client search parameter constant for policyDescription: Policy that authorized event
Type: uri
Path: AuditEvent.agent.policy
-
-
Constructor Details
-
AuditEvent
public AuditEvent()Constructor -
AuditEvent
Constructor
-
-
Method Details
-
getType
- Returns:
type(Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.)
-
hasType
-
setType
- Parameters:
value-type(Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.)
-
getSubtype
- Returns:
subtype(Identifier for the category of event.)
-
setSubtype
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSubtype
-
addSubtype
-
addSubtype
-
getSubtypeFirstRep
- Returns:
- The first repetition of repeating field
subtype, creating it if it does not already exist
-
getActionElement
- Returns:
action(Indicator for type of action performed during the event that generated the audit.). This is the underlying object with id, value and extensions. The accessor "getAction" gives direct access to the value
-
hasActionElement
-
hasAction
-
setActionElement
- Parameters:
value-action(Indicator for type of action performed during the event that generated the audit.). This is the underlying object with id, value and extensions. The accessor "getAction" gives direct access to the value
-
getAction
- Returns:
- Indicator for type of action performed during the event that generated the audit.
-
setAction
- Parameters:
value- Indicator for type of action performed during the event that generated the audit.
-
getPeriod
- Returns:
period(The period during which the activity occurred.)
-
hasPeriod
-
setPeriod
- Parameters:
value-period(The period during which the activity occurred.)
-
getRecordedElement
- Returns:
recorded(The time when the event was recorded.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
hasRecordedElement
-
hasRecorded
-
setRecordedElement
- Parameters:
value-recorded(The time when the event was recorded.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
getRecorded
- Returns:
- The time when the event was recorded.
-
setRecorded
- Parameters:
value- The time when the event was recorded.
-
getOutcomeElement
- Returns:
outcome(Indicates whether the event succeeded or failed.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value
-
hasOutcomeElement
-
hasOutcome
-
setOutcomeElement
- Parameters:
value-outcome(Indicates whether the event succeeded or failed.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value
-
getOutcome
- Returns:
- Indicates whether the event succeeded or failed.
-
setOutcome
- Parameters:
value- Indicates whether the event succeeded or failed.
-
getOutcomeDescElement
- Returns:
outcomeDesc(A free text description of the outcome of the event.). This is the underlying object with id, value and extensions. The accessor "getOutcomeDesc" gives direct access to the value
-
hasOutcomeDescElement
-
hasOutcomeDesc
-
setOutcomeDescElement
- Parameters:
value-outcomeDesc(A free text description of the outcome of the event.). This is the underlying object with id, value and extensions. The accessor "getOutcomeDesc" gives direct access to the value
-
getOutcomeDesc
- Returns:
- A free text description of the outcome of the event.
-
setOutcomeDesc
- Parameters:
value- A free text description of the outcome of the event.
-
getPurposeOfEvent
- Returns:
purposeOfEvent(The purposeOfUse (reason) that was used during the event being recorded.)
-
setPurposeOfEvent
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPurposeOfEvent
-
addPurposeOfEvent
-
addPurposeOfEvent
-
getPurposeOfEventFirstRep
- Returns:
- The first repetition of repeating field
purposeOfEvent, creating it if it does not already exist
-
getAgent
- Returns:
agent(An actor taking an active role in the event or activity that is logged.)
-
setAgent
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAgent
-
addAgent
-
addAgent
-
getAgentFirstRep
- Returns:
- The first repetition of repeating field
agent, creating it if it does not already exist
-
getSource
- Returns:
source(The system that is reporting the event.)
-
hasSource
-
setSource
- Parameters:
value-source(The system that is reporting the event.)
-
getEntity
- Returns:
entity(Specific instances of data or objects that have been accessed.)
-
setEntity
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEntity
-
addEntity
-
addEntity
-
getEntityFirstRep
- Returns:
- The first repetition of repeating field
entity, creating it if it does not already exist
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-