@careevolution/orchestrate
Version:
A TypeScript client for the Orchestrate API
265 lines (264 loc) • 13 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConvertApi = void 0;
exports.generateConvertCombinedFhirBundlesRequestFromBundles = generateConvertCombinedFhirBundlesRequestFromBundles;
function generateConvertCombinedFhirBundlesRequestFromBundles(fhirBundles, personID) {
const bundles = fhirBundles.map((bundle) => JSON.stringify(bundle)).join("\n");
return {
patientID: personID,
content: bundles,
};
}
class ConvertApi {
constructor(httpHandler) {
this.httpHandler = httpHandler;
}
/**
* 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) {
const headers = {
"Content-Type": "text/plain",
};
const parameters = new URLSearchParams();
if (request.patientID) {
parameters.append("patientId", request.patientID);
}
if (request.patientIdentifier) {
parameters.append("patientIdentifier", request.patientIdentifier);
}
if (request.patientIdentifierSystem) {
parameters.append("patientIdentifierSystem", request.patientIdentifierSystem);
}
if (request.tz) {
parameters.append("tz", request.tz);
}
if (request.processingHint) {
parameters.append("processingHint", request.processingHint);
}
let route = "/convert/v1/hl7tofhirr4";
if (parameters.size) {
route += `?${parameters.toString()}`;
}
return this.httpHandler.post(route, request.content, headers);
}
/**
* 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) {
const headers = {
"Content-Type": "application/xml",
};
const parameters = new URLSearchParams();
if (request.patientID) {
parameters.append("patientId", request.patientID);
}
if (request.patientIdentifier) {
parameters.append("patientIdentifier", request.patientIdentifier);
}
if (request.patientIdentifierSystem) {
parameters.append("patientIdentifierSystem", request.patientIdentifierSystem);
}
if (request.includeOriginalCda) {
parameters.append("includeOriginalCda", request.includeOriginalCda.toString());
}
if (request.includeStandardizedCda) {
parameters.append("includeStandardizedCda", request.includeStandardizedCda.toString());
}
let route = "/convert/v1/cdatofhirr4";
if (parameters.size) {
route += `?${parameters.toString()}`;
}
return this.httpHandler.post(route, request.content, headers);
}
/**
* 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) {
const headers = {
"Content-Type": "application/xml",
Accept: "application/pdf",
};
return this.httpHandler.post("/convert/v1/cdatopdf", request.content, headers);
}
/**
* 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) {
const headers = {
Accept: "application/xml",
};
return this.httpHandler.post("/convert/v1/fhirr4tocda", request.content, headers);
}
/**
* 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) {
const headers = {
Accept: "application/zip",
};
return this.httpHandler.post("/convert/v1/fhirr4toomop", request.content, headers);
}
/**
* 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) {
const headers = {
"Content-Type": "application/x-ndjson",
};
const parameters = new URLSearchParams();
if (request.patientID) {
parameters.append("patientId", request.patientID);
}
if (request.patientIdentifier) {
parameters.append("patientIdentifier", request.patientIdentifier);
}
if (request.patientIdentifierSystem) {
parameters.append("patientIdentifierSystem", request.patientIdentifierSystem);
}
let route = "/convert/v1/combinefhirr4bundles";
if (parameters.size) {
route += `?${parameters.toString()}`;
}
return this.httpHandler.post(route, request.content, headers);
}
/**
* 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) {
const headers = {
"Content-Type": "text/plain",
};
const parameters = new URLSearchParams();
if (request.patientID) {
parameters.append("patientId", request.patientID);
}
if (request.patientIdentifier) {
parameters.append("patientIdentifier", request.patientIdentifier);
}
if (request.patientIdentifierSystem) {
parameters.append("patientIdentifierSystem", request.patientIdentifierSystem);
}
let route = "/convert/v1/x12tofhirr4";
if (parameters.size) {
route += `?${parameters.toString()}`;
}
return this.httpHandler.post(route, request.content, headers);
}
/**
* 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) {
return this.httpHandler.post("/convert/v1/fhirdstu2tofhirr4", request.content);
}
/**
* 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) {
return this.httpHandler.post("/convert/v1/fhirstu3tofhirr4", request.content);
}
/**
* 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) {
return this.httpHandler.post("/convert/v1/fhirr4tohealthlake", request.content);
}
/**
* 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) {
const headers = {
"Content-Type": "application/xml",
"Accept": "text/html",
};
return this.httpHandler.post("/convert/v1/cdatohtml", request.content, headers);
}
/**
* 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) {
const headers = {
"Accept": "application/xml",
};
return this.httpHandler.post("/convert/v1/fhirr4tonemsisv34", request.content, headers);
}
/**
* 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) {
const headers = {
"Accept": "application/xml",
};
return this.httpHandler.post("/convert/v1/fhirr4tonemsisv35", request.content, headers);
}
/**
* 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) {
const headers = {
Accept: "application/zip"
};
const parameters = new URLSearchParams();
if (request.delimiter) {
parameters.append("delimiter", request.delimiter);
}
let route = "/convert/v1/fhirr4tomanifest";
if (parameters.size) {
route += `?${parameters.toString()}`;
}
return this.httpHandler.post(route, request.content, headers);
}
}
exports.ConvertApi = ConvertApi;