org.openmrs.hl7.impl

Class HL7ServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.hl7.impl.HL7ServiceImpl

All Implemented Interfaces:

OpenmrsService, HL7Service

@Transactional
public class HL7ServiceImpl
extends BaseOpenmrsService
implements HL7Service

OpenMRS HL7 API default methods This class shouldn't be instantiated by itself. Use the Context

See Also:

HL7Service

Field Summary

Fields

Modifier and Type	Field and Description
protected HL7DAO	dao

Method Summary

Modifier and Type	Method and Description
Integer	countHL7InArchive(int messageState, String query) the total count of all HL7InArchive objects in the database
Integer	countHL7InError(String query) the total count of all HL7InError objects in the database
Integer	countHL7InQueue(int messageState, String query) the total count of all HL7InQueue objects in the database
Person	createPersonFromNK1(ca.uhn.hl7v2.model.v25.segment.NK1 nk1) creates a Person from information held in an NK1 segment; if valid PatientIdentifiers exist, a Patient will be created and returned
void	garbageCollect() Clean up the current memory consumption
List<HL7InArchive>	getAllHL7InArchives() Get all archive hl7 queue items from the database
List<HL7InError>	getAllHL7InErrors() Get all HL7InError items from the database
List<HL7InQueue>	getAllHL7InQueues() Return a list of all hl7 in queues in the database
List<HL7Source>	getAllHL7Sources() Get all of the hl7 source objects from the database.
HL7InArchive	getHL7InArchive(Integer hl7InArchiveId) Get the archive item with the given id, If hl7 archives were moved to the file system, you can't do a look up by hl7ArchiveId, instead call HL7Service.getHL7InArchiveByUuid(String)
List<HL7InArchive>	getHL7InArchiveBatch(int start, int length, int messageState, String query) Return a list of all hl7 in archives based on batch settings and a query string
List<HL7InArchive>	getHL7InArchiveByState(Integer state) If hl7 migration has been run and the state matches that of processed items, the method returns a list of all archives in the file system, for any other state , it returns an empty list, this is because all archives would have a status of 'processed' after migration and all deleted archives moved back into the queue with a status of 'deleted' otherwise it returns archives with a matching state if migration hasn't yet been run.
HL7InArchive	getHL7InArchiveByUuid(String uuid) Get the archive item with the given uuid
HL7InError	getHL7InError(Integer hl7InErrorId) Get the error item with the given id
List<HL7InError>	getHL7InErrorBatch(int start, int length, String query) Return a list of all hl7 in errors based on batch settings and a query string
HL7InError	getHL7InErrorByUuid(String uuid) Get the error item with the given uuid
HL7InQueue	getHL7InQueue(Integer hl7InQueueId) Get the hl7 queue item with the given primary key id
List<HL7InQueue>	getHL7InQueueBatch(int start, int length, int messageState, String query) Return a list of all hl7 in queues based on batch settings and a query string
List<HL7InQueue>	getHL7InQueueByState(Integer state) Get the queue items given a state (deleted, error, pending, processing, processed).
HL7InQueue	getHL7InQueueByUuid(String uuid) Get the hl7 queue item with the given uuid
HL7QueueItem	getHl7QueueItemByUuid(String uuid) Get HL7QueueItem with the given uuid.
HL7Source	getHL7Source(Integer hl7SourceId) Auto generated method comment
HL7Source	getHL7SourceByName(String name) Get the hl7 source object from the database that has the given name
static HL7ServiceImpl	getInstance() Singleton Factory method
HL7InQueue	getNextHL7InQueue() Get the first queue item in the database
String	getUuidFromIdentifiers(ca.uhn.hl7v2.model.v25.datatype.CX[] identifiers) finds a UUID from an array of identifiers
void	loadHL7InArchiveData(HL7InArchive archive) Loads HL7 data from the filesystem for an archived HL7InArchive
void	loadHL7InArchiveData(List<HL7InArchive> archives) Loads data for a list of HL7 archives from the filesystem
void	migrateHl7InArchivesToFileSystem(Map<String,Integer> progressStatusMap) Method is called by the archives migration thread to transfer hl7 in archives from the hl7_in_archives database table to the file system
ca.uhn.hl7v2.model.Message	parseHL7String(String hl7Message) Parses the given string and returns the resulting Message
HL7InQueue	processHL7InQueue(HL7InQueue hl7InQueue) Process the given HL7InQueue item.
ca.uhn.hl7v2.model.Message	processHL7Message(ca.uhn.hl7v2.model.Message message) Parses the given Message and saves the resulting content to the database
void	purgeHL7InArchive(HL7InArchive hl7InArchive) Completely delete the hl7 in archive item from the database
void	purgeHL7InError(HL7InError hl7InError) Completely remove this error item from the database
void	purgeHL7InQueue(HL7InQueue hl7InQueue) Completely delete the hl7 in queue item from the database.
void	purgeHL7Source(HL7Source hl7Source) Completely remove the source from the database.
Integer	resolveLocationId(ca.uhn.hl7v2.model.v25.datatype.PL pl) Resolves location from person location object, and if location id is specified then returns correspond internal identifier of the specified location.
Integer	resolvePatientId(ca.uhn.hl7v2.model.v25.segment.PID pid)
Person	resolvePersonFromIdentifiers(ca.uhn.hl7v2.model.v25.datatype.CX[] identifiers) determines a person (or patient) based on identifiers from a CX array, as found in a PID or NK1 segment; the first resolving identifier in the list wins
Integer	resolvePersonId(ca.uhn.hl7v2.model.v25.datatype.XCN xcn)
Integer	resolveUserId(ca.uhn.hl7v2.model.v25.datatype.XCN xcn)
HL7Source	retireHL7Source(HL7Source hl7Source) Mark the given hl7Source as no longer active
HL7InArchive	saveHL7InArchive(HL7InArchive hl7InArchive) Save the given hl7 in archive to the database
HL7InError	saveHL7InError(HL7InError hl7InError) Save the given error item to the database
HL7InQueue	saveHL7InQueue(HL7InQueue hl7InQueue) Save the given hl7InQueue to the database
HL7Source	saveHL7Source(HL7Source hl7Source) Save the given hl7Source to the database
void	setHL7DAO(HL7DAO dao) Auto generated method comment
void	setHL7Handlers(Map<String,ca.uhn.hl7v2.app.Application> handlers) Sets the given handlers as router applications that are available to HAPI when it is parsing an hl7 message. This method is usually used by Spring and the handlers are set in the applicationContext-server.xml method. The key in the map is a string like "ORU_R01" where the first part is the message type and the second is the trigger event.
void	setParser(ca.uhn.hl7v2.parser.GenericParser parser) Used by spring to inject the parser
void	setRouter(ca.uhn.hl7v2.app.MessageTypeRouter router) Used by spring to inject the router

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Field Detail

dao

protected HL7DAO dao

Method Detail

getInstance

public static HL7ServiceImpl getInstance()

Singleton Factory method

Returns:

a singleton instance of this HL7ServiceImpl class

setHL7DAO

public void setHL7DAO(HL7DAO dao)

Description copied from interface: HL7Service

Auto generated method comment

Specified by:

setHL7DAO in interface HL7Service

See Also:

HL7Service.setHL7DAO(org.openmrs.hl7.db.HL7DAO)

setParser

public void setParser(ca.uhn.hl7v2.parser.GenericParser parser)

Used by spring to inject the parser

Parameters:

parser - the parser to use

setRouter

public void setRouter(ca.uhn.hl7v2.app.MessageTypeRouter router)

Used by spring to inject the router

Parameters:

router - the router to use

saveHL7Source

public HL7Source saveHL7Source(HL7Source hl7Source)
                        throws APIException

Description copied from interface: HL7Service

Save the given hl7Source to the database

Specified by:

saveHL7Source in interface HL7Service

Parameters:

hl7Source - the source to save

Returns:

the saved source

Throws:

APIException

See Also:

HL7Service.saveHL7Source(org.openmrs.hl7.HL7Source)

purgeHL7Source

public void purgeHL7Source(HL7Source hl7Source)
                    throws APIException

Description copied from interface: HL7Service

Completely remove the source from the database. This should only be used in rare cases. See HL7Service.retireHL7Source(HL7Source)

Specified by:

purgeHL7Source in interface HL7Service

Throws:

APIException

See Also:

HL7Service.purgeHL7Source(org.openmrs.hl7.HL7Source)

retireHL7Source

public HL7Source retireHL7Source(HL7Source hl7Source)
                          throws APIException

Description copied from interface: HL7Service

Mark the given hl7Source as no longer active

Specified by:

retireHL7Source in interface HL7Service

Parameters:

hl7Source - the source to retire

Returns:

the retired source

Throws:

APIException

See Also:

HL7Service.retireHL7Source(org.openmrs.hl7.HL7Source)

getHL7Source

@Transactional(readOnly=true)
public HL7Source getHL7Source(Integer hl7SourceId)

Description copied from interface: HL7Service

Auto generated method comment

Specified by:

getHL7Source in interface HL7Service

Returns:

HL7Sourceobject for given identifier

See Also:

HL7Service.getHL7Source(java.lang.Integer)

getAllHL7Sources

@Transactional(readOnly=true)
public List<HL7Source> getAllHL7Sources()
                                                               throws APIException

Description copied from interface: HL7Service

Get all of the hl7 source objects from the database. This includes retired ones

Specified by:

getAllHL7Sources in interface HL7Service

Returns:

list of hl7 source objects

Throws:

APIException

See Also:

HL7Service.getAllHL7Sources()

getHL7SourceByName

@Transactional(readOnly=true)
public HL7Source getHL7SourceByName(String name)
                                                           throws APIException

Description copied from interface: HL7Service

Get the hl7 source object from the database that has the given name

Specified by:

getHL7SourceByName in interface HL7Service

Parameters:

name - string to 'search' on

Returns:

hl7 source object

Throws:

APIException

See Also:

HL7Service.getHL7SourceByName(java.lang.String)

getAllHL7InQueues

@Transactional(readOnly=true)
public List<HL7InQueue> getAllHL7InQueues()
                                                                 throws APIException

Description copied from interface: HL7Service

Return a list of all hl7 in queues in the database

Specified by:

getAllHL7InQueues in interface HL7Service

Returns:

all hl7 queue items

Throws:

APIException

See Also:

HL7Service.getAllHL7InQueues()

getHL7InQueueBatch

@Transactional(readOnly=true)
public List<HL7InQueue> getHL7InQueueBatch(int start,
                                                                         int length,
                                                                         int messageState,
                                                                         String query)
                                                                  throws APIException

Description copied from interface: HL7Service

Return a list of all hl7 in queues based on batch settings and a query string

Specified by:

getHL7InQueueBatch in interface HL7Service

Parameters:

start - beginning index

length - size of the batch

messageState - status of the HL7InQueue message

query - search string

Returns:

all matching hl7 queue items within batch window

Throws:

APIException

See Also:

HL7Service.getHL7InQueueBatch(int, int, int, String)

getHL7InErrorBatch

@Transactional(readOnly=true)
public List<HL7InError> getHL7InErrorBatch(int start,
                                                                         int length,
                                                                         String query)
                                                                  throws APIException

Description copied from interface: HL7Service

Return a list of all hl7 in errors based on batch settings and a query string

Specified by:

getHL7InErrorBatch in interface HL7Service

Parameters:

start - beginning index

length - size of the batch

query - search string

Returns:

all matching hl7 queue items within batch window

Throws:

APIException

See Also:

HL7Service.getHL7InErrorBatch(int, int, java.lang.String)

getHL7InArchiveBatch

@Transactional(readOnly=true)
public List<HL7InArchive> getHL7InArchiveBatch(int start,
                                                                             int length,
                                                                             int messageState,
                                                                             String query)
                                                                      throws APIException

Description copied from interface: HL7Service

Return a list of all hl7 in archives based on batch settings and a query string

Specified by:

getHL7InArchiveBatch in interface HL7Service

Parameters:

start - beginning index

length - size of the batch

messageState - status of the HL7InArchive message

query - search string

Returns:

all matching hl7 archive items within batch window

Throws:

APIException

See Also:

HL7Service.getHL7InArchiveBatch(int, int, int, String)

countHL7InQueue

@Transactional(readOnly=true)
public Integer countHL7InQueue(int messageState,
                                                             String query)
                                                      throws APIException

Description copied from interface: HL7Service

the total count of all HL7InQueue objects in the database

Specified by:

countHL7InQueue in interface HL7Service

Parameters:

messageState - HL7InQueue status

query - search string

Returns:

the count of matching HL7InQueue items

Throws:

APIException

See Also:

HL7Service.countHL7InQueue(int, java.lang.String)

countHL7InError

@Transactional(readOnly=true)
public Integer countHL7InError(String query)
                                                      throws APIException

Description copied from interface: HL7Service

the total count of all HL7InError objects in the database

Specified by:

countHL7InError in interface HL7Service

Parameters:

query - search string

Returns:

the count of matching HL7InError items

Throws:

APIException

See Also:

HL7Service.countHL7InError(java.lang.String)

countHL7InArchive

@Transactional(readOnly=true)
public Integer countHL7InArchive(int messageState,
                                                               String query)
                                                        throws APIException

Description copied from interface: HL7Service

the total count of all HL7InArchive objects in the database

Specified by:

countHL7InArchive in interface HL7Service

Parameters:

messageState - status of the HL7InArchive message

query - search string

Returns:

the count of matching HL7InArchive items

Throws:

APIException

See Also:

HL7Service.countHL7InArchive(int, java.lang.String)

purgeHL7InQueue

public void purgeHL7InQueue(HL7InQueue hl7InQueue)

Description copied from interface: HL7Service

Completely delete the hl7 in queue item from the database.

Specified by:

purgeHL7InQueue in interface HL7Service

See Also:

HL7Service.purgeHL7InQueue(org.openmrs.hl7.HL7InQueue)

saveHL7InQueue

public HL7InQueue saveHL7InQueue(HL7InQueue hl7InQueue)
                          throws APIException

Description copied from interface: HL7Service

Save the given hl7InQueue to the database

Specified by:

saveHL7InQueue in interface HL7Service

Parameters:

hl7InQueue - the queue item to save

Returns:

the saved queue item Should add generated uuid if uuid is null

Throws:

APIException

See Also:

HL7Service.saveHL7InQueue(org.openmrs.hl7.HL7InQueue)

getHL7InQueue

@Transactional(readOnly=true)
public HL7InQueue getHL7InQueue(Integer hl7InQueueId)

Description copied from interface: HL7Service

Get the hl7 queue item with the given primary key id

Specified by:

getHL7InQueue in interface HL7Service

Parameters:

hl7InQueueId - the id to search on

Returns:

the desired hl7InQueue object or null if none found

See Also:

HL7Service.getHL7InQueue(java.lang.Integer)

getHL7InQueueByUuid

@Transactional(readOnly=true)
public HL7InQueue getHL7InQueueByUuid(String uuid)
                                                             throws APIException

Description copied from interface: HL7Service

Get the hl7 queue item with the given uuid

Specified by:

getHL7InQueueByUuid in interface HL7Service

Returns:

the HL7InQueue or null

Throws:

APIException

getNextHL7InQueue

@Transactional(readOnly=true)
public HL7InQueue getNextHL7InQueue()

Description copied from interface: HL7Service

Get the first queue item in the database

Specified by:

getNextHL7InQueue in interface HL7Service

Returns:

the first queue item

See Also:

HL7Service.getNextHL7InQueue()

getHL7InArchiveByState

@Transactional(readOnly=true)
public List<HL7InArchive> getHL7InArchiveByState(Integer state)
                                                                        throws APIException

Description copied from interface: HL7Service

If hl7 migration has been run and the state matches that of processed items, the method returns a list of all archives in the file system, for any other state , it returns an empty list, this is because all archives would have a status of 'processed' after migration and all deleted archives moved back into the queue with a status of 'deleted' otherwise it returns archives with a matching state if migration hasn't yet been run.

Specified by:

getHL7InArchiveByState in interface HL7Service

Returns:

list of archive items that match the state

Throws:

APIException

See Also:

HL7Service.getHL7InArchiveByState(java.lang.Integer)

getHL7InQueueByState

@Transactional(readOnly=true)
public List<HL7InQueue> getHL7InQueueByState(Integer state)
                                                                    throws APIException

Description copied from interface: HL7Service

Get the queue items given a state (deleted, error, pending, processing, processed).

Specified by:

getHL7InQueueByState in interface HL7Service

Returns:

list of hl7 queue items that match the given state

Throws:

APIException

See Also:

HL7Service.getHL7InQueueByState(java.lang.Integer)

getAllHL7InArchives

@Transactional(readOnly=true)
public List<HL7InArchive> getAllHL7InArchives()
                                                                     throws APIException

Description copied from interface: HL7Service

Get all archive hl7 queue items from the database

Specified by:

getAllHL7InArchives in interface HL7Service

Returns:

list of archive items

Throws:

APIException

See Also:

HL7Service.getAllHL7InArchives()

purgeHL7InArchive

public void purgeHL7InArchive(HL7InArchive hl7InArchive)
                       throws APIException

Description copied from interface: HL7Service

Completely delete the hl7 in archive item from the database

Specified by:

purgeHL7InArchive in interface HL7Service

Parameters:

hl7InArchive - the archived item to delete

Throws:

APIException

See Also:

HL7Service.purgeHL7InArchive(org.openmrs.hl7.HL7InArchive)

saveHL7InArchive

public HL7InArchive saveHL7InArchive(HL7InArchive hl7InArchive)
                              throws APIException

Description copied from interface: HL7Service

Save the given hl7 in archive to the database

Specified by:

saveHL7InArchive in interface HL7Service

Parameters:

hl7InArchive - the archive to save

Returns:

the saved archive item

Throws:

APIException

See Also:

HL7Service.saveHL7InArchive(org.openmrs.hl7.HL7InArchive)

getHL7InArchive

@Transactional(readOnly=true)
public HL7InArchive getHL7InArchive(Integer hl7InArchiveId)

Description copied from interface: HL7Service

Get the archive item with the given id, If hl7 archives were moved to the file system, you can't do a look up by hl7ArchiveId, instead call HL7Service.getHL7InArchiveByUuid(String)

Specified by:

getHL7InArchive in interface HL7Service

Parameters:

hl7InArchiveId - the id to search on

Returns:

the matching archive item

See Also:

HL7Service.getHL7InArchive(java.lang.Integer)

getAllHL7InErrors

@Transactional(readOnly=true)
public List<HL7InError> getAllHL7InErrors()
                                                                 throws APIException

Description copied from interface: HL7Service

Get all HL7InError items from the database

Specified by:

getAllHL7InErrors in interface HL7Service

Returns:

a List<HL7InError> object with all HL7InError items from the database

Throws:

APIException

See Also:

HL7Service.getAllHL7InErrors()

purgeHL7InError

public void purgeHL7InError(HL7InError hl7InError)
                     throws APIException

Description copied from interface: HL7Service

Completely remove this error item from the database

Specified by:

purgeHL7InError in interface HL7Service

Parameters:

hl7InError - the item to remove

Throws:

APIException

See Also:

HL7Service.purgeHL7InError(org.openmrs.hl7.HL7InError)

saveHL7InError

public HL7InError saveHL7InError(HL7InError hl7InError)
                          throws APIException

Description copied from interface: HL7Service

Save the given error item to the database

Specified by:

saveHL7InError in interface HL7Service

Parameters:

hl7InError - the item to save

Returns:

the saved item

Throws:

APIException

See Also:

HL7Service.saveHL7InError(org.openmrs.hl7.HL7InError)

getHL7InError

@Transactional(readOnly=true)
public HL7InError getHL7InError(Integer hl7InErrorId)

Description copied from interface: HL7Service

Get the error item with the given id

Specified by:

getHL7InError in interface HL7Service

Parameters:

hl7InErrorId - the id to search on

Returns:

the matching error item

See Also:

HL7Service.getHL7InError(java.lang.Integer)

getHL7InErrorByUuid

@Transactional(readOnly=true)
public HL7InError getHL7InErrorByUuid(String uuid)
                                                             throws APIException

Description copied from interface: HL7Service

Get the error item with the given uuid

Specified by:

getHL7InErrorByUuid in interface HL7Service

Returns:

the HL7InError or null

Throws:

APIException

resolveUserId

@Transactional(readOnly=true)
public Integer resolveUserId(ca.uhn.hl7v2.model.v25.datatype.XCN xcn)
                                                    throws ca.uhn.hl7v2.HL7Exception

Specified by:

resolveUserId in interface HL7Service

Parameters:

xcn - HL7 component of data type XCN (extended composite ID number and name for persons) (see HL7 2.5 manual Ch.2A.86)

Returns:

Internal ID # of the specified user, or null if that user can't be found or is ambiguous

Throws:

ca.uhn.hl7v2.HL7Exception

resolvePersonId

@Transactional(readOnly=true)
public Integer resolvePersonId(ca.uhn.hl7v2.model.v25.datatype.XCN xcn)
                                                      throws ca.uhn.hl7v2.HL7Exception

Specified by:

resolvePersonId in interface HL7Service

Parameters:

xcn - HL7 component of data type XCN (extended composite ID number and name for persons) (see HL7 2.5 manual Ch.2A.86)

Returns:

Internal ID # of the specified person, or null if that person can't be found or is ambiguous

Throws:

ca.uhn.hl7v2.HL7Exception

See Also:

HL7Service.resolvePersonId(ca.uhn.hl7v2.model.v25.datatype.XCN)

resolveLocationId

@Transactional(readOnly=true)
public Integer resolveLocationId(ca.uhn.hl7v2.model.v25.datatype.PL pl)
                                                        throws ca.uhn.hl7v2.HL7Exception

Description copied from interface: HL7Service

Resolves location from person location object, and if location id is specified then returns correspond internal identifier of the specified location. If only location_name is specified, it tries to return location internal identifier by given name

Specified by:

resolveLocationId in interface HL7Service

Parameters:

pl - HL7 component of data type PL (person location) (see Ch 2.A.53)

Returns:

internal identifier of the specified location, or null if it is not found or ambiguous

Throws:

ca.uhn.hl7v2.HL7Exception

resolvePatientId

@Transactional(readOnly=true)
public Integer resolvePatientId(ca.uhn.hl7v2.model.v25.segment.PID pid)
                                                       throws ca.uhn.hl7v2.HL7Exception

Specified by:

resolvePatientId in interface HL7Service

Parameters:

pid - A PID segment of an hl7 message

Returns:

The internal id number of the Patient described by the PID segment, or null of the patient is not found, or if the PID segment is ambiguous

Throws:

ca.uhn.hl7v2.HL7Exception

resolvePersonFromIdentifiers

@Transactional(readOnly=true)
public Person resolvePersonFromIdentifiers(ca.uhn.hl7v2.model.v25.datatype.CX[] identifiers)
                                                                  throws ca.uhn.hl7v2.HL7Exception

Description copied from interface: HL7Service

determines a person (or patient) based on identifiers from a CX array, as found in a PID or NK1 segment; the first resolving identifier in the list wins

Specified by:

resolvePersonFromIdentifiers in interface HL7Service

Parameters:

identifiers - CX identifier list from an identifier (either PID or NK1)

Returns:

The internal id number of the Patient based on one of the given identifiers, or null if the patient is not found

Throws:

ca.uhn.hl7v2.HL7Exception

garbageCollect

public void garbageCollect()

Description copied from interface: HL7Service

Clean up the current memory consumption

Specified by:

garbageCollect in interface HL7Service

See Also:

HL7Service.garbageCollect()

processHL7InQueue

public HL7InQueue processHL7InQueue(HL7InQueue hl7InQueue)
                             throws ca.uhn.hl7v2.HL7Exception

Description copied from interface: HL7Service

Process the given HL7InQueue item.
If an error occurs while processing, a new HL7InError is created and saved.
If no error occurs, a new HL7InArchive is created and saved.
The given HL7InQueue is removed from the hl7 in queue table regardless of success or failure of the processing.

Specified by:

processHL7InQueue in interface HL7Service

Parameters:

hl7InQueue - the HL7InQueue to parse and save all encounters/obs to the db

Returns:

the processed HL7InQueue Should create HL7InArchive after successful parsing Should create HL7InError after failed parsing Should fail if given inQueue is already marked as processing Should parse oru r01 message using overridden parser provided by a module

Throws:

ca.uhn.hl7v2.HL7Exception

See Also:

HL7Service.processHL7InQueue(org.openmrs.hl7.HL7InQueue)

parseHL7String

public ca.uhn.hl7v2.model.Message parseHL7String(String hl7Message)
                                          throws ca.uhn.hl7v2.HL7Exception

Description copied from interface: HL7Service

Parses the given string and returns the resulting Message

Specified by:

parseHL7String in interface HL7Service

Parameters:

hl7Message - the hl7 string to parse and save

Returns:

the Message that the given hl7 string represents

Throws:

ca.uhn.hl7v2.HL7Exception

See Also:

HL7Service.parseHL7String(String)

getHL7InArchiveByUuid

@Transactional(readOnly=true)
public HL7InArchive getHL7InArchiveByUuid(String uuid)
                                                                 throws APIException

Description copied from interface: HL7Service

Get the archive item with the given uuid

Specified by:

getHL7InArchiveByUuid in interface HL7Service

Parameters:

uuid - to search on

Returns:

the archive with the matching uuid if any found

Throws:

APIException

See Also:

HL7Service.getHL7InArchiveByUuid(java.lang.String)

processHL7Message

public ca.uhn.hl7v2.model.Message processHL7Message(ca.uhn.hl7v2.model.Message message)
                                             throws ca.uhn.hl7v2.HL7Exception

Description copied from interface: HL7Service

Parses the given Message and saves the resulting content to the database

Specified by:

processHL7Message in interface HL7Service

Parameters:

message - the Message to process and save to the db.

Returns:

the processed message

Throws:

ca.uhn.hl7v2.HL7Exception

See Also:

HL7Service.processHL7Message(ca.uhn.hl7v2.model.Message)

setHL7Handlers

public void setHL7Handlers(Map<String,ca.uhn.hl7v2.app.Application> handlers)

Sets the given handlers as router applications that are available to HAPI when it is parsing an hl7 message.
This method is usually used by Spring and the handlers are set in the applicationContext-server.xml method.
The key in the map is a string like "ORU_R01" where the first part is the message type and the second is the trigger event.

Parameters:

handlers - a map from MessageName to Application object

createPersonFromNK1

public Person createPersonFromNK1(ca.uhn.hl7v2.model.v25.segment.NK1 nk1)
                           throws ca.uhn.hl7v2.HL7Exception

Description copied from interface: HL7Service

creates a Person from information held in an NK1 segment; if valid PatientIdentifiers exist, a Patient will be created and returned

Specified by:

createPersonFromNK1 in interface HL7Service

Parameters:

nk1 - the NK1 segment with person information

Returns:

the newly formed (but not saved) person

Throws:

ca.uhn.hl7v2.HL7Exception - Should return a saved new person Should return a Patient if valid patient identifiers exist Should fail if a person with the same UUID exists Should fail on an invalid gender Should fail if no gender specified Should fail if no birthdate specified

See Also:

HL7Service.createPersonFromNK1(ca.uhn.hl7v2.model.v25.segment.NK1)

getUuidFromIdentifiers

public String getUuidFromIdentifiers(ca.uhn.hl7v2.model.v25.datatype.CX[] identifiers)
                              throws ca.uhn.hl7v2.HL7Exception

Description copied from interface: HL7Service

finds a UUID from an array of identifiers

Specified by:

getUuidFromIdentifiers in interface HL7Service

Returns:

the UUID or null

Throws:

ca.uhn.hl7v2.HL7Exception - Should return null if no UUID found Should find a UUID in any position of the array Should not fail if multiple similar UUIDs exist in identifiers Should not fail if no assigning authority is found Should fail if multiple different UUIDs exist in identifiers

See Also:

HL7Service.getUuidFromIdentifiers(ca.uhn.hl7v2.model.v25.datatype.CX[])

loadHL7InArchiveData

public void loadHL7InArchiveData(List<HL7InArchive> archives)
                          throws APIException

Description copied from interface: HL7Service

Loads data for a list of HL7 archives from the filesystem

Specified by:

loadHL7InArchiveData in interface HL7Service

Throws:

APIException

See Also:

HL7Service.loadHL7InArchiveData(List)

loadHL7InArchiveData

public void loadHL7InArchiveData(HL7InArchive archive)
                          throws APIException

Description copied from interface: HL7Service

Loads HL7 data from the filesystem for an archived HL7InArchive

Specified by:

loadHL7InArchiveData in interface HL7Service

Throws:

APIException

See Also:

HL7Service.loadHL7InArchiveData(HL7InArchive)

migrateHl7InArchivesToFileSystem

public void migrateHl7InArchivesToFileSystem(Map<String,Integer> progressStatusMap)
                                      throws APIException

Description copied from interface: HL7Service

Method is called by the archives migration thread to transfer hl7 in archives from the hl7_in_archives database table to the file system

Specified by:

migrateHl7InArchivesToFileSystem in interface HL7Service

Parameters:

progressStatusMap - the map holding the number of archives transferred and failed transfers

Throws:

APIException

See Also:

HL7Service.migrateHl7InArchivesToFileSystem(Map)

getHl7QueueItemByUuid

@Transactional(readOnly=true)
public HL7QueueItem getHl7QueueItemByUuid(String uuid)
                                                                 throws APIException

Description copied from interface: HL7Service

Get HL7QueueItem with the given uuid.

It calls HL7Service.getHL7InQueueByUuid(String), HL7Service.getHL7InArchiveByUuid(String) and HL7Service.getHL7InErrorByUuid(String) consecutively and returns the first non-null result.

Specified by:

getHl7QueueItemByUuid in interface HL7Service

Returns:

the queue item or null

Throws:

APIException