Class ProvideBundleRecipientAuditEvent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.AuditEvent

org.openehealth.ipf.commons.ihe.fhir.support.audit.model.BalpAuditEvent

org.openehealth.ipf.commons.ihe.fhir.mhd.model.ProvideBundleRecipientAuditEvent

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource, SelfInitializing

public class ProvideBundleRecipientAuditEvent
extends BalpAuditEvent

The AuditEvent an ITI-65 audit record takes when it is written by the Document Recipient, i.e. the server of the transaction.

Since:

5.3

Author:

Christian Ohr

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AuditEvent

AuditEvent.AuditEventAction, AuditEvent.AuditEventActionEnumFactory, AuditEvent.AuditEventAgentComponent, AuditEvent.AuditEventAgentNetworkComponent, AuditEvent.AuditEventAgentNetworkType, AuditEvent.AuditEventAgentNetworkTypeEnumFactory, AuditEvent.AuditEventEntityComponent, AuditEvent.AuditEventEntityDetailComponent, AuditEvent.AuditEventOutcome, AuditEvent.AuditEventOutcomeEnumFactory, AuditEvent.AuditEventSourceComponent

Field Summary

Fields inherited from class AuditEvent

action, ACTION, ADDRESS, agent, AGENT, AGENT_NAME, AGENT_ROLE, ALTID, DATE, entity, ENTITY, ENTITY_NAME, ENTITY_ROLE, ENTITY_TYPE, INCLUDE_AGENT, INCLUDE_ENTITY, INCLUDE_PATIENT, INCLUDE_SOURCE, outcome, OUTCOME, outcomeDesc, PATIENT, period, POLICY, purposeOfEvent, recorded, SITE, source, SOURCE, SP_ACTION, SP_ADDRESS, SP_AGENT, SP_AGENT_NAME, SP_AGENT_ROLE, SP_ALTID, SP_DATE, SP_ENTITY, SP_ENTITY_NAME, SP_ENTITY_ROLE, SP_ENTITY_TYPE, SP_OUTCOME, SP_PATIENT, SP_POLICY, SP_SITE, SP_SOURCE, SP_SUBTYPE, SP_TYPE, subtype, SUBTYPE, type, TYPE

Fields inherited from class DomainResource

contained, extension, modifierExtension, text

Fields inherited from class Resource

id, implicitRules, language, meta

Fields inherited from interface 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_TAG

Fields inherited from interface IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ProvideBundleRecipientAuditEvent()

Method Summary

Modifier and Type	Method	Description
protected Coding	clientAgentType()
protected void	initializeFrom(AuditMessage auditMessage, ActiveParticipantRoleIdCode localRole)	Fills in what this profile takes from the audit record beyond the common part: the outcome and the event itself, the patient, and the SubmissionSet.
protected Coding	serverAgentType()
boolean	supports(AuditMessage auditMessage)	The profile constrains the outcome but does not fix it, and its patient entity is optional, so every Provide Document Bundle is reported with this AuditEvent rather than being stepped down.

Methods inherited from class BalpAuditEvent

addAgent, addAgent, addDataEntity, addEntity, addPatientEntity, addPatientEntityIfPresent, addQueryEntity, addRequiredPatientEntity, addTransactionEntity, addTransactionSubtype, addTransactionSubtype, addUserAgent, addUserAgents, dicomAgentType, initialize, localRole, setAuditSource, setClientAndServer, transactionOf

Methods inherited from class AuditEvent

addAgent, addAgent, addChild, addEntity, addEntity, addPurposeOfEvent, addPurposeOfEvent, addSubtype, addSubtype, copy, copyValues, equalsDeep, equalsShallow, fhirType, getAction, getActionElement, getAgent, getAgentFirstRep, getEntity, getEntityFirstRep, getNamedProperty, getOutcome, getOutcomeDesc, getOutcomeDescElement, getOutcomeElement, getPeriod, getProperty, getPurposeOfEvent, getPurposeOfEventFirstRep, getRecorded, getRecordedElement, getResourceType, getSource, getSubtype, getSubtypeFirstRep, getType, getTypesForProperty, hasAction, hasActionElement, hasAgent, hasEntity, hasOutcome, hasOutcomeDesc, hasOutcomeDescElement, hasOutcomeElement, hasPeriod, hasPurposeOfEvent, hasRecorded, hasRecordedElement, hasSource, hasSubtype, hasType, isEmpty, listChildren, makeProperty, removeChild, setAction, setActionElement, setAgent, setEntity, setOutcome, setOutcomeDesc, setOutcomeDescElement, setOutcomeElement, setPeriod, setProperty, setProperty, setPurposeOfEvent, setRecorded, setRecordedElement, setSource, setSubtype, setType, typedCopy

Methods inherited from class 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, setText

Methods inherited from class 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, setMeta

Methods inherited from class BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class 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, setXhtml

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Constructor Details

ProvideBundleRecipientAuditEvent

public ProvideBundleRecipientAuditEvent()

Method Details

clientAgentType

protected Coding clientAgentType()

Specified by:

clientAgentType in class BalpAuditEvent

Returns:

DICOM 110153, which this profile fixes for the Document Source agent

serverAgentType

protected Coding serverAgentType()

Specified by:

serverAgentType in class BalpAuditEvent

Returns:

DICOM 110152, which this profile fixes for the Document Recipient agent

supports

public boolean supports(AuditMessage auditMessage)

The profile constrains the outcome but does not fix it, and its patient entity is optional, so every Provide Document Bundle is reported with this AuditEvent rather than being stepped down.

Parameters:

auditMessage - the audit message of the transaction being audited

Returns:

always true

initializeFrom

protected void initializeFrom(AuditMessage auditMessage,
 ActiveParticipantRoleIdCode localRole)

Fills in what this profile takes from the audit record beyond the common part: the outcome and the event itself, the patient, and the SubmissionSet.

Overrides:

initializeFrom in class BalpAuditEvent

Parameters:

auditMessage - the audit message of the transaction being audited

localRole - which end of the transaction recorded it