@metriport/commonwell-sdk 4.3.11 → 4.3.13

package/lib/client/commonwell.d.ts

@@ -1,425 +1,425 @@
-/// <reference types="node" />
-import { AxiosInstance } from "axios";
-import * as stream from "stream";
-import { CommonWellAPI } from "..";
-import { CertificateParam, CertificateResp } from "../models/certificates";
-import { DocumentQueryFullResponse, DocumentQueryResponse } from "../models/document";
-import { Identifier, StrongId } from "../models/identifier";
-import { NetworkLink, PatientLinkProxy } from "../models/link";
-import { Organization, OrganizationList } from "../models/organization";
-import { Patient, PatientLinkResp, PatientNetworkLinkResp, PatientSearchResp } from "../models/patient";
-import { PatientLink, PatientLinkSearchResp, Person, PersonSearchResp } from "../models/person";
-import { PurposeOfUse } from "../models/purpose-of-use";
-export declare enum APIMode {
-    integration = "integration",
-    production = "production"
-}
-export interface RequestMetadata {
-    role: string;
-    subjectId: string;
-    purposeOfUse: PurposeOfUse;
-    npi?: string;
-    payloadHash?: string;
-}
-export declare class CommonWell implements CommonWellAPI {
-    static integrationUrl: string;
-    static productionUrl: string;
-    static PERSON_ENDPOINT: string;
-    static ORG_ENDPOINT: string;
-    static PATIENT_ENDPOINT: string;
-    static MEMBER_ENDPOINT: string;
-    static DOCUMENT_QUERY_ENDPOINT: string;
-    readonly api: AxiosInstance;
-    private rsaPrivateKey;
-    private orgName;
-    private _oid;
-    private httpsAgent;
-    private _lastReferenceHeader;
-    /**
-     * 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: string, rsaPrivateKey: string, orgName: string, oid: string, apiMode: APIMode, options?: {
-        timeout?: number;
-    });
-    get oid(): string;
-    /**
-     * Returns the `CW-Reference` header from the last request.
-     */
-    get lastReferenceHeader(): string | undefined;
-    private postRequest;
-    private axiosSuccessfulResponse;
-    private axiosErrorResponse;
-    /**
-     * 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
-     */
-    createOrg(meta: RequestMetadata, organization: Organization): Promise<Organization>;
-    /**
-     * 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
-     */
-    updateOrg(meta: RequestMetadata, organization: Organization, id: string): Promise<Organization>;
-    /**
-     * 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
-     */
-    getAllOrgs(meta: RequestMetadata, summary?: boolean, offset?: number, limit?: number, sort?: string): Promise<OrganizationList>;
-    /**
-     * 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
-     */
-    getOneOrg(meta: RequestMetadata, id: string): Promise<Organization | undefined>;
-    /**
-     * 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
-     */
-    addCertificateToOrg(meta: RequestMetadata, certificate: CertificateParam, id: string): Promise<CertificateResp>;
-    /**
-     * 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
-     */
-    replaceCertificateForOrg(meta: RequestMetadata, certificate: CertificateParam, id: string): Promise<CertificateResp>;
-    /**
-     * 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
-     */
-    deleteCertificateFromOrg(meta: RequestMetadata, id: string, thumbprint: string, purpose: string): Promise<void>;
-    /**
-     * 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
-     */
-    getCertificatesFromOrg(meta: RequestMetadata, id: string, thumbprint?: string, purpose?: string): Promise<CertificateResp>;
-    /**
-     * 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
-     */
-    getCertificatesFromOrgByThumbprint(meta: RequestMetadata, id: string, thumbprint: string, purpose?: string): Promise<CertificateResp>;
-    /**
-     * 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
-     */
-    getCertificatesFromOrgByThumbprintAndPurpose(meta: RequestMetadata, id: string, thumbprint: string, purpose: string): Promise<CertificateResp>;
-    /**
-     * 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
-     */
-    enrollPerson(meta: RequestMetadata, person: Person): Promise<Person>;
-    /**
-     * 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
-     */
-    searchPerson(meta: RequestMetadata, key: string, system: string): Promise<PersonSearchResp>;
-    /**
-     * 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
-     */
-    searchPersonByPatientDemo(meta: RequestMetadata, patientId: string): Promise<PersonSearchResp>;
-    /**
-     * 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
-     */
-    getPersonById(meta: RequestMetadata, personId: string): Promise<Person>;
-    /**
-     * 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
-     */
-    updatePerson(meta: RequestMetadata, person: Person, id: string): Promise<Person>;
-    /**
-     * 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
-     */
-    patientMatch(meta: RequestMetadata, id: string): Promise<PatientSearchResp>;
-    /**
-     * @deprecated use addPatientLink() instead
-     */
-    patientLink(meta: RequestMetadata, personId: string, patientUri: string, patientStrongId?: StrongId): Promise<PatientLink>;
-    /**
-     * 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}
-     */
-    addPatientLink(meta: RequestMetadata, personId: string, patientUri: string, patientStrongId?: StrongId): Promise<PatientLink>;
-    /**
-     * 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
-     */
-    reenrollPerson(meta: RequestMetadata, id: string): Promise<Person>;
-    /**
-     * 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
-     */
-    unenrollPerson(meta: RequestMetadata, id: string): Promise<Person>;
-    /**
-     * 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
-     */
-    deletePerson(meta: RequestMetadata, id: string): Promise<void>;
-    /**
-     * 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
-     */
-    registerPatient(meta: RequestMetadata, patient: Patient): Promise<Patient>;
-    /**
-     * Returns a patient based on its ID.
-     *
-     * @param meta    Metadata about the request.
-     * @param id      Patient's ID.
-     * @returns {Promise<Patient>}
-     */
-    getPatient(meta: RequestMetadata, id: string): Promise<Patient>;
-    /**
-     * 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
-     */
-    searchPatient(meta: RequestMetadata, fname: string, lname: string, dob: string, gender?: string, zip?: string): Promise<PatientSearchResp>;
-    /**
-     * 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
-     */
-    updatePatient(meta: RequestMetadata, patient: Patient, id: string): Promise<Patient>;
-    /**
-     * 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
-     */
-    mergePatients(meta: RequestMetadata, nonSurvivingPatientId: string, referencePatientLink: string): Promise<void>;
-    /**
-     * 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
-     */
-    getNetworkLinks(meta: RequestMetadata, patientId: string): Promise<PatientNetworkLinkResp>;
-    /**
-     * 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
-     */
-    deletePatient(meta: RequestMetadata, id: string): Promise<void>;
-    /**
-     * 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}
-     */
-    queryDocuments(meta: RequestMetadata, patientId: string): Promise<DocumentQueryResponse>;
-    /**
-     * 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}
-     */
-    queryDocumentsFull(meta: RequestMetadata, patientId: string): Promise<DocumentQueryFullResponse>;
-    /**
-     * 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}
-     */
-    retrieveDocument(meta: RequestMetadata, inputUrl: string, outputStream: stream.Writable): Promise<void>;
-    /**
-     * 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
-     */
-    upgradeOrDowngradeNetworkLink(meta: RequestMetadata, href: string, proxy?: PatientLinkProxy): Promise<NetworkLink>;
-    /**
-     * 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
-     */
-    updatePatientLink(meta: RequestMetadata, patientLinkUri: string, patientUri?: string, identifier?: Identifier): Promise<PatientLink>;
-    /**
-     * 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
-     */
-    getPatientLinks(meta: RequestMetadata, personId: string, limitToOrg?: boolean): Promise<PatientLinkSearchResp>;
-    /**
-     * 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
-     */
-    getPatientLink(meta: RequestMetadata, personId: string, patientId: string): Promise<PatientLinkResp>;
-    /**
-     * 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
-     */
-    deletePatientLink(meta: RequestMetadata, patientLinkUri: string): Promise<void>;
-    /**
-     * 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
-     */
-    resetPatientLink(meta: RequestMetadata, personId: string, patientId: string): Promise<void>;
-    private buildQueryHeaders;
-}
+/// <reference types="node" />
+import { AxiosInstance } from "axios";
+import * as stream from "stream";
+import { CommonWellAPI } from "..";
+import { CertificateParam, CertificateResp } from "../models/certificates";
+import { DocumentQueryFullResponse, DocumentQueryResponse } from "../models/document";
+import { Identifier, StrongId } from "../models/identifier";
+import { NetworkLink, PatientLinkProxy } from "../models/link";
+import { Organization, OrganizationList } from "../models/organization";
+import { Patient, PatientLinkResp, PatientNetworkLinkResp, PatientSearchResp } from "../models/patient";
+import { PatientLink, PatientLinkSearchResp, Person, PersonSearchResp } from "../models/person";
+import { PurposeOfUse } from "../models/purpose-of-use";
+export declare enum APIMode {
+    integration = "integration",
+    production = "production"
+}
+export interface RequestMetadata {
+    role: string;
+    subjectId: string;
+    purposeOfUse: PurposeOfUse;
+    npi?: string;
+    payloadHash?: string;
+}
+export declare class CommonWell implements CommonWellAPI {
+    static integrationUrl: string;
+    static productionUrl: string;
+    static PERSON_ENDPOINT: string;
+    static ORG_ENDPOINT: string;
+    static PATIENT_ENDPOINT: string;
+    static MEMBER_ENDPOINT: string;
+    static DOCUMENT_QUERY_ENDPOINT: string;
+    readonly api: AxiosInstance;
+    private rsaPrivateKey;
+    private orgName;
+    private _oid;
+    private httpsAgent;
+    private _lastReferenceHeader;
+    /**
+     * 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: string, rsaPrivateKey: string, orgName: string, oid: string, apiMode: APIMode, options?: {
+        timeout?: number;
+    });
+    get oid(): string;
+    /**
+     * Returns the `CW-Reference` header from the last request.
+     */
+    get lastReferenceHeader(): string | undefined;
+    private postRequest;
+    private axiosSuccessfulResponse;
+    private axiosErrorResponse;
+    /**
+     * 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
+     */
+    createOrg(meta: RequestMetadata, organization: Organization): Promise<Organization>;
+    /**
+     * 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
+     */
+    updateOrg(meta: RequestMetadata, organization: Organization, id: string): Promise<Organization>;
+    /**
+     * 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
+     */
+    getAllOrgs(meta: RequestMetadata, summary?: boolean, offset?: number, limit?: number, sort?: string): Promise<OrganizationList>;
+    /**
+     * 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
+     */
+    getOneOrg(meta: RequestMetadata, id: string): Promise<Organization | undefined>;
+    /**
+     * 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
+     */
+    addCertificateToOrg(meta: RequestMetadata, certificate: CertificateParam, id: string): Promise<CertificateResp>;
+    /**
+     * 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
+     */
+    replaceCertificateForOrg(meta: RequestMetadata, certificate: CertificateParam, id: string): Promise<CertificateResp>;
+    /**
+     * 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
+     */
+    deleteCertificateFromOrg(meta: RequestMetadata, id: string, thumbprint: string, purpose: string): Promise<void>;
+    /**
+     * 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
+     */
+    getCertificatesFromOrg(meta: RequestMetadata, id: string, thumbprint?: string, purpose?: string): Promise<CertificateResp>;
+    /**
+     * 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
+     */
+    getCertificatesFromOrgByThumbprint(meta: RequestMetadata, id: string, thumbprint: string, purpose?: string): Promise<CertificateResp>;
+    /**
+     * 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
+     */
+    getCertificatesFromOrgByThumbprintAndPurpose(meta: RequestMetadata, id: string, thumbprint: string, purpose: string): Promise<CertificateResp>;
+    /**
+     * 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
+     */
+    enrollPerson(meta: RequestMetadata, person: Person): Promise<Person>;
+    /**
+     * 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
+     */
+    searchPerson(meta: RequestMetadata, key: string, system: string): Promise<PersonSearchResp>;
+    /**
+     * 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
+     */
+    searchPersonByPatientDemo(meta: RequestMetadata, patientId: string): Promise<PersonSearchResp>;
+    /**
+     * 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
+     */
+    getPersonById(meta: RequestMetadata, personId: string): Promise<Person>;
+    /**
+     * 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
+     */
+    updatePerson(meta: RequestMetadata, person: Person, id: string): Promise<Person>;
+    /**
+     * 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
+     */
+    patientMatch(meta: RequestMetadata, id: string): Promise<PatientSearchResp>;
+    /**
+     * @deprecated use addPatientLink() instead
+     */
+    patientLink(meta: RequestMetadata, personId: string, patientUri: string, patientStrongId?: StrongId): Promise<PatientLink>;
+    /**
+     * 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}
+     */
+    addPatientLink(meta: RequestMetadata, personId: string, patientUri: string, patientStrongId?: StrongId): Promise<PatientLink>;
+    /**
+     * 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
+     */
+    reenrollPerson(meta: RequestMetadata, id: string): Promise<Person>;
+    /**
+     * 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
+     */
+    unenrollPerson(meta: RequestMetadata, id: string): Promise<Person>;
+    /**
+     * 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
+     */
+    deletePerson(meta: RequestMetadata, id: string): Promise<void>;
+    /**
+     * 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
+     */
+    registerPatient(meta: RequestMetadata, patient: Patient): Promise<Patient>;
+    /**
+     * Returns a patient based on its ID.
+     *
+     * @param meta    Metadata about the request.
+     * @param id      Patient's ID.
+     * @returns {Promise<Patient>}
+     */
+    getPatient(meta: RequestMetadata, id: string): Promise<Patient>;
+    /**
+     * 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
+     */
+    searchPatient(meta: RequestMetadata, fname: string, lname: string, dob: string, gender?: string, zip?: string): Promise<PatientSearchResp>;
+    /**
+     * 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
+     */
+    updatePatient(meta: RequestMetadata, patient: Patient, id: string): Promise<Patient>;
+    /**
+     * 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
+     */
+    mergePatients(meta: RequestMetadata, nonSurvivingPatientId: string, referencePatientLink: string): Promise<void>;
+    /**
+     * 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
+     */
+    getNetworkLinks(meta: RequestMetadata, patientId: string): Promise<PatientNetworkLinkResp>;
+    /**
+     * 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
+     */
+    deletePatient(meta: RequestMetadata, id: string): Promise<void>;
+    /**
+     * 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}
+     */
+    queryDocuments(meta: RequestMetadata, patientId: string): Promise<DocumentQueryResponse>;
+    /**
+     * 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}
+     */
+    queryDocumentsFull(meta: RequestMetadata, patientId: string): Promise<DocumentQueryFullResponse>;
+    /**
+     * 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}
+     */
+    retrieveDocument(meta: RequestMetadata, inputUrl: string, outputStream: stream.Writable): Promise<void>;
+    /**
+     * 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
+     */
+    upgradeOrDowngradeNetworkLink(meta: RequestMetadata, href: string, proxy?: PatientLinkProxy): Promise<NetworkLink>;
+    /**
+     * 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
+     */
+    updatePatientLink(meta: RequestMetadata, patientLinkUri: string, patientUri?: string, identifier?: Identifier): Promise<PatientLink>;
+    /**
+     * 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
+     */
+    getPatientLinks(meta: RequestMetadata, personId: string, limitToOrg?: boolean): Promise<PatientLinkSearchResp>;
+    /**
+     * 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
+     */
+    getPatientLink(meta: RequestMetadata, personId: string, patientId: string): Promise<PatientLinkResp>;
+    /**
+     * 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
+     */
+    deletePatientLink(meta: RequestMetadata, patientLinkUri: string): Promise<void>;
+    /**
+     * 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
+     */
+    resetPatientLink(meta: RequestMetadata, personId: string, patientId: string): Promise<void>;
+    private buildQueryHeaders;
+}