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 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 actionprotected 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.TokenClientParamFluent Client search parameter constant for agent-roleprotected List<CodeableConcept>The authorization (e.g., PurposeOfUse) that was used during the event being recorded.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for based-onAllows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.protected List<CodeableConcept>Classification of the type of event.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for categoryprotected CodeableConceptDescribes what happened.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for codestatic final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for dateprotected ReferenceThis will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for encounterprotected 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.TokenClientParamFluent Client search parameter constant for entity-rolestatic 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.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 DataTypeThe time or period during which the activity occurred.protected AuditEvent.AuditEventOutcomeComponentIndicates whether the event succeeded or failed.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for outcomestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientstatic final ca.uhn.fhir.rest.gclient.UriClientParamFluent Client search parameter constant for policystatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for purposeprotected InstantTypeThe time when the event was recorded.protected Enumeration<AuditEvent.AuditEventSeverity>Indicates and enables segmentation of various severity including debugging from critical.protected AuditEvent.AuditEventSourceComponentThe actor 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: agentstatic final StringSearch parameter: agent-rolestatic final StringSearch parameter: based-onstatic final StringSearch parameter: categorystatic final StringSearch parameter: codestatic final StringSearch parameter: datestatic final StringSearch parameter: encounterstatic final StringSearch parameter: entitystatic final StringSearch parameter: entity-rolestatic final StringSearch parameter: outcomestatic final StringSearch parameter: patientstatic final StringSearch parameter: policystatic final StringSearch parameter: purposestatic final StringSearch parameter: sourceFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_IDFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorAuditEvent(CodeableConcept code, Date recorded, AuditEvent.AuditEventAgentComponent agent, AuditEvent.AuditEventSourceComponent source) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddAgent()copy()voidcopyValues(AuditEvent dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getAgent()getCode()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanhasAgent()booleanbooleanbooleanbooleanhasCode()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) setAgent(List<AuditEvent.AuditEventAgentComponent> theAgent) setAuthorization(List<CodeableConcept> theAuthorization) setBasedOn(List<Reference> theBasedOn) setCategory(List<CodeableConcept> theCategory) setCode(CodeableConcept value) setEncounter(Reference value) setEntity(List<AuditEvent.AuditEventEntityComponent> theEntity) setOccurred(DataType value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setRecorded(Date value) setRecordedElement(InstantType value) protected AuditEventMethods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, 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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods 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, setId
-
Field Details
-
category
Classification of the type of event. -
code
Describes what happened. The most specific code for the event. -
action
Indicator for type of action performed during the event that generated the audit. -
severity
Indicates and enables segmentation of various severity including debugging from critical. -
occurred
The time or period during which the activity occurred. -
recorded
The time when the event was recorded. -
outcome
Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text. -
authorization
The authorization (e.g., PurposeOfUse) that was used during the event being recorded. -
basedOn
Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon. -
encounter
This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests). -
agent
An actor taking an active role in the event or activity that is logged. -
source
The actor that is reporting the event. -
entity
Specific instances of data or objects that have been accessed. -
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_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_BASED_ON
Search parameter: based-onDescription: Reference to the service request.
Type: reference
Path: AuditEvent.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Reference to the service request.
Type: reference
Path: AuditEvent.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:based-on". -
SP_CATEGORY
Search parameter: categoryDescription: Category of event
Type: token
Path: AuditEvent.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Category of event
Type: token
Path: AuditEvent.category
-
SP_CODE
Search parameter: codeDescription: More specific code for the event
Type: token
Path: AuditEvent.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: More specific code for the event
Type: token
Path: AuditEvent.code
-
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_ENCOUNTER
Search parameter: encounterDescription: Encounter related to the activity recorded in the AuditEvent
Type: reference
Path: AuditEvent.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Encounter related to the activity recorded in the AuditEvent
Type: reference
Path: AuditEvent.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:encounter". -
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_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.code
- See Also:
-
OUTCOME
Fluent Client search parameter constant for outcomeDescription: Whether the event succeeded or failed
Type: token
Path: AuditEvent.outcome.code
-
SP_PATIENT
Search parameter: patientDescription: Identifier of who
Type: reference
Path: AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient)
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Identifier of who
Type: reference
Path: AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient)
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:patient". -
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
-
SP_PURPOSE
Search parameter: purposeDescription: The authorization (purposeOfUse) of the event
Type: token
Path: AuditEvent.authorization | AuditEvent.agent.authorization
- See Also:
-
PURPOSE
Fluent Client search parameter constant for purposeDescription: The authorization (purposeOfUse) of the event
Type: token
Path: AuditEvent.authorization | AuditEvent.agent.authorization
-
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".
-
-
Constructor Details
-
AuditEvent
public AuditEvent()Constructor -
AuditEvent
public AuditEvent(CodeableConcept code, Date recorded, AuditEvent.AuditEventAgentComponent agent, AuditEvent.AuditEventSourceComponent source) Constructor
-
-
Method Details
-
getCategory
- Returns:
category(Classification of the type of event.)
-
setCategory
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist {3}
-
getCode
- Returns:
code(Describes what happened. The most specific code for the event.)
-
hasCode
-
setCode
- Parameters:
value-code(Describes what happened. The most specific code for the event.)
-
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.
-
getSeverityElement
- Returns:
severity(Indicates and enables segmentation of various severity including debugging from critical.). This is the underlying object with id, value and extensions. The accessor "getSeverity" gives direct access to the value
-
hasSeverityElement
-
hasSeverity
-
setSeverityElement
- Parameters:
value-severity(Indicates and enables segmentation of various severity including debugging from critical.). This is the underlying object with id, value and extensions. The accessor "getSeverity" gives direct access to the value
-
getSeverity
- Returns:
- Indicates and enables segmentation of various severity including debugging from critical.
-
setSeverity
- Parameters:
value- Indicates and enables segmentation of various severity including debugging from critical.
-
getOccurred
- Returns:
occurred(The time or period during which the activity occurred.)
-
getOccurredPeriod
- Returns:
occurred(The time or period during which the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurredPeriod
-
getOccurredDateTimeType
- Returns:
occurred(The time or period during which the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurredDateTimeType
-
hasOccurred
-
setOccurred
- Parameters:
value-occurred(The time or 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.
-
getOutcome
- Returns:
outcome(Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.)
-
hasOutcome
-
setOutcome
- Parameters:
value-outcome(Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.)
-
getAuthorization
- Returns:
authorization(The authorization (e.g., PurposeOfUse) that was used during the event being recorded.)
-
setAuthorization
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthorization
-
addAuthorization
-
addAuthorization
-
getAuthorizationFirstRep
- Returns:
- The first repetition of repeating field
authorization, creating it if it does not already exist {3}
-
getBasedOn
- Returns:
basedOn(Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.)
-
setBasedOn
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist {3}
-
getEncounter
- Returns:
encounter(This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).)
-
hasEncounter
-
setEncounter
- Parameters:
value-encounter(This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).)
-
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 {3}
-
getSource
- Returns:
source(The actor that is reporting the event.)
-
hasSource
-
setSource
- Parameters:
value-source(The actor 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 {3}
-
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
-
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
-