@metriport/commonwell-sdk 4.3.3 → 4.3.4

package/lib/client/commonwell.js

@@ -1,740 +1,740 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonWell = exports.APIMode = void 0;
-const axios_1 = __importDefault(require("axios"));
-const httpStatus = __importStar(require("http-status"));
-const https_1 = require("https");
-const make_jwt_1 = require("../common/make-jwt");
-const metriport_error_1 = __importDefault(require("../common/metriport-error"));
-const certificates_1 = require("../models/certificates");
-const link_1 = require("../models/link");
-const organization_1 = require("../models/organization");
-const patient_1 = require("../models/patient");
-const person_1 = require("../models/person");
-const document = __importStar(require("./document"));
-const DEFAULT_AXIOS_TIMEOUT_SECONDS = 120;
-var APIMode;
-(function (APIMode) {
-    APIMode["integration"] = "integration";
-    APIMode["production"] = "production";
-})(APIMode = exports.APIMode || (exports.APIMode = {}));
-class CommonWell {
-    /**
-     * Creates a new instance of the CommonWell API client pertaining to an
-     * organization to make requests on behalf of.
-     *
-     * @param orgCert         The certificate (public key) for the organization.
-     * @param rsaPrivateKey   An RSA key corresponding to the specified orgCert.
-     * @param apiMode         The mode the client will be running.
-     * @param apiMode         The mode the client will be running.
-     * @param options         Optional parameters
-     * @param options.timeout Connection timeout in milliseconds, default 120 seconds.
-     */
-    constructor(orgCert, rsaPrivateKey, orgName, oid, apiMode, options = {}) {
-        this.rsaPrivateKey = rsaPrivateKey;
-        this.httpsAgent = new https_1.Agent({ cert: orgCert, key: rsaPrivateKey });
-        this.api = axios_1.default.create({
-            timeout: options?.timeout ?? DEFAULT_AXIOS_TIMEOUT_SECONDS * 1000,
-            baseURL: apiMode === APIMode.production ? CommonWell.productionUrl : CommonWell.integrationUrl,
-            httpsAgent: this.httpsAgent,
-        });
-        this.api.interceptors.response.use(this.axiosSuccessfulResponse(this), this.axiosErrorResponse(this));
-        this.orgName = orgName;
-        this._oid = oid;
-    }
-    get oid() {
-        return this._oid;
-    }
-    /**
-     * Returns the `CW-Reference` header from the last request.
-     */
-    get lastReferenceHeader() {
-        return this._lastReferenceHeader;
-    }
-    // Being extra safe with these bc a failure here fails the actual request
-    postRequest(response) {
-        this._lastReferenceHeader =
-            response && response.headers ? response.headers["cw-reference"] : undefined;
-    }
-    axiosSuccessfulResponse(_this) {
-        return (response) => {
-            _this && _this.postRequest(response);
-            return response;
-        };
-    }
-    axiosErrorResponse(_this) {
-        //eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return (error) => {
-            _this && _this.postRequest(error.response);
-            throw error;
-        };
-    }
-    // TODO: #322 handle errors in API calls as per
-    // https://specification.commonwellalliance.org/services/rest-api-reference (8.6.1 Error)
-    // Note that also sometimes these calls 404 when things aren't found and etc
-    //--------------------------------------------------------------------------------------------
-    // Org Management
-    //--------------------------------------------------------------------------------------------
-    /**
-     * Create an org.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#post-a-new-organization
-     *
-     * @param meta          Metadata about the request.
-     * @param organization  The org to create.
-     * @returns
-     */
-    async createOrg(meta, organization) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org`, organization, {
-            headers,
-        });
-        return organization_1.organizationSchema.parse(resp.data);
-    }
-    /**
-     * Update an org.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#put-new-information-into-an-organization
-     *
-     * @param meta          Metadata about the request.
-     * @param organization  The org to update.
-     * @returns
-     */
-    async updateOrg(meta, organization, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.put(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/`, organization, {
-            headers,
-        });
-        return organization_1.organizationSchema.parse(resp.data);
-    }
-    /**
-     * Get list of orgs.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-a-list-of-all-organizations
-     *
-     * @param meta     Metadata about the request.
-     * @param summary  Returns only summary data
-     * @param offset   Sets an offset number from which recorded returns will begin
-     * @param limit    Limits the number of returned records
-     * @param sort     Specifies sort order
-     * @returns
-     */
-    async getAllOrgs(meta, summary, offset, limit, sort) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org`, {
-            headers,
-            params: { summary, offset, limit, sort },
-        });
-        return organization_1.organizationListSchema.parse(resp.data);
-    }
-    /**
-     * Get one org.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-a-single-organization
-     *
-     * @param meta     Metadata about the request.
-     * @param id       The org to be found
-     * @returns
-     */
-    async getOneOrg(meta, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/`, {
-            headers,
-            validateStatus: null, // don't throw on status code > 299
-        });
-        const status = resp.status;
-        if (status === httpStatus.NOT_FOUND)
-            return undefined;
-        if (httpStatus[`${status}_CLASS`] === httpStatus.classes.SUCCESSFUL) {
-            return organization_1.organizationSchema.parse(resp.data);
-        }
-        throw new metriport_error_1.default(`Failed to retrieve Organization`, status);
-    }
-    /**
-     * Add certificate to org.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#post-new-certificates-to-organizations
-     *
-     * @param meta         Metadata about the request.
-     * @param certificate  The certificate to add to the org
-     * @param id           The org to add a certificate too
-     * @returns
-     */
-    async addCertificateToOrg(meta, certificate, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate`, certificate, {
-            headers,
-        });
-        return certificates_1.certificateRespSchema.parse(resp.data);
-    }
-    /**
-     * Replace certificate for org.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#put-a-list-of-certificates-into-an-organization
-     *
-     * @param meta         Metadata about the request.
-     * @param certificate  The certificate to replace for the org
-     * @param id           The org to replace a certificate for
-     * @returns
-     */
-    async replaceCertificateForOrg(meta, certificate, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.put(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate`, certificate, {
-            headers,
-        });
-        return certificates_1.certificateRespSchema.parse(resp.data);
-    }
-    /**
-     * Delete certificate from org.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#delete-certificates-by-thumbprint
-     *
-     * @param meta         Metadata about the request.
-     * @param id           The org to delete a certificate from
-     * @param thumbprint   The thumbprint from the certificate
-     * @param purpose      The purpose from the certificate
-     * @returns
-     */
-    async deleteCertificateFromOrg(meta, id, thumbprint, purpose) {
-        const headers = await this.buildQueryHeaders(meta);
-        await this.api.delete(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate/${thumbprint}/purpose/${purpose}`, {
-            headers,
-        });
-        return;
-    }
-    /**
-     * Get certificate from org.
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-certificates-for-an-organization
-     *
-     * @param meta         Metadata about the request.
-     * @param certificate  The certificate to add to the org
-     * @param id           The org to get a certificate from
-     * @param thumbprint   The thumbprint from the certificate
-     * @param purpose      The purpose from the certificate
-     * @returns
-     */
-    async getCertificatesFromOrg(meta, id, thumbprint, purpose) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate`, {
-            headers,
-            params: { thumbprint, purpose },
-        });
-        return certificates_1.certificateRespSchema.parse(resp.data);
-    }
-    /**
-     * Get certificate from org (by thumbprint).
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-certificates-by-thumbprint
-     *
-     * @param meta         Metadata about the request.
-     * @param certificate  The certificate to add to the org
-     * @param id           The org to get a certificate from
-     * @param thumbprint   The thumbprint from the certificate
-     * @param purpose      The purpose from the certificate
-     * @returns
-     */
-    async getCertificatesFromOrgByThumbprint(meta, id, thumbprint, purpose) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate/${thumbprint}`, {
-            headers,
-            params: { purpose },
-        });
-        return certificates_1.certificateRespSchema.parse(resp.data);
-    }
-    /**
-     * Get certificate from org (by thumbprint & purpose).
-     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-certificates-by-thumbprint-and-purpose
-     *
-     * @param meta         Metadata about the request.
-     * @param certificate  The certificate to add to the org
-     * @param id           The org to get a certificate from
-     * @param thumbprint   The thumbprint from the certificate
-     * @param purpose      The purpose from the certificate
-     * @returns
-     */
-    async getCertificatesFromOrgByThumbprintAndPurpose(meta, id, thumbprint, purpose) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate/${thumbprint}/purpose/${purpose}`, {
-            headers,
-        });
-        return certificates_1.certificateRespSchema.parse(resp.data);
-    }
-    //--------------------------------------------------------------------------------------------
-    // Person Management
-    //--------------------------------------------------------------------------------------------
-    /**
-     * Enrolls a new person.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8716-adding-a-new-person
-     *
-     * @param meta    Metadata about the request.
-     * @param person  The person to enroll.
-     * @returns
-     */
-    async enrollPerson(meta, person) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(CommonWell.PERSON_ENDPOINT, person, {
-            headers,
-        });
-        return person_1.personSchema.parse(resp.data);
-    }
-    /**
-     * Searches for a person based on the specified strong ID.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8711-search-for-a-person
-     *
-     * @param meta    Metadata about the request.
-     * @param key     The ID's value, for example the driver's license ID.
-     * @param system  The ID's uri to specify type, for example "urn:oid:2.16.840.1.113883.4.3.6" is a CA DL.
-     * @returns
-     */
-    async searchPerson(meta, key, system) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(CommonWell.PERSON_ENDPOINT, {
-            headers,
-            params: { key, system },
-        });
-        return person_1.personSearchRespSchema.parse(resp.data);
-    }
-    /**
-     * Searches for a person based on patient demo.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8713-find-persons-matching-patient-demographics
-     *
-     * @param meta        Metadata about the request.
-     * @param patientId   The patient ID.
-     * @returns
-     */
-    async searchPersonByPatientDemo(meta, patientId) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${patientId}/person`, {
-            headers,
-        });
-        return person_1.personSearchRespSchema.parse(resp.data);
-    }
-    /**
-     * Gets a person based on person id.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8713-find-persons-matching-patient-demographics
-     *
-     * @param meta        Metadata about the request.
-     * @param personId   The person ID.
-     * @returns
-     */
-    async getPersonById(meta, personId) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.PERSON_ENDPOINT}/${personId}`, {
-            headers,
-        });
-        return person_1.personSchema.parse(resp.data);
-    }
-    /**
-     * Updates a person.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8741-updating-person-information
-     *
-     * @param meta    Metadata about the request.
-     * @param person  The data to update.
-     * @param id      The person to be updated.
-     * @returns
-     */
-    async updatePerson(meta, person, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(`${CommonWell.PERSON_ENDPOINT}/${id}`, person, {
-            headers,
-        });
-        return person_1.personSchema.parse(resp.data);
-    }
-    /**
-     * Matches a person to a patient.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8732-retrieve-patient-matches
-     *
-     * @param meta    Metadata about the request.
-     * @param id      The person to be matched.
-     * @returns
-     */
-    async patientMatch(meta, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.PERSON_ENDPOINT}/${id}/patientMatch`, {
-            headers,
-            params: { orgId: this.oid },
-        });
-        return patient_1.patientSearchRespSchema.parse(resp.data);
-    }
-    /**
-     * @deprecated use addPatientLink() instead
-     */
-    async patientLink(meta, personId, patientUri, patientStrongId) {
-        return this.addPatientLink(meta, personId, patientUri, patientStrongId);
-    }
-    /**
-     * Add patient link to person.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8721
-     *
-     * @param meta              Metadata about the request.
-     * @param personId          The person id to be link to a patient.
-     * @param patientUri        The patient uri to be link to a person.
-     * @param [patientStrongId] The patient's strong ID, if available (optional).
-     * @returns {PatientLink}
-     */
-    async addPatientLink(meta, personId, patientUri, patientStrongId) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(`${CommonWell.PERSON_ENDPOINT}/${personId}/patientLink`, {
-            patient: patientUri,
-            ...(patientStrongId ? { identifier: patientStrongId } : undefined),
-        }, { headers });
-        return person_1.patientLinkSchema.parse(resp.data);
-    }
-    /**
-     * Re-enrolls a person.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#875-person-unenrollment
-     *
-     * @param meta    Metadata about the request.
-     * @param id      The person to be re-enrolled.
-     * @returns       Person with enrollment information
-     */
-    async reenrollPerson(meta, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.put(`${CommonWell.PERSON_ENDPOINT}/${id}/enroll`, {}, { headers });
-        return person_1.personSchema.parse(resp.data);
-    }
-    /**
-     * Unenrolls a person.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#875-person-unenrollment
-     *
-     * @param meta    Metadata about the request.
-     * @param id      The person to be unenrolled.
-     * @returns
-     */
-    async unenrollPerson(meta, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.put(`${CommonWell.PERSON_ENDPOINT}/${id}/unenroll`, {}, {
-            headers,
-        });
-        return person_1.personSchema.parse(resp.data);
-    }
-    /**
-     * Deletes a person.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8742-deleting-a-person
-     *
-     * @param meta    Metadata about the request.
-     * @param id      The person to be deleted.
-     * @returns
-     */
-    async deletePerson(meta, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        await this.api.delete(`${CommonWell.PERSON_ENDPOINT}/${id}`, { headers });
-        return;
-    }
-    //--------------------------------------------------------------------------------------------
-    // Patient Management
-    //--------------------------------------------------------------------------------------------
-    /**
-     * Register a new patient.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8762-adding-a-local-patient-record
-     *
-     * @param meta    Metadata about the request.
-     * @param patient  The patient to register.
-     * @returns
-     */
-    async registerPatient(meta, patient) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient`, patient, {
-            headers,
-        });
-        return patient_1.patientSchema.parse(resp.data);
-    }
-    /**
-     * Returns a patient based on its ID.
-     *
-     * @param meta    Metadata about the request.
-     * @param id      Patient's ID.
-     * @returns {Promise<Patient>}
-     */
-    async getPatient(meta, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const suffix = id.endsWith("/") ? "" : "/";
-        const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${id}${suffix}`, { headers });
-        return patient_1.patientSchema.parse(resp.data);
-    }
-    /**
-     * Searches for a patient based on params.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8761-search-for-a-patient
-     *
-     * @param meta    Metadata about the request.
-     * @param fname   Patient's first name.
-     * @param lname   Patient's last name.
-     * @param dob     Patient's date of birth.
-     * @param gender  Patient's gender.
-     * @param zip     Patient's zip code.
-     * @returns
-     */
-    async searchPatient(meta, fname, lname, dob, gender, zip) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient`, {
-            headers,
-            params: { fname, lname, dob, gender, zip },
-        });
-        return patient_1.patientSearchRespSchema.parse(resp.data);
-    }
-    /**
-     * Updates a patient.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8763-updating-a-local-patient-record
-     *
-     * @param meta     Metadata about the request.
-     * @param patient  The data to update.
-     * @param id       The patient to be updated.
-     * @returns
-     */
-    async updatePatient(meta, patient, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${id}/`, patient, {
-            headers,
-        });
-        return patient_1.patientSchema.parse(resp.data);
-    }
-    /**
-     * Merges patients.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8765-merging-local-patient-records
-     *
-     * @param meta    Metadata about the request.
-     * @param nonSurvivingPatientId  The local Patient Identifier of the non-surviving Patient Record (This patient gets replaced)
-     * @param referencePatientLink   The patient link for the patient that will replace the non surviving patient
-     * @returns
-     */
-    async mergePatients(meta, nonSurvivingPatientId, referencePatientLink) {
-        const headers = await this.buildQueryHeaders(meta);
-        await this.api.put(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${nonSurvivingPatientId}/merge`, {
-            link: {
-                other: {
-                    reference: referencePatientLink,
-                },
-                type: "replace",
-            },
-        }, {
-            headers,
-        });
-        return;
-    }
-    /**
-     * Get Patient's Network Links.
-     * See: https://specification.commonwellalliance.org/services/record-locator-service/protocol-operations-record-locator-service#8771-retrieving-network-links
-     *
-     * @param meta        Metadata about the request.
-     * @param patientId   Patient for which to get the network links.
-     * @returns
-     */
-    async getNetworkLinks(meta, patientId) {
-        const headers = await this.buildQueryHeaders(meta);
-        // Error handling: https://github.com/metriport/metriport-internal/issues/322
-        try {
-            const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${patientId}/networkLink`, {
-                headers,
-            });
-            return patient_1.patientNetworkLinkRespSchema.parse(resp.data);
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        }
-        catch (err) {
-            // when there's no NetworkLink, CW's API return 412
-            if (err.response?.status === 412)
-                return { _embedded: { networkLink: [] } };
-            throw err;
-        }
-    }
-    /**
-     * Deletes a patient.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8764-deleting-a-local-patient-record
-     *
-     * @param meta    Metadata about the request.
-     * @param id      The patient to be updated.
-     * @returns
-     */
-    async deletePatient(meta, id) {
-        const headers = await this.buildQueryHeaders(meta);
-        await this.api.delete(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${id}/`, {
-            headers,
-        });
-    }
-    //--------------------------------------------------------------------------------------------
-    // Document Management
-    //--------------------------------------------------------------------------------------------
-    /**
-     * Queries a patient's Documents.
-     *
-     * @param meta       Metadata about the request.
-     * @param patientId  The patient's ID.
-     * @returns {Promise<DocumentQueryResponse>}
-     * @see {@link https://specification.commonwellalliance.org/services/data-broker/cha-broker-api-reference#104-document-query|Use case}
-     * @see {@link https://specification.commonwellalliance.org/services/data-broker/protocol-operations-data-broker#8781-find-documents|API spec}
-     */
-    async queryDocuments(meta, patientId) {
-        const headers = await this.buildQueryHeaders(meta);
-        return document.query(this.api, headers, patientId);
-    }
-    /**
-     * Queries a patient's Documents - including other possible results.
-     *
-     * @param meta       Metadata about the request.
-     * @param patientId  The patient's ID.
-     * @returns The DocumentReferences of a patient's available documents and/or OperationOutcomes denoting problems with the query.
-     * @see {@link https://specification.commonwellalliance.org/services/data-broker/cha-broker-api-reference#104-document-query|Use case}
-     * @see {@link https://specification.commonwellalliance.org/services/data-broker/protocol-operations-data-broker#8781-find-documents|API spec}
-     */
-    async queryDocumentsFull(meta, patientId) {
-        const headers = await this.buildQueryHeaders(meta);
-        return document.queryFull(this.api, headers, patientId);
-    }
-    /**
-     * Retrieve a Document and pipe its bytes into the outputStream.
-     *
-     * @param {string} inputUrl - The URL of the file to be downloaded.
-     * @param {fs.WriteStream} outputStream - The stream to receive the downloaded file's bytes.
-     * @returns {Promise<void>}
-     * @see {@link https://specification.commonwellalliance.org/services/data-broker/cha-broker-api-reference#106-document-retrieval|Use case}
-     * @see {@link https://specification.commonwellalliance.org/services/data-broker/protocol-operations-data-broker#8782-retrieve-document|API spec}
-     */
-    async retrieveDocument(meta, inputUrl, outputStream) {
-        const headers = await this.buildQueryHeaders(meta);
-        return document.retrieve(this.api, headers, inputUrl, outputStream);
-    }
-    //--------------------------------------------------------------------------------------------
-    // Link Management
-    //--------------------------------------------------------------------------------------------
-    /**
-     * Upgrade or downgrade network link.
-     * See: https://specification.commonwellalliance.org/services/record-locator-service/protocol-operations-record-locator-service#8772-upgrading-a-network-link
-     *
-     * @param meta    Metadata about the request.
-     * @param href    The href of network link to be upgraded or downgraded
-     * @param proxy   The proxy for the patient link action.
-     * @returns
-     */
-    async upgradeOrDowngradeNetworkLink(meta, href, proxy) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(href, {
-            proxy,
-        }, {
-            headers,
-        });
-        return link_1.networkLinkSchema.parse(resp.data);
-    }
-    /**
-     * Update a patient link.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8722-updating-a-patient-link
-     *
-     * @param meta              Metadata about the request.
-     * @param patientLinkUri    The uri of patient link to be updated
-     * @param patientUri        The uri of patient that belongs to this link
-     * @param identifier        Add identifier information to the patient link
-     * @returns
-     */
-    async updatePatientLink(meta, patientLinkUri, patientUri, identifier) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.post(patientLinkUri, {
-            patient: patientUri,
-            identifier: identifier,
-        }, {
-            headers,
-        });
-        return person_1.patientLinkSchema.parse(resp.data);
-    }
-    /**
-     * Get a person's links to patients.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8721
-     *
-     * @param meta                Metadata about the request.
-     * @param personId            The person id to be link to a patient.
-     * @param [limitToOrg=true]   Whether to limit the search to the current organization (optional).
-     * @returns Response with list of links to Patients
-     */
-    async getPatientLinks(meta, personId, limitToOrg = true) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`${CommonWell.PERSON_ENDPOINT}/${personId}/patientLink`, {
-            headers,
-            params: {
-                ...(limitToOrg ? { orgId: this.oid } : undefined),
-            },
-        });
-        return person_1.patientLinkSearchRespSchema.parse(resp.data);
-    }
-    /**
-     * Gets a patient link.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8723-getting-a-patient-link
-     *
-     * @param meta              Metadata about the request.
-     * @param personId          Person that is linked
-     * @param patientId         Patient that is linked
-     * @returns
-     */
-    async getPatientLink(meta, personId, patientId) {
-        const headers = await this.buildQueryHeaders(meta);
-        const resp = await this.api.get(`/v1/person/${personId}/patientLink/${patientId}/`, {
-            headers,
-        });
-        return patient_1.patientLinkRespSchema.parse(resp.data);
-    }
-    /**
-     * Deletes a patient link - the link will be moved to LOLA 0 and cannot be used again.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8724-deleting-a-patient-link
-     *
-     * WARNING: This shouldn't be used except under the explicit request of a person.
-     *
-     * @param meta              Metadata about the request.
-     * @param patientLinkUri    The uri of patient link to be deleted
-     * @returns
-     */
-    async deletePatientLink(meta, patientLinkUri) {
-        const headers = await this.buildQueryHeaders(meta);
-        await this.api.delete(patientLinkUri, {
-            headers,
-        });
-        return;
-    }
-    /**
-     * Resets a patient link - the link will be moved to LOLA 1 and can be relinked later.
-     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8725-resetting-a-patient-link
-     *
-     * @param meta              Metadata about the request.
-     * @param personId          Person that is linked
-     * @param patientId         Patient that is linked
-     * @returns
-     */
-    async resetPatientLink(meta, personId, patientId) {
-        const headers = await this.buildQueryHeaders(meta);
-        await this.api.put(`/v1/person/${personId}/patientLink/${patientId}/reset`, {}, {
-            headers,
-        });
-        return;
-    }
-    //--------------------------------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------------------------------
-    async buildQueryHeaders(meta) {
-        const jwt = await (0, make_jwt_1.makeJwt)(this.rsaPrivateKey, meta.role, meta.subjectId, this.orgName, this.oid, meta.purposeOfUse, meta.npi, meta.payloadHash);
-        return { Authorization: `Bearer ${jwt}` };
-    }
-}
-exports.CommonWell = CommonWell;
-CommonWell.integrationUrl = "https://integration.rest.api.commonwellalliance.org";
-CommonWell.productionUrl = "https://rest.api.commonwellalliance.org";
-// V1
-CommonWell.PERSON_ENDPOINT = "/v1/person";
-CommonWell.ORG_ENDPOINT = "/v1/org";
-CommonWell.PATIENT_ENDPOINT = "/v1/patient";
-CommonWell.MEMBER_ENDPOINT = "/v1/member";
-// V2
-CommonWell.DOCUMENT_QUERY_ENDPOINT = "/v2/documentReference";
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommonWell = exports.APIMode = void 0;
+const axios_1 = __importDefault(require("axios"));
+const httpStatus = __importStar(require("http-status"));
+const https_1 = require("https");
+const make_jwt_1 = require("../common/make-jwt");
+const metriport_error_1 = __importDefault(require("../common/metriport-error"));
+const certificates_1 = require("../models/certificates");
+const link_1 = require("../models/link");
+const organization_1 = require("../models/organization");
+const patient_1 = require("../models/patient");
+const person_1 = require("../models/person");
+const document = __importStar(require("./document"));
+const DEFAULT_AXIOS_TIMEOUT_SECONDS = 120;
+var APIMode;
+(function (APIMode) {
+    APIMode["integration"] = "integration";
+    APIMode["production"] = "production";
+})(APIMode = exports.APIMode || (exports.APIMode = {}));
+class CommonWell {
+    /**
+     * Creates a new instance of the CommonWell API client pertaining to an
+     * organization to make requests on behalf of.
+     *
+     * @param orgCert         The certificate (public key) for the organization.
+     * @param rsaPrivateKey   An RSA key corresponding to the specified orgCert.
+     * @param apiMode         The mode the client will be running.
+     * @param apiMode         The mode the client will be running.
+     * @param options         Optional parameters
+     * @param options.timeout Connection timeout in milliseconds, default 120 seconds.
+     */
+    constructor(orgCert, rsaPrivateKey, orgName, oid, apiMode, options = {}) {
+        this.rsaPrivateKey = rsaPrivateKey;
+        this.httpsAgent = new https_1.Agent({ cert: orgCert, key: rsaPrivateKey });
+        this.api = axios_1.default.create({
+            timeout: options?.timeout ?? DEFAULT_AXIOS_TIMEOUT_SECONDS * 1000,
+            baseURL: apiMode === APIMode.production ? CommonWell.productionUrl : CommonWell.integrationUrl,
+            httpsAgent: this.httpsAgent,
+        });
+        this.api.interceptors.response.use(this.axiosSuccessfulResponse(this), this.axiosErrorResponse(this));
+        this.orgName = orgName;
+        this._oid = oid;
+    }
+    get oid() {
+        return this._oid;
+    }
+    /**
+     * Returns the `CW-Reference` header from the last request.
+     */
+    get lastReferenceHeader() {
+        return this._lastReferenceHeader;
+    }
+    // Being extra safe with these bc a failure here fails the actual request
+    postRequest(response) {
+        this._lastReferenceHeader =
+            response && response.headers ? response.headers["cw-reference"] : undefined;
+    }
+    axiosSuccessfulResponse(_this) {
+        return (response) => {
+            _this && _this.postRequest(response);
+            return response;
+        };
+    }
+    axiosErrorResponse(_this) {
+        //eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return (error) => {
+            _this && _this.postRequest(error.response);
+            throw error;
+        };
+    }
+    // TODO: #322 handle errors in API calls as per
+    // https://specification.commonwellalliance.org/services/rest-api-reference (8.6.1 Error)
+    // Note that also sometimes these calls 404 when things aren't found and etc
+    //--------------------------------------------------------------------------------------------
+    // Org Management
+    //--------------------------------------------------------------------------------------------
+    /**
+     * Create an org.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#post-a-new-organization
+     *
+     * @param meta          Metadata about the request.
+     * @param organization  The org to create.
+     * @returns
+     */
+    async createOrg(meta, organization) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org`, organization, {
+            headers,
+        });
+        return organization_1.organizationSchema.parse(resp.data);
+    }
+    /**
+     * Update an org.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#put-new-information-into-an-organization
+     *
+     * @param meta          Metadata about the request.
+     * @param organization  The org to update.
+     * @returns
+     */
+    async updateOrg(meta, organization, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.put(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/`, organization, {
+            headers,
+        });
+        return organization_1.organizationSchema.parse(resp.data);
+    }
+    /**
+     * Get list of orgs.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-a-list-of-all-organizations
+     *
+     * @param meta     Metadata about the request.
+     * @param summary  Returns only summary data
+     * @param offset   Sets an offset number from which recorded returns will begin
+     * @param limit    Limits the number of returned records
+     * @param sort     Specifies sort order
+     * @returns
+     */
+    async getAllOrgs(meta, summary, offset, limit, sort) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org`, {
+            headers,
+            params: { summary, offset, limit, sort },
+        });
+        return organization_1.organizationListSchema.parse(resp.data);
+    }
+    /**
+     * Get one org.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-a-single-organization
+     *
+     * @param meta     Metadata about the request.
+     * @param id       The org to be found
+     * @returns
+     */
+    async getOneOrg(meta, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/`, {
+            headers,
+            validateStatus: null, // don't throw on status code > 299
+        });
+        const status = resp.status;
+        if (status === httpStatus.NOT_FOUND)
+            return undefined;
+        if (httpStatus[`${status}_CLASS`] === httpStatus.classes.SUCCESSFUL) {
+            return organization_1.organizationSchema.parse(resp.data);
+        }
+        throw new metriport_error_1.default(`Failed to retrieve Organization`, status);
+    }
+    /**
+     * Add certificate to org.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#post-new-certificates-to-organizations
+     *
+     * @param meta         Metadata about the request.
+     * @param certificate  The certificate to add to the org
+     * @param id           The org to add a certificate too
+     * @returns
+     */
+    async addCertificateToOrg(meta, certificate, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate`, certificate, {
+            headers,
+        });
+        return certificates_1.certificateRespSchema.parse(resp.data);
+    }
+    /**
+     * Replace certificate for org.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#put-a-list-of-certificates-into-an-organization
+     *
+     * @param meta         Metadata about the request.
+     * @param certificate  The certificate to replace for the org
+     * @param id           The org to replace a certificate for
+     * @returns
+     */
+    async replaceCertificateForOrg(meta, certificate, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.put(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate`, certificate, {
+            headers,
+        });
+        return certificates_1.certificateRespSchema.parse(resp.data);
+    }
+    /**
+     * Delete certificate from org.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#delete-certificates-by-thumbprint
+     *
+     * @param meta         Metadata about the request.
+     * @param id           The org to delete a certificate from
+     * @param thumbprint   The thumbprint from the certificate
+     * @param purpose      The purpose from the certificate
+     * @returns
+     */
+    async deleteCertificateFromOrg(meta, id, thumbprint, purpose) {
+        const headers = await this.buildQueryHeaders(meta);
+        await this.api.delete(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate/${thumbprint}/purpose/${purpose}`, {
+            headers,
+        });
+        return;
+    }
+    /**
+     * Get certificate from org.
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-certificates-for-an-organization
+     *
+     * @param meta         Metadata about the request.
+     * @param certificate  The certificate to add to the org
+     * @param id           The org to get a certificate from
+     * @param thumbprint   The thumbprint from the certificate
+     * @param purpose      The purpose from the certificate
+     * @returns
+     */
+    async getCertificatesFromOrg(meta, id, thumbprint, purpose) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate`, {
+            headers,
+            params: { thumbprint, purpose },
+        });
+        return certificates_1.certificateRespSchema.parse(resp.data);
+    }
+    /**
+     * Get certificate from org (by thumbprint).
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-certificates-by-thumbprint
+     *
+     * @param meta         Metadata about the request.
+     * @param certificate  The certificate to add to the org
+     * @param id           The org to get a certificate from
+     * @param thumbprint   The thumbprint from the certificate
+     * @param purpose      The purpose from the certificate
+     * @returns
+     */
+    async getCertificatesFromOrgByThumbprint(meta, id, thumbprint, purpose) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate/${thumbprint}`, {
+            headers,
+            params: { purpose },
+        });
+        return certificates_1.certificateRespSchema.parse(resp.data);
+    }
+    /**
+     * Get certificate from org (by thumbprint & purpose).
+     * See: https://commonwellalliance.sharepoint.com/sites/ServiceAdopter/SitePages/Organization-Management-API---Overview-and-Summary.aspx#get-certificates-by-thumbprint-and-purpose
+     *
+     * @param meta         Metadata about the request.
+     * @param certificate  The certificate to add to the org
+     * @param id           The org to get a certificate from
+     * @param thumbprint   The thumbprint from the certificate
+     * @param purpose      The purpose from the certificate
+     * @returns
+     */
+    async getCertificatesFromOrgByThumbprintAndPurpose(meta, id, thumbprint, purpose) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.MEMBER_ENDPOINT}/${this.oid}/org/${id}/certificate/${thumbprint}/purpose/${purpose}`, {
+            headers,
+        });
+        return certificates_1.certificateRespSchema.parse(resp.data);
+    }
+    //--------------------------------------------------------------------------------------------
+    // Person Management
+    //--------------------------------------------------------------------------------------------
+    /**
+     * Enrolls a new person.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8716-adding-a-new-person
+     *
+     * @param meta    Metadata about the request.
+     * @param person  The person to enroll.
+     * @returns
+     */
+    async enrollPerson(meta, person) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(CommonWell.PERSON_ENDPOINT, person, {
+            headers,
+        });
+        return person_1.personSchema.parse(resp.data);
+    }
+    /**
+     * Searches for a person based on the specified strong ID.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8711-search-for-a-person
+     *
+     * @param meta    Metadata about the request.
+     * @param key     The ID's value, for example the driver's license ID.
+     * @param system  The ID's uri to specify type, for example "urn:oid:2.16.840.1.113883.4.3.6" is a CA DL.
+     * @returns
+     */
+    async searchPerson(meta, key, system) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(CommonWell.PERSON_ENDPOINT, {
+            headers,
+            params: { key, system },
+        });
+        return person_1.personSearchRespSchema.parse(resp.data);
+    }
+    /**
+     * Searches for a person based on patient demo.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8713-find-persons-matching-patient-demographics
+     *
+     * @param meta        Metadata about the request.
+     * @param patientId   The patient ID.
+     * @returns
+     */
+    async searchPersonByPatientDemo(meta, patientId) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${patientId}/person`, {
+            headers,
+        });
+        return person_1.personSearchRespSchema.parse(resp.data);
+    }
+    /**
+     * Gets a person based on person id.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8713-find-persons-matching-patient-demographics
+     *
+     * @param meta        Metadata about the request.
+     * @param personId   The person ID.
+     * @returns
+     */
+    async getPersonById(meta, personId) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.PERSON_ENDPOINT}/${personId}`, {
+            headers,
+        });
+        return person_1.personSchema.parse(resp.data);
+    }
+    /**
+     * Updates a person.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8741-updating-person-information
+     *
+     * @param meta    Metadata about the request.
+     * @param person  The data to update.
+     * @param id      The person to be updated.
+     * @returns
+     */
+    async updatePerson(meta, person, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(`${CommonWell.PERSON_ENDPOINT}/${id}`, person, {
+            headers,
+        });
+        return person_1.personSchema.parse(resp.data);
+    }
+    /**
+     * Matches a person to a patient.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8732-retrieve-patient-matches
+     *
+     * @param meta    Metadata about the request.
+     * @param id      The person to be matched.
+     * @returns
+     */
+    async patientMatch(meta, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.PERSON_ENDPOINT}/${id}/patientMatch`, {
+            headers,
+            params: { orgId: this.oid },
+        });
+        return patient_1.patientSearchRespSchema.parse(resp.data);
+    }
+    /**
+     * @deprecated use addPatientLink() instead
+     */
+    async patientLink(meta, personId, patientUri, patientStrongId) {
+        return this.addPatientLink(meta, personId, patientUri, patientStrongId);
+    }
+    /**
+     * Add patient link to person.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8721
+     *
+     * @param meta              Metadata about the request.
+     * @param personId          The person id to be link to a patient.
+     * @param patientUri        The patient uri to be link to a person.
+     * @param [patientStrongId] The patient's strong ID, if available (optional).
+     * @returns {PatientLink}
+     */
+    async addPatientLink(meta, personId, patientUri, patientStrongId) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(`${CommonWell.PERSON_ENDPOINT}/${personId}/patientLink`, {
+            patient: patientUri,
+            ...(patientStrongId ? { identifier: patientStrongId } : undefined),
+        }, { headers });
+        return person_1.patientLinkSchema.parse(resp.data);
+    }
+    /**
+     * Re-enrolls a person.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#875-person-unenrollment
+     *
+     * @param meta    Metadata about the request.
+     * @param id      The person to be re-enrolled.
+     * @returns       Person with enrollment information
+     */
+    async reenrollPerson(meta, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.put(`${CommonWell.PERSON_ENDPOINT}/${id}/enroll`, {}, { headers });
+        return person_1.personSchema.parse(resp.data);
+    }
+    /**
+     * Unenrolls a person.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#875-person-unenrollment
+     *
+     * @param meta    Metadata about the request.
+     * @param id      The person to be unenrolled.
+     * @returns
+     */
+    async unenrollPerson(meta, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.put(`${CommonWell.PERSON_ENDPOINT}/${id}/unenroll`, {}, {
+            headers,
+        });
+        return person_1.personSchema.parse(resp.data);
+    }
+    /**
+     * Deletes a person.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8742-deleting-a-person
+     *
+     * @param meta    Metadata about the request.
+     * @param id      The person to be deleted.
+     * @returns
+     */
+    async deletePerson(meta, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        await this.api.delete(`${CommonWell.PERSON_ENDPOINT}/${id}`, { headers });
+        return;
+    }
+    //--------------------------------------------------------------------------------------------
+    // Patient Management
+    //--------------------------------------------------------------------------------------------
+    /**
+     * Register a new patient.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8762-adding-a-local-patient-record
+     *
+     * @param meta    Metadata about the request.
+     * @param patient  The patient to register.
+     * @returns
+     */
+    async registerPatient(meta, patient) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient`, patient, {
+            headers,
+        });
+        return patient_1.patientSchema.parse(resp.data);
+    }
+    /**
+     * Returns a patient based on its ID.
+     *
+     * @param meta    Metadata about the request.
+     * @param id      Patient's ID.
+     * @returns {Promise<Patient>}
+     */
+    async getPatient(meta, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const suffix = id.endsWith("/") ? "" : "/";
+        const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${id}${suffix}`, { headers });
+        return patient_1.patientSchema.parse(resp.data);
+    }
+    /**
+     * Searches for a patient based on params.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8761-search-for-a-patient
+     *
+     * @param meta    Metadata about the request.
+     * @param fname   Patient's first name.
+     * @param lname   Patient's last name.
+     * @param dob     Patient's date of birth.
+     * @param gender  Patient's gender.
+     * @param zip     Patient's zip code.
+     * @returns
+     */
+    async searchPatient(meta, fname, lname, dob, gender, zip) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient`, {
+            headers,
+            params: { fname, lname, dob, gender, zip },
+        });
+        return patient_1.patientSearchRespSchema.parse(resp.data);
+    }
+    /**
+     * Updates a patient.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8763-updating-a-local-patient-record
+     *
+     * @param meta     Metadata about the request.
+     * @param patient  The data to update.
+     * @param id       The patient to be updated.
+     * @returns
+     */
+    async updatePatient(meta, patient, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${id}/`, patient, {
+            headers,
+        });
+        return patient_1.patientSchema.parse(resp.data);
+    }
+    /**
+     * Merges patients.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8765-merging-local-patient-records
+     *
+     * @param meta    Metadata about the request.
+     * @param nonSurvivingPatientId  The local Patient Identifier of the non-surviving Patient Record (This patient gets replaced)
+     * @param referencePatientLink   The patient link for the patient that will replace the non surviving patient
+     * @returns
+     */
+    async mergePatients(meta, nonSurvivingPatientId, referencePatientLink) {
+        const headers = await this.buildQueryHeaders(meta);
+        await this.api.put(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${nonSurvivingPatientId}/merge`, {
+            link: {
+                other: {
+                    reference: referencePatientLink,
+                },
+                type: "replace",
+            },
+        }, {
+            headers,
+        });
+        return;
+    }
+    /**
+     * Get Patient's Network Links.
+     * See: https://specification.commonwellalliance.org/services/record-locator-service/protocol-operations-record-locator-service#8771-retrieving-network-links
+     *
+     * @param meta        Metadata about the request.
+     * @param patientId   Patient for which to get the network links.
+     * @returns
+     */
+    async getNetworkLinks(meta, patientId) {
+        const headers = await this.buildQueryHeaders(meta);
+        // Error handling: https://github.com/metriport/metriport-internal/issues/322
+        try {
+            const resp = await this.api.get(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${patientId}/networkLink`, {
+                headers,
+            });
+            return patient_1.patientNetworkLinkRespSchema.parse(resp.data);
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        }
+        catch (err) {
+            // when there's no NetworkLink, CW's API return 412
+            if (err.response?.status === 412)
+                return { _embedded: { networkLink: [] } };
+            throw err;
+        }
+    }
+    /**
+     * Deletes a patient.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8764-deleting-a-local-patient-record
+     *
+     * @param meta    Metadata about the request.
+     * @param id      The patient to be updated.
+     * @returns
+     */
+    async deletePatient(meta, id) {
+        const headers = await this.buildQueryHeaders(meta);
+        await this.api.delete(`${CommonWell.ORG_ENDPOINT}/${this.oid}/patient/${id}/`, {
+            headers,
+        });
+    }
+    //--------------------------------------------------------------------------------------------
+    // Document Management
+    //--------------------------------------------------------------------------------------------
+    /**
+     * Queries a patient's Documents.
+     *
+     * @param meta       Metadata about the request.
+     * @param patientId  The patient's ID.
+     * @returns {Promise<DocumentQueryResponse>}
+     * @see {@link https://specification.commonwellalliance.org/services/data-broker/cha-broker-api-reference#104-document-query|Use case}
+     * @see {@link https://specification.commonwellalliance.org/services/data-broker/protocol-operations-data-broker#8781-find-documents|API spec}
+     */
+    async queryDocuments(meta, patientId) {
+        const headers = await this.buildQueryHeaders(meta);
+        return document.query(this.api, headers, patientId);
+    }
+    /**
+     * Queries a patient's Documents - including other possible results.
+     *
+     * @param meta       Metadata about the request.
+     * @param patientId  The patient's ID.
+     * @returns The DocumentReferences of a patient's available documents and/or OperationOutcomes denoting problems with the query.
+     * @see {@link https://specification.commonwellalliance.org/services/data-broker/cha-broker-api-reference#104-document-query|Use case}
+     * @see {@link https://specification.commonwellalliance.org/services/data-broker/protocol-operations-data-broker#8781-find-documents|API spec}
+     */
+    async queryDocumentsFull(meta, patientId) {
+        const headers = await this.buildQueryHeaders(meta);
+        return document.queryFull(this.api, headers, patientId);
+    }
+    /**
+     * Retrieve a Document and pipe its bytes into the outputStream.
+     *
+     * @param {string} inputUrl - The URL of the file to be downloaded.
+     * @param {fs.WriteStream} outputStream - The stream to receive the downloaded file's bytes.
+     * @returns {Promise<void>}
+     * @see {@link https://specification.commonwellalliance.org/services/data-broker/cha-broker-api-reference#106-document-retrieval|Use case}
+     * @see {@link https://specification.commonwellalliance.org/services/data-broker/protocol-operations-data-broker#8782-retrieve-document|API spec}
+     */
+    async retrieveDocument(meta, inputUrl, outputStream) {
+        const headers = await this.buildQueryHeaders(meta);
+        return document.retrieve(this.api, headers, inputUrl, outputStream);
+    }
+    //--------------------------------------------------------------------------------------------
+    // Link Management
+    //--------------------------------------------------------------------------------------------
+    /**
+     * Upgrade or downgrade network link.
+     * See: https://specification.commonwellalliance.org/services/record-locator-service/protocol-operations-record-locator-service#8772-upgrading-a-network-link
+     *
+     * @param meta    Metadata about the request.
+     * @param href    The href of network link to be upgraded or downgraded
+     * @param proxy   The proxy for the patient link action.
+     * @returns
+     */
+    async upgradeOrDowngradeNetworkLink(meta, href, proxy) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(href, {
+            proxy,
+        }, {
+            headers,
+        });
+        return link_1.networkLinkSchema.parse(resp.data);
+    }
+    /**
+     * Update a patient link.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8722-updating-a-patient-link
+     *
+     * @param meta              Metadata about the request.
+     * @param patientLinkUri    The uri of patient link to be updated
+     * @param patientUri        The uri of patient that belongs to this link
+     * @param identifier        Add identifier information to the patient link
+     * @returns
+     */
+    async updatePatientLink(meta, patientLinkUri, patientUri, identifier) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.post(patientLinkUri, {
+            patient: patientUri,
+            identifier: identifier,
+        }, {
+            headers,
+        });
+        return person_1.patientLinkSchema.parse(resp.data);
+    }
+    /**
+     * Get a person's links to patients.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8721
+     *
+     * @param meta                Metadata about the request.
+     * @param personId            The person id to be link to a patient.
+     * @param [limitToOrg=true]   Whether to limit the search to the current organization (optional).
+     * @returns Response with list of links to Patients
+     */
+    async getPatientLinks(meta, personId, limitToOrg = true) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`${CommonWell.PERSON_ENDPOINT}/${personId}/patientLink`, {
+            headers,
+            params: {
+                ...(limitToOrg ? { orgId: this.oid } : undefined),
+            },
+        });
+        return person_1.patientLinkSearchRespSchema.parse(resp.data);
+    }
+    /**
+     * Gets a patient link.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8723-getting-a-patient-link
+     *
+     * @param meta              Metadata about the request.
+     * @param personId          Person that is linked
+     * @param patientId         Patient that is linked
+     * @returns
+     */
+    async getPatientLink(meta, personId, patientId) {
+        const headers = await this.buildQueryHeaders(meta);
+        const resp = await this.api.get(`/v1/person/${personId}/patientLink/${patientId}/`, {
+            headers,
+        });
+        return patient_1.patientLinkRespSchema.parse(resp.data);
+    }
+    /**
+     * Deletes a patient link - the link will be moved to LOLA 0 and cannot be used again.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8724-deleting-a-patient-link
+     *
+     * WARNING: This shouldn't be used except under the explicit request of a person.
+     *
+     * @param meta              Metadata about the request.
+     * @param patientLinkUri    The uri of patient link to be deleted
+     * @returns
+     */
+    async deletePatientLink(meta, patientLinkUri) {
+        const headers = await this.buildQueryHeaders(meta);
+        await this.api.delete(patientLinkUri, {
+            headers,
+        });
+        return;
+    }
+    /**
+     * Resets a patient link - the link will be moved to LOLA 1 and can be relinked later.
+     * See: https://specification.commonwellalliance.org/services/patient-identity-and-linking/protocol-operations#8725-resetting-a-patient-link
+     *
+     * @param meta              Metadata about the request.
+     * @param personId          Person that is linked
+     * @param patientId         Patient that is linked
+     * @returns
+     */
+    async resetPatientLink(meta, personId, patientId) {
+        const headers = await this.buildQueryHeaders(meta);
+        await this.api.put(`/v1/person/${personId}/patientLink/${patientId}/reset`, {}, {
+            headers,
+        });
+        return;
+    }
+    //--------------------------------------------------------------------------------------------
+    // Private Methods
+    //--------------------------------------------------------------------------------------------
+    async buildQueryHeaders(meta) {
+        const jwt = await (0, make_jwt_1.makeJwt)(this.rsaPrivateKey, meta.role, meta.subjectId, this.orgName, this.oid, meta.purposeOfUse, meta.npi, meta.payloadHash);
+        return { Authorization: `Bearer ${jwt}` };
+    }
+}
+exports.CommonWell = CommonWell;
+CommonWell.integrationUrl = "https://integration.rest.api.commonwellalliance.org";
+CommonWell.productionUrl = "https://rest.api.commonwellalliance.org";
+// V1
+CommonWell.PERSON_ENDPOINT = "/v1/person";
+CommonWell.ORG_ENDPOINT = "/v1/org";
+CommonWell.PATIENT_ENDPOINT = "/v1/patient";
+CommonWell.MEMBER_ENDPOINT = "/v1/member";
+// V2
+CommonWell.DOCUMENT_QUERY_ENDPOINT = "/v2/documentReference";
 //# sourceMappingURL=commonwell.js.map