public interface HubService
As part of the Business Connector for General Practitioners, a Hub Consultation component is foreseen that provides connectivity to a local hub. As part of this component a set of 23 operations are available. They can be grouped as follows:
The Hub Consultation component, part of the Business Connector for General Practitioners, provides a simple API to access the wide range of hub operations. It hides the complexity on both functional and technical level (web service communication, simplified data interface, handles encryption/decryption, etc).
The following principles have been applied while defining the interface for the set of operations:
Pre-requisites
HubServiceImpl
Factory : HubSessionServiceFactory
Modifier and Type | Method and Description |
---|---|
List<IDKMEHR> |
declareTransaction(KmehrHeaderDeclareTransaction kmehrHeader)
This operation should be used to declare a transaction within a hub.
|
AccessRightListType |
getAccessRight(TransactionIdType transaction)
This operation should be used to get access rights on a transaction within a hub.
|
HCPartyAdaptedType |
getHCParty(HCPartyIdType hcParty)
This operation should be used to retrieve the data associated with a healthcare party within a hub.
|
ConsentHCPartyType |
getHCPartyConsent(HCPartyIdType hcParty)
This operation should be used to retrieve the consent of a healthcare party within a hub.
|
PersonType |
getPatient(PatientIdType patient)
This operation should be used to declare the consent of an healthcare party within a hub.
|
TransactionAccessListType |
getPatientAuditTrail(SelectGetPatientAuditTrailType patientAuditTrail)
This operation should be used to get the list of transaction accesses for a given patient.
|
ConsentType |
getPatientConsent(SelectGetPatientConsentType patientConsent)
This operation should be used to retrieve the consent of a patient within a hub.
|
Collection<TherapeuticLinkType> |
getTherapeuticLink(SelectGetHCPartyPatientConsentType consent)
This operation should be used to get therapeutic link between a patient and a healthcare party within a hub.
|
Kmehrmessage |
getTransaction(PatientIdType patient,
TransactionBaseType transaction)
This operation should be used to retrieve a transaction (given a transaction identifier) within a hub.
|
KmehrHeaderGetTransactionList |
getTransactionList(PatientIdType patient,
LocalSearchType searchType,
TransactionWithPeriodType transaction)
This operation should be used to get the list of available transactions that fulfill some given criteria.
|
void |
putAccessRight(AccessRightType accessRight)
This operation should be used to put an access right on a transaction within a hub.
|
HCPartyAdaptedType |
putHCParty(HCPartyAdaptedType hcParty)
This operation should be used to create a healthcare party within a hub.
|
void |
putHCPartyConsent(ConsentHCPartyType consent)
This operation should be used to declare the consent of an healthcare party within a hub.
|
PersonType |
putPatient(PersonType patient)
This operation should be used to create a patient within a hub.
|
void |
putPatientConsent(ConsentType patientConsent)
This operation should be used to declare the consent of a patient within a hub.
|
void |
putTherapeuticLink(TherapeuticLinkType therapeuticLink)
This operation should be used to declare therapeutic link between a patient and a healthcare party within a hub.
|
void |
putTransaction(Kmehrmessage msg)
This operation should be used to declare and to store a given transaction within a hub.
|
void |
requestPublication(PatientIdType patient,
TransactionWithPeriodType transaction,
String comment)
This operation allows a healthcare party to ask to another healthcare party to publish documents related to a patient.
|
void |
revokeAccessRight(SelectRevokeAccessRightType accessRight)
This operation should be used to revoke access right on a transaction within a hub.
|
void |
revokeHCPartyConsent(ConsentHCPartyType consent)
This operation should be used to revoke the consent of a healthcare party within a hub.
|
void |
revokePatientConsent(ConsentType patientConsent)
This operation should be used to revoke the consent of a patient within a hub.
|
void |
revokeTherapeuticLink(TherapeuticLinkType therapeuticLink)
This operation should be used to revoke a therapeutic link between a patient and a healthcare party within a hub.
|
void |
revokeTransaction(PatientIdType patient,
TransactionIdType transaction)
This operation should be used to 'unpublish' a given transaction.
|
List<IDKMEHR> declareTransaction(KmehrHeaderDeclareTransaction kmehrHeader) throws TechnicalConnectorException, SessionManagementException, IntraHubBusinessConnectorException
kmehrHeader
- A Kmehr message formatted as XML String containing a Patient and a Transaction.TechnicalConnectorException
- the technical connector exceptionSessionManagementException
IntraHubBusinessConnectorException
void putTransaction(Kmehrmessage msg) throws TechnicalConnectorException, IntraHubBusinessConnectorException
msg
- A Kmehr message formatted as XML String containing a Patient and a Transaction.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
void revokeTransaction(PatientIdType patient, TransactionIdType transaction) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Patient for which to revoke the transaction.transaction
- Transaction to revoke.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
KmehrHeaderGetTransactionList getTransactionList(PatientIdType patient, LocalSearchType searchType, TransactionWithPeriodType transaction) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Patient for which to retrieve the transaction list.searchType
- The search type (local or national)transaction
- Transaction types to search.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionKmehrmessage getTransaction(PatientIdType patient, TransactionBaseType transaction) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Patient for which to retrieve the transaction.transaction
- Transaction identificationTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionvoid requestPublication(PatientIdType patient, TransactionWithPeriodType transaction, String comment) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- The Patient for who the ation is.transaction
- Transaction types and Health Care Partiescomment
- CommentTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionHCPartyAdaptedType putHCParty(HCPartyAdaptedType hcParty) throws TechnicalConnectorException, IntraHubBusinessConnectorException
hcParty
- Information about the healthcare partyTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionHCPartyAdaptedType getHCParty(HCPartyIdType hcParty) throws TechnicalConnectorException, IntraHubBusinessConnectorException
hcParty
- This is the NIHII or SSIN number according to the type of healthcare party. Other local identifiers are allowed.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionPersonType putPatient(PersonType patient) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Information about a patientTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionPersonType getPatient(PatientIdType patient) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Patient contains only the identifiers of the patient. Several identifiers of the same patient are allowed.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionvoid putHCPartyConsent(ConsentHCPartyType consent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
consent
- A Consent containing a HCParty and the signature date.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionConsentHCPartyType getHCPartyConsent(HCPartyIdType hcParty) throws TechnicalConnectorException, IntraHubBusinessConnectorException
hcParty
- This is the NIHII or INSS number according to the type of healthcare party. Other local identifiers are allowed.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionvoid revokeHCPartyConsent(ConsentHCPartyType consent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
consent
- A Consent containing a HCParty and the signature date.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
void putPatientConsent(ConsentType patientConsent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patientConsent
- Patient Consent data structure that contains signing date of the consent, scope of the consent,
'retrospective'/ 'prospective' attribute.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionConsentType getPatientConsent(SelectGetPatientConsentType patientConsent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patientConsent
- Contains the Patient Identifiers and the scope of the consentTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionvoid revokePatientConsent(ConsentType patientConsent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patientConsent
- Patient Consent data structure that contains signing date of the consent, scope of the consent, 'retrospective'
'prospective' attribute.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionvoid putTherapeuticLink(TherapeuticLinkType therapeuticLink) throws ConnectorException, SessionManagementException
therapeuticLink
- A Therapeutic link containing Patient Identifier, HCP identifier, Link type, link start date , link end date
(optional), comment (optional)).SessionManagementException
- the session management exceptionConnectorException
Collection<TherapeuticLinkType> getTherapeuticLink(SelectGetHCPartyPatientConsentType consent) throws SessionManagementException, ConnectorException
consent
- Contains the Patient Identifiers and the scope of the consentSessionManagementException
- the session management exceptionConnectorException
void revokeTherapeuticLink(TherapeuticLinkType therapeuticLink) throws TechnicalConnectorException, IntraHubBusinessConnectorException
therapeuticLink
- the therapeutic linkTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionvoid putAccessRight(AccessRightType accessRight) throws TechnicalConnectorException, IntraHubBusinessConnectorException
accessRight
- the access rightTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionAccessRightListType getAccessRight(TransactionIdType transaction) throws TechnicalConnectorException, IntraHubBusinessConnectorException
transaction
- A transaction ID Type containing the Transaction Identifier.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionvoid revokeAccessRight(SelectRevokeAccessRightType accessRight) throws TechnicalConnectorException, IntraHubBusinessConnectorException
accessRight
- Contains a transaction and a HC PartyTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionTransactionAccessListType getPatientAuditTrail(SelectGetPatientAuditTrailType patientAuditTrail) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patientAuditTrail
- Contains the search parameters for the audit trail.TechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exception
Connector Packaging PERSPHYSICIAN 4.5.4 API
Copyright © {inceptionYear}-2024 eHealth. All Rights Reserved.