Skip to content

refactor(xds-sender): route CCD retrieval through IPS, drop duplicate path #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mherman22 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(xds-sender): route CCD retrieval through IPS, drop duplicate path #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/src/main/java/org/openmrs/module/xdssender/XdsSenderConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,10 @@ public String getExportCcdEndpoint() {
return getProperty(XDSSENDER_EXPORT_CCD_ENDPOINT);
}

// Base URL of the consolidated IPS mediator (e.g. https://<openhim>/SHR/ips). Used to pull a
// patient's cross-facility summary by CRUID for continuity of care.
// Opt-in: empty by default so existing deployments keep the legacy CCD retrieval. Set this to
// the SHR IPS mediator base (e.g. https://<openhim>/SHR/ips) to enable IPS-based retrieval.
public String getIpsEndpoint() {
return getProperty(XDSSENDER_IPS_ENDPOINT);
return getProperty(XDSSENDER_IPS_ENDPOINT, "");
}

public String getLocalPatientIdRoot() { return getProperty("mpi-client.pid.local"); }
Expand Down
3 changes: 0 additions & 3 deletions api/src/main/java/org/openmrs/module/xdssender/api/service/CcdService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ public interface CcdService {
@Transactional
Ccd downloadAndSaveCcd(Patient patient) throws XDSException;

@Transactional
Ccd downloadAndSaveIps(Patient patient);

@Transactional(readOnly = true)
void downloadCcdAsPDF(OutputStream stream, Patient patient);
}
14 changes: 0 additions & 14 deletions api/src/main/java/org/openmrs/module/xdssender/api/service/impl/CcdServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,20 +129,6 @@ public Ccd downloadAndSaveCcd(Patient patient) throws XDSException {
return ccd;
}

@Override
public Ccd downloadAndSaveIps(Patient patient) {
Ccd ccd;

shrImportService.setFhirContext(fhirContext);
ccd = shrImportService.retrieveIps(patient);

if (ccd != null) {
ccd = ccdDao.saveOrUpdate(ccd);
}

return ccd;
}

@Override
public void downloadCcdAsPDF(OutputStream stream, Patient patient) {
LOGGER.info("CCD PDF is being downloaded.");
Expand Down
45 changes: 16 additions & 29 deletions api/src/main/java/org/openmrs/module/xdssender/api/service/impl/ShrImportServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,41 +42,28 @@ public void setFhirContext(FhirContext fhirContext) {
@Override
public Ccd retrieveCCD(Patient patient) {
Ccd ccd = null;
Bundle result;
Bundle result = null;
try {
shrRetriever.setFhirContext(this.getFhirContext());
result = shrRetriever.sendRetrieveCCD(patient);
// Prefer the consolidated IPS (server-side aggregation via the SHR IPS mediator) when an
// IPS endpoint is configured; otherwise, or if it yields nothing, fall back to the legacy
// client-side CCD aggregation so existing deployments keep working unchanged.
String ipsEndpoint = config.getIpsEndpoint();
if (ipsEndpoint != null && !ipsEndpoint.isEmpty()) {
result = shrRetriever.fetchIps(patient);
}
if (result == null || !result.hasEntry() || result.getEntry().isEmpty()) {
result = shrRetriever.sendRetrieveCCD(patient);
}
} catch (Exception e) {
LOGGER.error("Unable to load CCD content", e);
LOGGER.error("Unable to load CCD/IPS content", e);
return null;
}

if(result != null && result.hasTotal() && result.getTotal() > 0) {
ccd = new Ccd();
ccd.setPatient(patient);
ccd.setDocument(fhirContext.newJsonParser().encodeResourceToString(result));
}

return ccd;
}

/**
* Retrieve the consolidated IPS document for a patient from the SHR IPS mediator and wrap it as
* a Ccd (raw FHIR JSON), mirroring {@link #retrieveCCD(Patient)}. IPS document bundles carry no
* total, so presence is judged by entries.
*/
public Ccd retrieveIps(Patient patient) {
Ccd ccd = null;
Bundle result;
try {
shrRetriever.setFhirContext(this.getFhirContext());
result = shrRetriever.fetchIps(patient);
} catch (Exception e) {
LOGGER.error("Unable to load IPS content", e);
return null;
}

if (result != null && result.hasEntry() && !result.getEntry().isEmpty()) {
// Legacy CCD search bundles carry a total; IPS document bundles do not, so accept either.
boolean hasData = result != null && ((result.hasTotal() && result.getTotal() > 0)
|| (result.hasEntry() && !result.getEntry().isEmpty()));
if (hasData) {
ccd = new Ccd();
ccd.setPatient(patient);
ccd.setDocument(fhirContext.newJsonParser().encodeResourceToString(result));
Expand Down
56 changes: 0 additions & 56 deletions omod/src/main/java/org/openmrs/module/xdssender/web/controller/IpsRetrievalController.java
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions omod/src/main/resources/config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,7 @@

<globalProperty>
<property>xdssender.ipsEndpoint</property>
<defaultValue>https://openhimcore.sedishtest.live/SHR/ips</defaultValue>
<description>Base URL of the consolidated IPS mediator used to pull a patient's cross-facility summary by CRUID (continuity of care)</description>
<description>Base URL of the consolidated IPS mediator (e.g. https://&lt;openhim&gt;/SHR/ips). When set, patient retrieval (downloadAndSaveCcd) pulls the consolidated IPS by CRUID for continuity of care; when blank, the legacy client-side CCD aggregation is used.</description>
</globalProperty>

<globalProperty>
Expand Down