@metriport/commonwell-sdk 8.5.0 → 8.5.1

package/dist/client/commonwell copy.d.ts

@@ -0,0 +1,243 @@
+/// <reference types="node" />
+import * as stream from "stream";
+import { GenderCodes } from "../models/demographics";
+import { DocumentQueryFullResponse, DocumentReference } from "../models/document";
+import { Patient, PatientCreateOrUpdateResp, PatientExistingLinks, PatientProbableLinks, PatientResponseItem, StatusResponse } from "../models/patient";
+import { APIMode, CommonWellOptions } from "./common";
+import { BaseOptions, CommonWellAPI, DocumentQueryParams, GetPatientParams, RetrieveDocumentResponse } from "./commonwell-api";
+import { CommonWellBase } from "./commonwell-base";
+/**
+ * Implementation of the CommonWell API, v4.
+ * @see https://www.commonwellalliance.org/specification/
+ */
+export declare class CommonWell extends CommonWellBase implements CommonWellAPI {
+    private _orgName;
+    private _oid;
+    private _npi;
+    private _homeCommunityId;
+    private _authGrantorReferenceOid?;
+    private onError500;
+    /**
+     * Creates a new instance of the CommonWell API client pertaining to an
+     * organization to make requests on behalf of.
+     */
+    constructor({ orgCert, rsaPrivateKey, orgName, oid, npi, homeCommunityId, apiMode, authGrantorReferenceOid: authGrantorReference, options, }: {
+        /** The certificate (public key) for the organization. */
+        orgCert: string;
+        /** An RSA key corresponding to the specified orgCert. */
+        rsaPrivateKey: string;
+        /** The name of the organization that's making the request, the Principal or Delegate. */
+        orgName: string;
+        /** The OID of the organization that's making the request, the Principal or Delegate. */
+        oid: string;
+        /** The NPI of the organization that's making the request, the Principal or Delegate. */
+        npi: string;
+        /**
+         * The Home Community OID assigned to the Organization that is initiating the request,
+         * the implementor.
+         */
+        homeCommunityId: string;
+        /** The mode the client will be running. */
+        apiMode: APIMode;
+        /** The OID of the principal organization who authorized the request, aka The Principal. */
+        authGrantorReferenceOid?: string | undefined;
+        /** Optional parameters. */
+        options?: CommonWellOptions;
+    });
+    get oid(): string;
+    get npi(): string;
+    get orgName(): string;
+    get homeCommunityId(): string;
+    /**
+     * Register a new patient.
+     *
+     * @param patient  The patient to register.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns The patient collection containing the patient in the first position.
+     */
+    createOrUpdatePatient(patient: Patient, options?: BaseOptions): Promise<PatientCreateOrUpdateResp>;
+    /**
+     * Returns a patient based on its ID.
+     *
+     * @param params The patient ID and optional assign authority and assign authority type.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns The patient response item containing the patient in the first position.
+     * @throws MetriportError if multiple patients are found for the given ID.
+     */
+    getPatient(params: GetPatientParams, options?: BaseOptions): Promise<PatientResponseItem | undefined>;
+    /**
+     * Returns a patient based on its ID. From the spec, about the patient ID:
+     *
+     * The local Patient Identifier. The value is under the control of the local Edge System and
+     * represents the unique identifier for the Patient Record in the local system. The format
+     * for this identifier MUST follow the HL7 CX data type format:
+     *
+     * IdentifierValue^^^&PatientIdAssignAuthority&PatientIdAssignAuthorityType
+     *
+     * @param id      Patient's ID, HL7 CX data type format.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns The patient response item containing the patient in the first position.
+     * @throws MetriportError if multiple patients are found for the given ID.
+     * @see Section "8.3.2 Get Patient" of the spec.
+     */
+    getPatient(id: string, options?: BaseOptions): Promise<PatientResponseItem>;
+    /**
+     * Deletes a patient.
+     *
+     * @param patientId The patient to be deleted.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     */
+    deletePatient(patientId: string, options?: BaseOptions): Promise<void>;
+    /**
+     * Merges two patients into one.
+     *
+     * @param nonSurvivingPatientId The local Patient ID of the non-surviving Patient Record (This patient gets replaced).
+     * @param survivingPatientId The patient ID of the patient that will replace the non surviving patient
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns The patient merge response.
+     */
+    mergePatients({ nonSurvivingPatientId, survivingPatientId, }: {
+        nonSurvivingPatientId: string;
+        survivingPatientId: string;
+    }, options?: BaseOptions): Promise<StatusResponse>;
+    /**
+     * Returns the links the patient has with other patients.
+     *
+     * An Edge System can search and request Patient Links by a local patient identifier. The result of the query will
+     * include local and remote patient's links that are autolinked by the rules engine or manually linked.
+     *
+     * The links returned are confirmed links of LOLA 2 or higher.
+     *
+     * @param meta                Metadata about the request.
+     * @param patientId           The person id to be link to a patient.
+     * @returns Response with list of links to Patients
+     */
+    getPatientLinksByPatientId(patientId: string, options?: BaseOptions): Promise<PatientExistingLinks>;
+    /**
+     * Returns the potential links the patient has. Those are links the CommonWell MPI was not
+     * confident enough to confirm (LOLA2+), but could potentially be a match in case some of
+     * the patient's demographics have changed.
+     *
+     * An Edge System can request probable patient links by a local patient identifier. MPI will identify probable
+     * patients based on MPI match scores that are within a certain threshold range but are not auto matched.
+     * Probable matches are determined by probabilistic algorithms. This will enable Edge Systems to confirm
+     * additional patient matches across other organizations. On confirmation, the patient will be matched to a
+     * person. Probable links need to be manually linked to the local patient before documents can be requested.
+     *
+     * The links returned are LOLA 1.
+     *
+     * @param patientId The ID of the patient to get probable links for.
+     * @returns Response with list of probable (LOLA1) links to other Patients
+     */
+    getProbableLinksById(patientId: string, options?: BaseOptions): Promise<PatientProbableLinks>;
+    /**
+     * Returns the potential links for a patient with the provided demographics.
+     *
+     * An Edge System can request probable patient links by a local patient identifier. MPI will identify probable
+     * patients based on MPI match scores that are within a certain threshold range but are not auto matched.
+     * Probable matches are determined by probabilistic algorithms. This will enable Edge Systems to confirm
+     * additional patient matches across other organizations. On confirmation, the patient will be matched to a
+     * person. Probable links need to be manually linked to the local patient before documents can be requested.
+     *
+     * The links returned are LOLA 1.
+     *
+     * @param firstName The first name of the patient.
+     * @param lastName The last name of the patient.
+     * @param dob The date of birth of the patient.
+     * @param gender The gender of the patient.
+     * @param zip The zip code of the patient.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns Response with list of probable (LOLA1) links to existing Patients
+     */
+    getProbableLinksByDemographics({ firstName, lastName, dob, gender, zip, }: {
+        firstName: string;
+        lastName: string;
+        dob: string;
+        gender: GenderCodes;
+        zip: string;
+    }, options?: BaseOptions): Promise<PatientProbableLinks>;
+    /**
+     * An Edge System reviews the probable matches. An Edge System can link remote patient(s) if these patients are
+     * the same as local patient.
+     *
+     * Use getPatientLinksByPatientId to get the Link URL.
+     *
+     * Remote patients will be linked with the local patient and now considered as a manual confirmed LOLA 2 link.
+     *
+     * @param urlToLinkPatients The URL to link the patients.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     */
+    linkPatients(urlToLinkPatients: string, options?: BaseOptions): Promise<StatusResponse>;
+    /**
+     * After reviewing remote patient links for their local patient, an Edge System can unlink a remote patient that
+     * does not belong in the Patient collection and remove the existing LOLA2 network link.
+     *
+     * Use getPatientLinksByPatientId to get the Unlink URL.
+     *
+     * Patient Links that are manually unlinked will no longer be autolinked to the same patient in the future by the
+     * matching algorithm.
+     *
+     * @param urlToUnlinkPatients The URL to unlink the patients.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     */
+    unlinkPatients(urlToUnlinkPatients: string, options?: BaseOptions): Promise<StatusResponse>;
+    /**
+     * Edge Systems can perform a “reset” to a Patient which will detach all LOLA 2 links to the specified Patient. This
+     * patient may be linked to the same collection of Patients (Person) again in the future.
+     *
+     * Use getPatientLinksByPatientId to get the ResetLink URL.
+     *
+     * @param urlToResetPatientLinks The URL to reset the patient links.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     */
+    resetPatientLinks(urlToResetPatientLinks: string, options?: BaseOptions): Promise<StatusResponse>;
+    private queryDocumentsInternal;
+    /**
+     * Queries a patient's Documents. Returns only documents.
+     *
+     * @param patientId The patient's ID.
+     * @param options Query parameters and query parameters.
+     * @param options.status The status of the document. Defaults to `current`, even if a param is
+     *                      provided without status.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns an array of DocumentReference FHIR resources.
+     */
+    queryDocuments(patientId: string, options?: BaseOptions & DocumentQueryParams): Promise<DocumentReference[]>;
+    /**
+     * Queries a patient's Documents. Returns documents and errors from the fanout to other gateways.
+     *
+     * @param patientId The patient's ID.
+     * @param options Query parameters and query parameters.
+     * @param options.status The status of the document. Defaults to `current`, even if a param is
+     *                      provided without status.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns a Bundle containing DocumentReferences of a patient's available DocumentReferences
+     *          and/or OperationOutcomes denoting problems with the query.
+     */
+    queryDocumentsFull(patientId: string, options?: BaseOptions & DocumentQueryParams): Promise<DocumentQueryFullResponse>;
+    /**
+     * Retrieve a Document and send its bytes to the outputStream.
+     *
+     * @param inputUrl The URL of the file to be downloaded. Obtained from a DocumentReference that
+     *                 was retrieved from a previous call to `queryDocuments`.
+     * @param outputStream The stream to receive the downloaded file's bytes.
+     * @param options Optional parameters.
+     * @param options.meta Metadata about the request. Defaults to the data used to initialize the client.
+     * @returns The content type and size of the downloaded file.
+     */
+    retrieveDocument(inputUrl: string, outputStream: stream.Writable, options?: BaseOptions): Promise<RetrieveDocumentResponse>;
+    private buildQueryHeaders;
+    private buildOrganizationQueryMeta;
+    private executeWithRetriesOn500IfEnabled;
+    private getDescriptiveError;
+}
+//# sourceMappingURL=commonwell%20copy.d.ts.map

package/dist/client/commonwell copy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonwell copy.d.ts","sourceRoot":"","sources":["../../src/client/commonwell copy.ts"],"names":[],"mappings":";AAUA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAUjC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EACL,yBAAyB,EAGzB,iBAAiB,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,OAAO,EACP,yBAAyB,EACzB,oBAAoB,EAEpB,oBAAoB,EAEpB,mBAAmB,EAEnB,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAwC,MAAM,UAAU,CAAC;AAC5F,OAAO,EACL,WAAW,EACX,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAEhB,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,cAAe,YAAW,aAAa;IACrE,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,wBAAwB,CAAC,CAAqB;IACtD,OAAO,CAAC,UAAU,CAAoB;IAEtC;;;OAGG;gBACS,EACV,OAAO,EACP,aAAa,EACb,OAAO,EACP,GAAG,EACH,GAAG,EACH,eAAe,EACf,OAAO,EACP,uBAAuB,EAAE,oBAAoB,EAC7C,OAAY,GACb,EAAE;QACD,yDAAyD;QACzD,OAAO,EAAE,MAAM,CAAC;QAChB,yDAAyD;QACzD,aAAa,EAAE,MAAM,CAAC;QACtB,yFAAyF;QACzF,OAAO,EAAE,MAAM,CAAC;QAChB,wFAAwF;QACxF,GAAG,EAAE,MAAM,CAAC;QACZ,wFAAwF;QACxF,GAAG,EAAE,MAAM,CAAC;QACZ;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QACxB,2CAA2C;QAC3C,OAAO,EAAE,OAAO,CAAC;QACjB,2FAA2F;QAC3F,uBAAuB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7C,2BAA2B;QAC3B,OAAO,CAAC,EAAE,iBAAiB,CAAC;KAC7B;IAeD,IAAI,GAAG,WAEN;IACD,IAAI,GAAG,WAEN;IACD,IAAI,OAAO,WAEV;IACD,IAAI,eAAe,WAElB;IAMD;;;;;;;OAOG;IACG,qBAAqB,CACzB,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,yBAAyB,CAAC;IAgBrC;;;;;;;;OAQG;IACG,UAAU,CACd,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAC3C;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiCjF;;;;;;OAMG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5E;;;;;;;;OAQG;IACG,aAAa,CACjB,EACE,qBAAqB,EACrB,kBAAkB,GACnB,EAAE;QACD,qBAAqB,EAAE,MAAM,CAAC;QAC9B,kBAAkB,EAAE,MAAM,CAAC;KAC5B,EACD,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,cAAc,CAAC;IAsB1B;;;;;;;;;;;OAWG;IACG,0BAA0B,CAC9B,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,oBAAoB,CAAC;IAahC;;;;;;;;;;;;;;;OAeG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,8BAA8B,CAClC,EACE,SAAS,EACT,QAAQ,EACR,GAAG,EACH,MAAM,EACN,GAAG,GACJ,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,WAAW,CAAC;QACpB,GAAG,EAAE,MAAM,CAAC;KACb,EACD,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;IAQ7F;;;;;;;;;;;;OAYG;IACG,cAAc,CAClB,mBAAmB,EAAE,MAAM,EAC3B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,cAAc,CAAC;IAQ1B;;;;;;;;;OASG;IACG,iBAAiB,CACrB,sBAAsB,EAAE,MAAM,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,cAAc,CAAC;YAYZ,sBAAsB;IAwBpC;;;;;;;;;OASG;IACG,cAAc,CAClB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,WAAW,GAAG,mBAAmB,GAC1C,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAM/B;;;;;;;;;;OAUG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,WAAW,GAAG,mBAAmB,GAC1C,OAAO,CAAC,yBAAyB,CAAC;IAKrC;;;;;;;;;OASG;IACG,gBAAgB,CACpB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,CAAC,QAAQ,EAC7B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,wBAAwB,CAAC;IAgEpC,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,0BAA0B;YAWpB,gCAAgC;IAa9C,OAAO,CAAC,mBAAmB;CAiB5B"}