IHE gateway v2: adding support for telecoms, ssns, multiple names and addresses + adding types

packages/api/src/external/carequality/create-outbound-patient-discovery-req.ts

@@ -1,18 +1,21 @@
-import { Patient as FHIRPatient } from "@medplum/fhirtypes";
-import { OutboundPatientDiscoveryReq, XCPDGateway } from "@metriport/ihe-gateway-sdk";
+import {
+  OutboundPatientDiscoveryReq,
+  XCPDGateway,
+  PatientResource,
+} from "@metriport/ihe-gateway-sdk";
 import dayjs from "dayjs";
 import { HieInitiator } from "../hie/get-hie-initiator";
 import { createPurposeOfUse, getSystemUserName } from "./shared";
 
 export function createOutboundPatientDiscoveryReq({
-  patient,
+  patientResource,
   cxId,
   patientId,
   xcpdGateways,
   initiator,
   requestId,
 }: {
-  patient: FHIRPatient;
+  patientResource: PatientResource;
   cxId: string;
   patientId: string;
   xcpdGateways: XCPDGateway[];
@@ -41,6 +44,6 @@ export function createOutboundPatientDiscoveryReq({
       homeCommunityId: initiator.oid,
       purposeOfUse: createPurposeOfUse(),
     },
-    patientResource: patient,
+    patientResource,
   };
 }

packages/api/src/external/carequality/patient.ts

@@ -1,5 +1,5 @@
 import { Patient, PatientExternalData } from "@metriport/core/domain/patient";
-import { toFHIR } from "@metriport/core/external/fhir/patient/index";
+import { toIheGatewayPatientResource } from "@metriport/core/external/fhir/patient/index";
 import { MedicalDataSource } from "@metriport/core/external/index";
 import { processAsyncError } from "@metriport/core/util/error/shared";
 import { out } from "@metriport/core/util/log";
@@ -113,15 +113,15 @@ async function prepareForPatientDiscovery(
   pdRequestGatewayV1: OutboundPatientDiscoveryReq;
   pdRequestGatewayV2: OutboundPatientDiscoveryReq;
 }> {
-  const fhirPatient = toFHIR(patient);
+  const patientResource = toIheGatewayPatientResource(patient);
 
   const [{ v1Gateways, v2Gateways }, initiator] = await Promise.all([
     gatherXCPDGateways(patient),
     getCqInitiator(patient, facilityId),
   ]);
 
   const pdRequestGatewayV1 = createOutboundPatientDiscoveryReq({
-    patient: fhirPatient,
+    patientResource,
     cxId: patient.cxId,
     patientId: patient.id,
     xcpdGateways: v1Gateways,
@@ -130,7 +130,7 @@ async function prepareForPatientDiscovery(
   });
 
   const pdRequestGatewayV2 = createOutboundPatientDiscoveryReq({
-    patient: fhirPatient,
+    patientResource,
     cxId: patient.cxId,
     patientId: patient.id,
     xcpdGateways: v2Gateways,

packages/core/src/external/carequality/ihe-gateway-v2/gateways.ts

@@ -24,13 +24,6 @@ const redoxGatewayOid = "2.16.840.1.113883.3.6147.458.2";
  */
 const gatewaysThatAcceptOneDocRefPerRequest = [pointClickCareOid, redoxOid, redoxGatewayOid];
 
-/*
- * These gateways require that the home community ID in the DR request is the same as the one
- * in the gateway. But these gateways also return different home community IDs in the DQ response
- * than in the gateway. So we need to handle this and use the request home community ID instead of the response.
- */
-const enforceSameHomeCommunityIdList = [pointClickCareOid, redoxOid, redoxGatewayOid];
-
 function requiresMetriportOidInsteadOfInitiatorOid(gateway: XCPDGateway | XCAGateway): boolean {
   return requiresMetriportOidUrl.includes(gateway.url);
 }
@@ -51,7 +44,3 @@ export function requiresUrnInSoapBody(gateway: XCPDGateway): boolean {
 export function requiresOnlyOneDocRefPerRequest(gateway: XCAGateway): boolean {
   return gatewaysThatAcceptOneDocRefPerRequest.includes(gateway.homeCommunityId);
 }
-
-export function requiresRequestHomeCommunityId(gateway: XCAGateway): boolean {
-  return enforceSameHomeCommunityIdList.includes(gateway.homeCommunityId);
-}

packages/core/src/external/carequality/ihe-gateway-v2/outbound/__tests__/constants.ts

@@ -50,6 +50,42 @@ export const outboundXcpdRequest: OutboundPatientDiscoveryReq = {
   ],
 };
 
+export const outboundXcpdRequestMissingFields: OutboundPatientDiscoveryReq = {
+  id: uuidv4(),
+  cxId: uuidv4(),
+  patientId: uuidv4(),
+  timestamp: "2024-04-04T19:11:55.879Z",
+  principalCareProviderIds: ["1234567890"],
+  samlAttributes: {
+    subjectId: "America Inc",
+    subjectRole: {
+      code: "106331006",
+      display: "Administrative AND/OR managerial worker",
+    },
+    organization: "White House Medical Inc",
+    organizationId: "2.16.840.1.113883.3.9621.5.213",
+    homeCommunityId: "2.16.840.1.113883.3.9621.5.213",
+    purposeOfUse: "TREATMENT",
+  },
+  patientResource: {
+    name: [
+      {
+        given: ["NWHINONE"],
+        family: "NWHINZZZTESTPATIENT",
+      },
+    ],
+    gender: "male",
+    birthDate: "19810101",
+  },
+  gateways: [
+    {
+      url: "https://mock-metriport/soap/iti55",
+      oid: "2.16.840.1.113883.3.787.0.0",
+      id: "018ea97e-7b1c-78e9-8aa1-47c7caf85afe",
+    },
+  ],
+};
+
 export const expectedXcpdResponse: OutboundPatientDiscoveryRespSuccessfulSchema = {
   id: outboundXcpdRequest.id,
   patientId: outboundXcpdRequest.patientId,
@@ -91,8 +127,9 @@ export const expectedMultiNameAddressResponse: OutboundPatientDiscoveryRespSucce
   ...expectedXcpdResponse,
   patientResource: {
     ...expectedXcpdResponse.patientResource,
+    birthDate: expectedXcpdResponse.patientResource.birthDate,
     name: [
-      ...(expectedXcpdResponse.patientResource?.name ?? []),
+      ...expectedXcpdResponse.patientResource.name,
       {
         given: ["nwhinone", "bartholomew"],
         family: "nwhinzzztestpatient",
@@ -108,6 +145,22 @@ export const expectedMultiNameAddressResponse: OutboundPatientDiscoveryRespSucce
         country: "USA",
       },
     ],
+    telecom: [
+      {
+        system: "MC",
+        value: "tel:+1310-000-0000",
+      },
+      {
+        system: "H",
+        value: "mailto:test@test.com",
+      },
+    ],
+    identifier: [
+      {
+        value: "987564321",
+        system: "2.16.840.1.113883.3.9621",
+      },
+    ],
   },
 };
 
@@ -317,3 +370,16 @@ export const testFilesForUploadVerification = [
   { name: "test.txt", mimeType: "text/plain", fileExtension: ".txt" },
   { name: "test.jpeg", mimeType: "image/jpeg", fileExtension: ".jpeg" },
 ];
+
+export const TEST_CERT = `-----BEGIN CERTIFICATE-----
+MIIBxDCCAW6gAwIBAgIQxUSXFzWJYYtOZnmmuOMKkjANBgkqhkiG9w0BAQQFADAW
+MRQwEgYDVQQDEwtSb290IEFnZW5jeTAeFw0wMzA3MDgxODQ3NTlaFw0zOTEyMzEy
+MzU5NTlaMB8xHTAbBgNVBAMTFFdTRTJRdWlja1N0YXJ0Q2xpZW50MIGfMA0GCSqG
+SIb3DQEBAQUAA4GNADCBiQKBgQC+L6aB9x928noY4+0QBsXnxkQE4quJl7c3PUPd
+Vu7k9A02hRG481XIfWhrDY5i7OEB7KGW7qFJotLLeMec/UkKUwCgv3VvJrs2nE9x
+O3SSWIdNzADukYh+Cxt+FUU6tUkDeqg7dqwivOXhuOTRyOI3HqbWTbumaLdc8juf
+z2LhaQIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEU
+MBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwDQYJKoZIhvcN
+AQEEBQADQQAfIbnMPVYkNNfX1tG1F+qfLhHwJdfDUZuPyRPucWF5qkh6sSdWVBY5
+sT/txBnVJGziyO8DPYdu2fPMER8ajJfl
+-----END CERTIFICATE-----`;

packages/core/src/external/carequality/ihe-gateway-v2/outbound/__tests__/create-xcpd.test.ts

@@ -0,0 +1,12 @@
+import { outboundXcpdRequestMissingFields, TEST_CERT } from "./constants";
+import { createITI5SoapEnvelope } from "../xcpd/create/iti55-envelope";
+
+describe("createITI5SoapEnvelope", () => {
+  it("should process the match XCPD response correctly", async () => {
+    const response = createITI5SoapEnvelope({
+      bodyData: outboundXcpdRequestMissingFields,
+      publicCert: TEST_CERT,
+    });
+    console.log(JSON.stringify(response, null, 2));
+  });
+});

packages/core/src/external/carequality/ihe-gateway-v2/outbound/__tests__/xmls/xcpd_match.xml

@@ -70,6 +70,10 @@
                                         <postalCode>35080</postalCode>
                                         <country>USA</country>
                                     </addr>
+                                    <asOtherIDs classCode="PAT">
+                                        <id/>
+                                    </asOtherIDs>
+                                    <telecom/>
                                 </patientPerson>
                                 <subjectOf1>
                                     <queryMatchObservation classCode="OBS" moodCode="EVN">

packages/core/src/external/carequality/ihe-gateway-v2/outbound/__tests__/xmls/xcpd_match_multi_addr_name.xml

@@ -85,6 +85,14 @@
                                     </addr>
                                     <telecom use="MC" value="tel:+1310-000-0000" />
                                     <telecom use="H" value="mailto:test@test.com" />
+                                    <asOtherIDs classCode="PAT">
+                                        <id root="2.16.840.1.113883.3.9621"
+                                            extension="987564321" />
+                                        <scopingOrganization classCode="ORG"
+                                            determinerCode="INSTANCE">
+                                            <id root="2.16.840.1.113883.3.9621" />
+                                        </scopingOrganization>
+                                    </asOtherIDs>
                                 </patientPerson>
                                 <subjectOf1>
                                     <queryMatchObservation classCode="OBS" moodCode="EVN">

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dq-response.ts

@@ -16,7 +16,6 @@ import {
 } from "../../../../shared";
 import { successStatus, partialSuccessStatus } from "./constants";
 import { capture } from "../../../../../../util/notifications";
-import { requiresRequestHomeCommunityId } from "../../../gateways";
 
 type Identifier = {
   _identificationScheme: string;
@@ -40,10 +39,6 @@ type Slot = {
   };
 };
 
-function getRequestHomeCommunityId(request: OutboundDocumentQueryReq): string {
-  return request.gateway.homeCommunityId;
-}
-
 function getResponseHomeCommunityId(
   //eslint-disable-next-line @typescript-eslint/no-explicit-any
   extrinsicObject: any
@@ -56,9 +51,6 @@ function getHomeCommunityIdForDr(
   //eslint-disable-next-line @typescript-eslint/no-explicit-any
   extrinsicObject: any
 ): string {
-  if (requiresRequestHomeCommunityId(request.gateway)) {
-    return getRequestHomeCommunityId(request);
-  }
   return getResponseHomeCommunityId(extrinsicObject);
 }