org.openmrs.hl7
Interface HL7Service

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

HL7ServiceImpl

@Transactional
public interface HL7Service
extends OpenmrsService

OpenMRS HL7 API

Method Summary

void	createHL7InArchive(HL7InArchive hl7InArchive) Deprecated. use saveHL7InArchive(HL7InArchive)
void	createHL7InError(HL7InError hl7InError) Deprecated. use saveHL7InError(HL7InError)
void	createHL7InQueue(HL7InQueue hl7InQueue) Deprecated. use saveHL7InQueue(HL7InQueue)
void	createHL7Source(HL7Source hl7Source) Deprecated. use saveHL7Source(HL7Source)
void	deleteHL7InArchive(HL7InArchive hl7InArchive) Deprecated. use purgeHL7InArchive(HL7InArchive)
void	deleteHL7InError(HL7InError hl7InError) Deprecated. use purgeHL7InError(HL7InError)
void	deleteHL7InQueue(HL7InQueue hl7InQueue) Deprecated. use purgeHL7InQueue(HL7InQueue)
void	deleteHL7Source(HL7Source hl7Source) Deprecated. use purgeHL7Source(HL7Source)
void	encounterCreated(Encounter encounter) Deprecated. This method is no longer needed. When an encounter is created in the ROUR01 handler, it is created with all obs. Any AOP hooking should be done on the EncounterService.createEncounter(Encounter) method
void	garbageCollect() Clean up the current memory consumption
java.util.List<HL7InArchive>	getAllHL7InArchives() Get all archive hl7 queue items from the database
java.util.List<HL7InError>	getAllHL7InErrors() Get all hl7 in error items from the database
java.util.List<HL7InQueue>	getAllHL7InQueues() Return a list of all hl7 in queues in the database
java.util.List<HL7Source>	getAllHL7Sources() Get all of the hl7 source objects from the database.
HL7InArchive	getHL7InArchive(java.lang.Integer hl7InArchiveId) Get the archive item with the given id
java.util.Collection<HL7InArchive>	getHL7InArchives() Deprecated. use getAllHL7InArchives()
HL7InError	getHL7InError(java.lang.Integer hl7InErrorId) Get the error item with the given id
java.util.Collection<HL7InError>	getHL7InErrors() Deprecated. use getAllHL7InErrors()
HL7InQueue	getHL7InQueue(java.lang.Integer hl7InQueueId) Get the hl7 queue item with the given primary key id
java.util.Collection<HL7InQueue>	getHL7InQueues() Deprecated. use getAllHL7InQueues()
HL7Source	getHL7Source(java.lang.Integer hl7SourceId) Auto generated method comment
HL7Source	getHL7Source(java.lang.String name) Deprecated. use getHL7SourceByName(String)
HL7Source	getHL7SourceByName(java.lang.String name) Get the hl7 source object from the database that has the given name
java.util.Collection<HL7Source>	getHL7Sources() Deprecated. use getAllHL7Sources()
HL7InQueue	getNextHL7InQueue() Get the first queue item in 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.
java.lang.Integer	resolveLocationId(ca.uhn.hl7v2.model.v25.datatype.PL pl)
java.lang.Integer	resolvePatientId(ca.uhn.hl7v2.model.v25.segment.PID pid)
java.lang.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	updateHL7InArchive(HL7InArchive hl7InArchive) Deprecated. use saveHL7InArchive(HL7InArchive)
void	updateHL7InError(HL7InError hl7InError) Deprecated. use saveHL7InError(HL7InError)
void	updateHL7Source(HL7Source hl7Source) Deprecated. use saveHL7Source(HL7Source)

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setHL7DAO

void setHL7DAO(HL7DAO dao)

Auto generated method comment

Parameters:

dao -

saveHL7Source

@Authorized(value="Update HL7 Source")
HL7Source saveHL7Source(HL7Source hl7Source)
                        throws APIException

Save the given hl7Source to the database

Parameters:

hl7Source - the source to save

Returns:

the saved source

Throws:

APIException

createHL7Source

@Authorized(value="Update HL7 Source")
void createHL7Source(HL7Source hl7Source)
                     throws APIException

Deprecated. use saveHL7Source(HL7Source)

Throws:

APIException

getHL7Source

@Transactional(readOnly=true)
@Authorized(value="View HL7 Source")
HL7Source getHL7Source(java.lang.Integer hl7SourceId)
                       throws APIException

Auto generated method comment

Parameters:

hl7SourceId -

Returns:

Throws:

APIException

getHL7SourceByName

@Transactional(readOnly=true)
@Authorized(value="View HL7 Source")
HL7Source getHL7SourceByName(java.lang.String name)
                             throws APIException

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

Parameters:

name - string to 'search' on

Returns:

hl7 source object

Throws:

APIException

getHL7Source

@Transactional(readOnly=true)
@Authorized(value="View HL7 Source")
HL7Source getHL7Source(java.lang.String name)

Deprecated. use getHL7SourceByName(String)

getAllHL7Sources

@Transactional(readOnly=true)
@Authorized(value="View HL7 Source")
java.util.List<HL7Source> getAllHL7Sources()
                                           throws APIException

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

Returns:

list of hl7 source objects

Throws:

APIException

getHL7Sources

@Transactional(readOnly=true)
@Authorized(value="View HL7 Source")
java.util.Collection<HL7Source> getHL7Sources()

Deprecated. use getAllHL7Sources()

updateHL7Source

@Authorized(value="Update HL7 Source")
void updateHL7Source(HL7Source hl7Source)

Deprecated. use saveHL7Source(HL7Source)

retireHL7Source

@Authorized(value="Update HL7 Source")
HL7Source retireHL7Source(HL7Source hl7Source)
                          throws APIException

Mark the given hl7Source as no longer active

Parameters:

hl7Source - the source to retire

Returns:

the retired source

Throws:

APIException

purgeHL7Source

@Authorized(value="Purge HL7 Source")
void purgeHL7Source(HL7Source hl7Source)
                    throws APIException

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

Parameters:

hl7Source -

Throws:

APIException

deleteHL7Source

@Authorized(value="Update HL7 Source")
void deleteHL7Source(HL7Source hl7Source)

Deprecated. use purgeHL7Source(HL7Source)

See Also:

retireHL7Source(HL7Source)

saveHL7InQueue

@Authorized(value={"Update HL7 Inbound Queue","Add HL7 Inbound Queue"},
            requireAll=false)
HL7InQueue saveHL7InQueue(HL7InQueue hl7InQueue)
                          throws APIException

Save the given hl7InQueue to the database

Parameters:

hl7InQueue - the queue item to save

Returns:

the saved queue item

Throws:

APIException

createHL7InQueue

@Authorized(value="Add HL7 Inbound Queue")
void createHL7InQueue(HL7InQueue hl7InQueue)

Deprecated. use saveHL7InQueue(HL7InQueue)

getHL7InQueue

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Queue")
HL7InQueue getHL7InQueue(java.lang.Integer hl7InQueueId)
                         throws APIException

Get the hl7 queue item with the given primary key id

Parameters:

hl7InQueueId - the id to search on

Returns:

the desired hl7InQueue object or null if none found

Throws:

APIException

getAllHL7InQueues

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Queue")
java.util.List<HL7InQueue> getAllHL7InQueues()
                                             throws APIException

Return a list of all hl7 in queues in the database

Returns:

all hl7 queue items

Throws:

APIException

getHL7InQueues

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Queue")
java.util.Collection<HL7InQueue> getHL7InQueues()

Deprecated. use getAllHL7InQueues()

getNextHL7InQueue

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Queue")
HL7InQueue getNextHL7InQueue()
                             throws APIException

Get the first queue item in the database

Returns:

the first queue item

Throws:

APIException

purgeHL7InQueue

@Authorized(value="Purge HL7 Inbound Queue")
void purgeHL7InQueue(HL7InQueue hl7InQueue)

Completely delete the hl7 in queue item from the database.

Parameters:

hl7InQueue -

deleteHL7InQueue

@Authorized(value="Delete HL7 Inbound Queue")
void deleteHL7InQueue(HL7InQueue hl7InQueue)

Deprecated. use purgeHL7InQueue(HL7InQueue)

saveHL7InArchive

@Authorized(value={"Update HL7 Inbound Archive","Add HL7 Inbound Archive"},
            requireAll=false)
HL7InArchive saveHL7InArchive(HL7InArchive hl7InArchive)
                              throws APIException

Save the given hl7 in archive to the database

Parameters:

hl7InArchive - the archive to save

Returns:

the saved archive item

Throws:

APIException

createHL7InArchive

@Authorized(value="Add HL7 Inbound Archive")
void createHL7InArchive(HL7InArchive hl7InArchive)

Deprecated. use saveHL7InArchive(HL7InArchive)

getHL7InArchive

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Archive")
HL7InArchive getHL7InArchive(java.lang.Integer hl7InArchiveId)

Get the archive item with the given id

Parameters:

hl7InArchiveId - the id to search on

Returns:

the matching archive item

getAllHL7InArchives

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Archive")
java.util.List<HL7InArchive> getAllHL7InArchives()
                                                 throws APIException

Get all archive hl7 queue items from the database

Returns:

list of archive items

Throws:

APIException

getHL7InArchives

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Archive")
java.util.Collection<HL7InArchive> getHL7InArchives()

Deprecated. use getAllHL7InArchives()

updateHL7InArchive

@Authorized(value="Update HL7 Inbound Archive")
void updateHL7InArchive(HL7InArchive hl7InArchive)

Deprecated. use saveHL7InArchive(HL7InArchive)

purgeHL7InArchive

@Authorized(value="Purge HL7 Inbound Archive")
void purgeHL7InArchive(HL7InArchive hl7InArchive)
                       throws APIException

Completely delete the hl7 in archive item from the database

Parameters:

hl7InArchive - the archived item to delete

Throws:

APIException

deleteHL7InArchive

@Authorized(value="Delete HL7 Inbound Archive")
void deleteHL7InArchive(HL7InArchive hl7InArchive)

Deprecated. use purgeHL7InArchive(HL7InArchive)

saveHL7InError

@Authorized(value={"Update HL7 Inbound Exception","Add HL7 Inbound Exception"},
            requireAll=false)
HL7InError saveHL7InError(HL7InError hl7InError)
                          throws APIException

Save the given error item to the database

Parameters:

hl7InError - the item to save

Returns:

the saved item

Throws:

APIException

createHL7InError

@Authorized(value="Add HL7 Inbound Exception")
void createHL7InError(HL7InError hl7InError)

Deprecated. use saveHL7InError(HL7InError)

getHL7InError

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Exception")
HL7InError getHL7InError(java.lang.Integer hl7InErrorId)
                         throws APIException

Get the error item with the given id

Parameters:

hl7InErrorId - the id to search on

Returns:

the matching error item

Throws:

APIException

getAllHL7InErrors

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Exception")
java.util.List<HL7InError> getAllHL7InErrors()
                                             throws APIException

Get all hl7 in error items from the database

Returns:

Throws:

APIException

getHL7InErrors

@Transactional(readOnly=true)
@Authorized(value="View HL7 Inbound Exception")
java.util.Collection<HL7InError> getHL7InErrors()

Deprecated. use getAllHL7InErrors()

updateHL7InError

@Authorized(value="Update HL7 Inbound Exception")
void updateHL7InError(HL7InError hl7InError)

Deprecated. use saveHL7InError(HL7InError)

purgeHL7InError

@Authorized(value="Purge HL7 Inbound Exception")
void purgeHL7InError(HL7InError hl7InError)
                     throws APIException

Completely remove this error item from the database

Parameters:

hl7InError - the item to remove

Throws:

APIException

deleteHL7InError

@Authorized(value="Delete HL7 Inbound Exception")
void deleteHL7InError(HL7InError hl7InError)

Deprecated. use purgeHL7InError(HL7InError)

resolveUserId

java.lang.Integer resolveUserId(ca.uhn.hl7v2.model.v25.datatype.XCN xcn)
                                throws ca.uhn.hl7v2.HL7Exception

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

resolveLocationId

java.lang.Integer resolveLocationId(ca.uhn.hl7v2.model.v25.datatype.PL pl)
                                    throws ca.uhn.hl7v2.HL7Exception

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

java.lang.Integer resolvePatientId(ca.uhn.hl7v2.model.v25.segment.PID pid)
                                   throws ca.uhn.hl7v2.HL7Exception

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

garbageCollect

void garbageCollect()

Clean up the current memory consumption

encounterCreated

void encounterCreated(Encounter encounter)

Deprecated. This method is no longer needed. When an encounter is created in the ROUR01 handler, it is created with all obs. Any AOP hooking should be done on the EncounterService.createEncounter(Encounter) method

This method is called after an encounter and its obs are created. This method can be removed once we have obs groups being created correctly

Parameters:

encounter -