Class FhirQueryAuditStrategy

java.lang.Object

org.openehealth.ipf.commons.ihe.core.atna.AuditStrategySupport<FhirQueryAuditDataset>

org.openehealth.ipf.commons.ihe.fhir.audit.AbstractFhirAuditStrategy<FhirQueryAuditDataset, IBaseOperationOutcome>

org.openehealth.ipf.commons.ihe.fhir.audit.FhirAuditStrategy<FhirQueryAuditDataset>

org.openehealth.ipf.commons.ihe.fhir.audit.FhirQueryAuditStrategy

All Implemented Interfaces:

AuditStrategy<FhirQueryAuditDataset>

Direct Known Subclasses:

ChPpq5AuditStrategy, Iti119ClientAuditStrategy, Iti119ServerAuditStrategy, Iti66AuditStrategy, Iti67AuditStrategy, Iti78ClientAuditStrategy, Iti78ServerAuditStrategy, Iti83AuditStrategy, Pcc44AuditStrategy

public abstract class FhirQueryAuditStrategy
extends FhirAuditStrategy<FhirQueryAuditDataset>

Generic Audit Strategy for FHIR query transactions

Since:

3.4

Author:

Christian Ohr

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FhirQueryAuditStrategy(boolean serverSide)

Method Summary

Modifier and Type	Method	Description
FhirQueryAuditDataset	createAuditDataset()	Creates a new audit dataset instance.
FhirQueryAuditDataset	enrichAuditDatasetFromRequest(FhirQueryAuditDataset auditDataset, Object request, Map<String,Object> parameters)	Further enrich the audit dataset: add query string and patient IDs in the search parameter (if available).
boolean	enrichAuditDatasetFromResponse(FhirQueryAuditDataset auditDataset, Object response, AuditContext auditContext)	Fills in the patient from the query string, for the client side.
protected Set<String>	patientIdQueryParameters()	The search parameters that name the patient a query is about.

Methods inherited from class FhirAuditStrategy

getEventOutcomeCodeFromOperationOutcome, getEventOutcomeDescriptionFromOperationOutcome

Methods inherited from class AbstractFhirAuditStrategy

doAudit, getEventOutcomeCodeFromResource, getEventOutcomeDescription, getEventOutcomeIndicator

Methods inherited from class AuditStrategySupport

isAuditableResponse, isServerSide, makeAuditMessage

Methods inherited from class Object

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

Methods inherited from interface AuditStrategy

enrichAuditDatasetFromResponse

Constructor Details

FhirQueryAuditStrategy

protected FhirQueryAuditStrategy(boolean serverSide)

Method Details

enrichAuditDatasetFromRequest

public FhirQueryAuditDataset enrichAuditDatasetFromRequest(FhirQueryAuditDataset auditDataset,
 Object request,
 Map<String,Object> parameters)

Further enrich the audit dataset: add query string and patient IDs in the search parameter (if available).

Specified by:

enrichAuditDatasetFromRequest in interface AuditStrategy<FhirQueryAuditDataset>

Overrides:

enrichAuditDatasetFromRequest in class AbstractFhirAuditStrategy<FhirQueryAuditDataset, IBaseOperationOutcome>

Parameters:

auditDataset - audit dataset

request - request object

parameters - request parameters

Returns:

enriched audit dataset

patientIdQueryParameters

protected Set<String> patientIdQueryParameters()

The search parameters that name the patient a query is about. The server side does not need them: it gets the request parsed into FhirSearchParameters, which knows its own patient parameter. The client side has only the query string it sent, so the names have to be spelled out.

These are the ones the patient-centric FHIR query transactions use. A transaction whose patient lives somewhere else overrides this.

Returns:

names of the search parameters that carry a patient id

enrichAuditDatasetFromResponse

public boolean enrichAuditDatasetFromResponse(FhirQueryAuditDataset auditDataset,
 Object response,
 AuditContext auditContext)

Fills in the patient from the query string, for the client side.

This runs here rather than in enrichAuditDatasetFromRequest(FhirQueryAuditDataset, Object, Map) because the query string does not exist yet when that is called: the client audit dataset only learns it once HAPI has built the request, which happens on the way out. Without it a client record could never name the patient, and would be stepped down to a weaker profile than the server record of the same transaction.

Specified by:

enrichAuditDatasetFromResponse in interface AuditStrategy<FhirQueryAuditDataset>

Overrides:

enrichAuditDatasetFromResponse in class AbstractFhirAuditStrategy<FhirQueryAuditDataset, IBaseOperationOutcome>

Parameters:

auditDataset - audit dataset

response - response object

auditContext - audit context

Returns:

whether the transaction is to be considered successful

createAuditDataset

public FhirQueryAuditDataset createAuditDataset()

Description copied from interface: AuditStrategy

Creates a new audit dataset instance.