public interface HubServiceComplete
HubService
that will return the WS response object directly, so that you can retrieve the full error messages,
codes,... received from the WS.
See HubService
for further information
Pre-requisites
HubServiceCompleteImpl
Factory : HubSessionServiceFactory
Modifier and Type | Method and Description |
---|---|
DeclareTransactionResponse |
declareTransaction(KmehrHeaderDeclareTransaction kmehrHeader)
This operation should be used to declare a transaction within a hub.
|
GetAccessRightResponse |
getAccessRight(TransactionIdType transaction)
This operation should be used to get access rights on a transaction within a hub.
|
GetHCPartyResponse |
getHCParty(HCPartyIdType hcParty)
This operation should be used to retrieve the data associated with a healthcare party within a hub.
|
GetHCPartyConsentResponse |
getHCPartyConsent(HCPartyIdType hcParty)
This operation should be used to retrieve the consent of a healthcare party within a hub.
|
GetPatientResponse |
getPatient(PatientIdType patient)
This operation should be used to declare the consent of an healthcare party within a hub.
|
GetPatientAuditTrailResponse |
getPatientAuditTrail(SelectGetPatientAuditTrailType patientAuditTrail)
This operation should be used to get the list of transaction accesses for a given patient.
|
GetPatientConsentResponse |
getPatientConsent(SelectGetPatientConsentType patientConsent)
This operation should be used to retrieve the consent of a patient within a hub.
|
GetTherapeuticLinkResponse |
getTherapeuticLink(SelectGetHCPartyPatientConsentType consent)
This operation should be used to get therapeutic link between a patient and a healthcare party within a hub.
|
GetTransactionResponse |
getTransaction(PatientIdType patient,
TransactionBaseType transaction)
This operation should be used to retrieve a transaction (given a transaction identifier) within a hub.
|
GetTransactionListResponse |
getTransactionList(PatientIdType patient,
LocalSearchType searchType,
TransactionWithPeriodType transaction)
This operation should be used to get the list of available transactions that fulfill some given criteria.
|
PutAccessRightResponse |
putAccessRight(AccessRightType accessRight)
This operation should be used to put an access right on a transaction within a hub.
|
PutHCPartyResponse |
putHCParty(HCPartyAdaptedType hcParty)
This operation should be used to create a healthcare party within a hub.
|
PutHCPartyConsentResponse |
putHCPartyConsent(ConsentHCPartyType consent)
This operation should be used to declare the consent of an healthcare party within a hub.
|
PutPatientResponse |
putPatient(PersonType patient)
This operation should be used to create a patient within a hub.
|
PutPatientConsentResponse |
putPatientConsent(ConsentType patientConsent)
This operation should be used to declare the consent of a patient within a hub.
|
PutTherapeuticLinkResponse |
putTherapeuticLink(TherapeuticLinkType therapeuticLink)
This operation should be used to declare therapeutic link between a patient and a healthcare party within a hub.
|
PutTransactionResponse |
putTransaction(Kmehrmessage msg)
This operation should be used to declare and to store a given transaction within a hub.
|
RequestPublicationResponse |
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.
|
RevokeAccessRightResponse |
revokeAccessRight(SelectRevokeAccessRightType accessRight)
This operation should be used to revoke access right on a transaction within a hub.
|
RevokeHCPartyConsentResponse |
revokeHCPartyConsent(ConsentHCPartyType consent)
This operation should be used to revoke the consent of a healthcare party within a hub.
|
RevokePatientConsentResponse |
revokePatientConsent(ConsentType patientConsent)
This operation should be used to revoke the consent of a patient within a hub.
|
RevokeTherapeuticLinkResponse |
revokeTherapeuticLink(TherapeuticLinkType therapeuticLink)
This operation should be used to revoke a therapeutic link between a patient and a healthcare party within a hub.
|
RevokeTransactionResponse |
revokeTransaction(PatientIdType patient,
TransactionIdType transaction)
This operation should be used to 'unpublish' a given transaction.
|
DeclareTransactionResponse declareTransaction(KmehrHeaderDeclareTransaction kmehrHeader) throws TechnicalConnectorException, SessionManagementException, IntraHubBusinessConnectorException
kmehrHeader
- A Kmehr message formatted as XML String containing a Patient and a Transaction.DeclareTransactionResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionSessionManagementException
IntraHubBusinessConnectorException
PutTransactionResponse putTransaction(Kmehrmessage msg) throws TechnicalConnectorException, IntraHubBusinessConnectorException
msg
- A Kmehr message formatted as XML String containing a Patient and a Transaction.PutTransactionResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
RevokeTransactionResponse revokeTransaction(PatientIdType patient, TransactionIdType transaction) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Patient for which to revoke the transaction.transaction
- Transaction to revoke.RevokeTransactionResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
GetTransactionListResponse 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.GetTransactionListResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionGetTransactionResponse getTransaction(PatientIdType patient, TransactionBaseType transaction) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Patient for which to retrieve the transaction.transaction
- Transaction identificationGetTransactionResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionRequestPublicationResponse requestPublication(PatientIdType patient, TransactionWithPeriodType transaction, String comment) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- The Patient for who the publication is.transaction
- Transaction types and Health Care Partiescomment
- CommentRequestPublicationResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionPutHCPartyResponse putHCParty(HCPartyAdaptedType hcParty) throws TechnicalConnectorException, IntraHubBusinessConnectorException
hcParty
- Information about the healthcare partyPutHCPartyResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionGetHCPartyResponse 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.GetHCPartyResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionPutPatientResponse putPatient(PersonType patient) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Information about a patientPutPatientResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionGetPatientResponse getPatient(PatientIdType patient) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patient
- Patient contains only the identifiers of the patient. Several identifiers of the same patient are allowed.GetPatientResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionPutHCPartyConsentResponse putHCPartyConsent(ConsentHCPartyType consent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
consent
- A Consent containing a HCParty and the signature date.PutHCPartyConsentResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionGetHCPartyConsentResponse 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.GetHCPartyConsentResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionRevokeHCPartyConsentResponse revokeHCPartyConsent(ConsentHCPartyType consent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
consent
- A Consent containing a HCParty and the signature date.RevokeHCPartyConsentResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
PutPatientConsentResponse 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.PutPatientConsentResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionGetPatientConsentResponse getPatientConsent(SelectGetPatientConsentType patientConsent) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patientConsent
- Contains the Patient Identifiers and the scope of the consentGetPatientConsentResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionRevokePatientConsentResponse 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.RevokePatientConsentResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionPutTherapeuticLinkResponse 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)).PutTherapeuticLinkResponse
the WS response objectSessionManagementException
- the session management exceptionConnectorException
GetTherapeuticLinkResponse getTherapeuticLink(SelectGetHCPartyPatientConsentType consent) throws SessionManagementException, ConnectorException
consent
- Contains the Patient Identifiers and the scope of the consentGetTherapeuticLinkResponse
the WS response objectSessionManagementException
- the session management exceptionConnectorException
RevokeTherapeuticLinkResponse revokeTherapeuticLink(TherapeuticLinkType therapeuticLink) throws TechnicalConnectorException, IntraHubBusinessConnectorException
therapeuticLink
- the therapeutic linkRevokeTherapeuticLinkResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionPutAccessRightResponse putAccessRight(AccessRightType accessRight) throws TechnicalConnectorException, IntraHubBusinessConnectorException
accessRight
- the access rightPutAccessRightResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionGetAccessRightResponse getAccessRight(TransactionIdType transaction) throws TechnicalConnectorException, IntraHubBusinessConnectorException
transaction
- A transaction ID Type containing the Transaction Identifier.GetAccessRightResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionRevokeAccessRightResponse revokeAccessRight(SelectRevokeAccessRightType accessRight) throws TechnicalConnectorException, IntraHubBusinessConnectorException
accessRight
- Contains a transaction and a HC PartyRevokeAccessRightResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exceptionGetPatientAuditTrailResponse getPatientAuditTrail(SelectGetPatientAuditTrailType patientAuditTrail) throws TechnicalConnectorException, IntraHubBusinessConnectorException
patientAuditTrail
- Contains the search parameters for the audit trail.GetPatientAuditTrailResponse
the WS response objectTechnicalConnectorException
- the technical connector exceptionIntraHubBusinessConnectorException
- the business connector exception
Connector Packaging PERSPHYSICIAN 4.5.4 API
Copyright © {inceptionYear}-2024 eHealth. All Rights Reserved.