@careevolution/orchestrate
Version:
A TypeScript client for the Orchestrate API
191 lines (190 loc) • 10.8 kB
TypeScript
import { Bundle } from "fhir/r4.js";
import { IHttpHandler } from "./httpHandler.js";
export type ConvertHl7ToFhirR4RequestProcessingHint = "default" | "transcription" | "lab";
export type ConvertHl7ToFhirR4Request = {
content: string;
patientID?: string;
patientIdentifier?: string;
patientIdentifierSystem?: string;
tz?: string;
processingHint?: ConvertHl7ToFhirR4RequestProcessingHint;
};
export type ConvertHl7ToFhirR4Response = Bundle;
export type ConvertCdaToFhirR4Request = {
content: string;
patientID?: string;
patientIdentifier?: string;
patientIdentifierSystem?: string;
includeOriginalCda?: boolean;
includeStandardizedCda?: boolean;
};
export type ConvertCdaToFhirR4Response = Bundle;
export type ConvertCdaToFhirResponse = Bundle;
export type ConvertCdaToPdfRequest = {
content: string;
};
export type ConvertCdaToPdfResponse = ArrayBuffer;
export type ConvertFhirR4ToCdaRequest = {
content: Bundle;
};
export type ConvertFhirR4ToCdaResponse = string;
export type ConvertFhirR4ToOmopRequest = {
content: Bundle;
};
export type ConvertFhirR4ToOmopResponse = ArrayBuffer;
export type ConvertCombineFhirR4BundlesRequest = {
content: string;
patientID?: string;
patientIdentifier?: string;
patientIdentifierSystem?: string;
};
export type ConvertFhirDstu2ToFhirR4Request = {
content: unknown;
};
export type ConvertFhirDstu2ToFhirR4Response = Bundle;
export type ConvertFhirStu3ToFhirR4Request = {
content: unknown;
};
export type ConvertFhirStu3ToFhirR4Response = Bundle;
export type ConvertFhirR4ToHealthLakeRequest = {
content: Bundle;
};
export type ConvertFhirR4ToHealthLakeResponse = Bundle;
export declare function generateConvertCombinedFhirBundlesRequestFromBundles(fhirBundles: Bundle[], personID?: string): ConvertCombineFhirR4BundlesRequest;
export type ConvertCombineFhirR4BundlesResponse = Bundle;
export type ConvertX12ToFhirR4Request = {
content: string;
patientID?: string;
patientIdentifier?: string;
patientIdentifierSystem?: string;
};
export type ConvertX12ToFhirR4Response = Bundle;
export type ConvertCdaToHtmlRequest = {
content: string;
};
export type ConvertCdaToHtmlResponse = string;
export type ConvertFhirR4ToNemsisV34Request = {
content: Bundle;
};
export type ConvertFhirR4ToNemsisV34Response = string;
export type ConvertFhirR4ToNemsisV35Request = {
content: Bundle;
};
export type ConvertFhirR4ToNemsisV35Response = string;
export type ConvertFhirR4ToManifestRequest = {
content: Bundle;
delimiter?: string;
};
export type ConvertFhirR4ToManifestResponse = ArrayBuffer;
export declare class ConvertApi {
private httpHandler;
constructor(httpHandler: IHttpHandler);
/**
* Converts one or more HL7v2 messages into a FHIR R4 bundle
* @param request The request object with a single or newline-delimited set of HL7v2.7 messages and following properties:
* @param request.patientID The patient ID to associate with the clinical data
* @param request.patientIdentifier A patient identifier to add to the identifier list of the patient resource in the FHIR bundle. Must be specified along with patientIdentifierSystem
* @param request.patientIdentifierSystem The system providing the patient identifier. Must be specified along with patientIdentifier (Optional)
* @param request.tz Default timezone for date-times in the HL7 when no timezone offset is present. Must be IANA or Windows timezone name. Defaults to UTC.
* @returns A FHIR R4 Bundle containing the clinical data parsed out of the HL7 messages
* @link https://rosetta-api.docs.careevolution.com/convert/hl7_to_fhir.html
*/
hl7ToFhirR4(request: ConvertHl7ToFhirR4Request): Promise<ConvertHl7ToFhirR4Response>;
/**
* Converts a CDA document into a FHIR R4 bundle
* @param request The request object with a single CDA document as content and following properties:
* @param request.patientID - The patient ID to use for the FHIR bundle (Optional)
* @param request.patientIdentifier - A patient identifier to add to the identifier list of the patient resource in the FHIR bundle. Must be specified along with patientIdentifierSystem (Optional)
* @param request.patientIdentifierSystem - The system providing the patient identifier. Must be specified along with patientIdentifier (Optional)
* @param request.includeOriginalCda - Whether to include the original CDA document in the FHIR bundle. Default is false (Optional)
* @param request.includeStandardizedCda - Whether to include the standardized CDA document in the FHIR bundle. Default is false (Optional)
* @returns A FHIR R4 Bundle containing the clinical data parsed out of the CDA
* @link https://rosetta-api.docs.careevolution.com/convert/cda_to_fhir.html
*/
cdaToFhirR4(request: ConvertCdaToFhirR4Request): Promise<ConvertCdaToFhirR4Response>;
/**
* Converts a CDA document into a PDF document
* @param request The request object a single CDA document as content
* @returns A formatted PDF document suitable for human review
* @link https://rosetta-api.docs.careevolution.com/convert/cda_to_pdf.html
*/
cdaToPdf(request: ConvertCdaToPdfRequest): Promise<ConvertCdaToPdfResponse>;
/**
* Converts a FHIR R4 bundle into an aggregated CDA document.
* @param request A FHIR R4 bundle for a single patient
* @returns An aggregated C-CDA R2.1 document in XML format
* @link https://rosetta-api.docs.careevolution.com/convert/fhir_to_cda.html
*/
fhirR4ToCda(request: ConvertFhirR4ToCdaRequest): Promise<ConvertFhirR4ToCdaResponse>;
/**
* Converts a FHIR R4 bundle into the OMOP Common Data Model v5.4 format.
* @param request A FHIR R4 bundle for a single patient
* @returns A ZIP archive containing multiple CSV files, one for each supported OMOP data table.
*/
fhirR4ToOmop(request: ConvertFhirR4ToOmopRequest): Promise<ConvertFhirR4ToOmopResponse>;
/**
* This operation aggregates information retrieved from prior Convert API requests into a single entry.
* @param request A newline-delimited JSON list of FHIR R4 Bundles
* @returns A single FHIR R4 Bundle containing the merged data from the input.
* @link https://rosetta-api.docs.careevolution.com/convert/fhir_to_omop.html
*/
combineFhirR4Bundles(request: ConvertCombineFhirR4BundlesRequest): Promise<ConvertCombineFhirR4BundlesResponse>;
/**
* Converts an X12 document into a FHIR R4 bundle.
* @param request A standard version 5010 X12 document
* @param patientID The patient ID to use for the FHIR bundle
* @param patientIdentifier A patient identifier to add to the identifier list of the patient resource in the FHIR bundle. Must be specified along with patientIdentifierSystem
* @param patientIdentifierSystem The system providing the patient identifier. Must be specified along with patientIdentifier
* @returns A FHIR R4 Bundle containing the clinical data parsed out of the X12 messages
*/
x12ToFhirR4(request: ConvertX12ToFhirR4Request): Promise<ConvertX12ToFhirR4Response>;
/**
* Converts a FHIR DSTU2 bundle into a FHIR R4 bundle.
* @param request The FHIR DSTU2 bundle to convert
* @returns A FHIR R4 Bundle containing the clinical data parsed out of the FHIR DSTU2 bundle
* @link https://orchestrate.docs.careevolution.com/convert/update_fhir_version.html
*/
fhirDstu2ToFhirR4(request: ConvertFhirDstu2ToFhirR4Request): Promise<ConvertFhirDstu2ToFhirR4Response>;
/**
* Converts a FHIR STU3 bundle into a FHIR R4 bundle.
* @param request The FHIR STU3 bundle to convert
* @returns A FHIR R4 Bundle containing the clinical data parsed out of the FHIR STU3 bundle
* @link https://orchestrate.docs.careevolution.com/convert/update_fhir_version.html
*/
fhirStu3ToFhirR4(request: ConvertFhirStu3ToFhirR4Request): Promise<ConvertFhirStu3ToFhirR4Response>;
/**
* This operation converts a FHIR R4 bundle from one of the other Orchestrate FHIR conversions (CDA-to-FHIR, HL7-to-FHIR, or Combine Bundles) into a form compatible with the Amazon HealthLake analysis platform.
* @param request A FHIR R4 bundle for a single patient
* @returns A FHIR R4 bundle of type collection, containing individual FHIR bundles compatible with the HealthLake API restrictions.
* @link https://orchestrate.docs.careevolution.com/convert/fhir_to_health_lake.html
*/
fhirR4ToHealthLake(request: ConvertFhirR4ToHealthLakeRequest): Promise<ConvertFhirR4ToHealthLakeResponse>;
/**
* Converts a CDA document into human-readable HTML.
* @param request A single CDA document
* @returns A formatted HTML document suitable for human review
* @link https://rosetta-api.docs.careevolution.com/convert/cda_to_html.html
*/
cdaToHtml(request: ConvertCdaToHtmlRequest): Promise<ConvertCdaToHtmlResponse>;
/**
* Converts a FHIR R4 bundle (including one from CDA-to-FHIR, HL7-to-FHIR, or Combine Bundles) into the National Emergency Medical Services Information System (NEMSIS) XML format.
* @param request A FHIR R4 bundle for a single patient. The bundle must contain at least one Encounter resource with a valid admission date.
* @returns A NEMSIS v3.4 document in XML format.
* @link https://orchestrate.docs.careevolution.com/convert/fhir_to_nemsis.html
*/
fhirR4ToNemsisV34(request: ConvertFhirR4ToNemsisV34Request): Promise<ConvertFhirR4ToNemsisV34Response>;
/**
* Converts a FHIR R4 bundle (including one from CDA-to-FHIR, HL7-to-FHIR, or Combine Bundles) into the National Emergency Medical Services Information System (NEMSIS) XML format.
* @param request A FHIR R4 bundle for a single patient. The bundle must contain at least one Encounter resource with a valid admission date.
* @returns A NEMSIS v3.5 document in XML format.
* @link https://orchestrate.docs.careevolution.com/convert/fhir_to_nemsis.html
*/
fhirR4ToNemsisV35(request: ConvertFhirR4ToNemsisV35Request): Promise<ConvertFhirR4ToNemsisV35Response>;
/**
* Generates a tabular report of clinical concepts from a FHIR R4 bundle. With this tabular data, you can easily scan results, run queries, and understand the value of your clinical data.
* @param bundle A FHIR R4 Bundle
* @returns A ZIP file containing a number of Comma-Separated Value (CSV) files corresponding to clinical concepts (conditions, encounters, etc.).
* @link https://rosetta-api.docs.careevolution.com/insight/fhir_manifest.html
*/
fhirR4ToManifest(request: ConvertFhirR4ToManifestRequest): Promise<ConvertFhirR4ToManifestResponse>;
}