The recommended REST API endpoints to be used when integrating with PatientView
This is a community listing. If you own this API, you can request ownership.
npm install omnistream-sdkimport { OmniClient } from "omnistream-sdk";
const omni = new OmniClient({ token: process.env.OMNI_KEY! });
// One key reaches every API on the marketplace.
const data = await omni.call("patientview/logIn");One install, one key - the same client calls every API on the marketplace.
Log In
Log Out
Get Basic User Information
Get Basic Patient Information
getPatientManagementDiagnoses
getPatientManagementLookupTypes
validatePatientManagement
/**
* PatientView - generated by OmniStream from PatientView's OpenAPI spec.
* One typed method per endpoint. A single Omni key reaches the API.
*/
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/patientview";
export class PatientViewError extends Error {
status: number;
code?: string;
constructor(status: number, code: string | undefined, message?: string) {
super(message || `PatientView error ${status}`);
this.name = "PatientViewError";
this.status = status;
this.code = code;
}
}
export interface PatientViewOptions {
baseUrl?: string;
fetch?: typeof fetch;
timeoutMs?: number;
}
export class PatientView {
/** @param token Your OmniStream key (one key for every API). */
constructor(private token: string, private opts: PatientViewOptions = {}) {
if (!token) throw new Error("PatientView: token is required");
}
rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;
private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
const f = this.opts.fetch ?? globalThis.fetch;
const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
const headers: Record<string, string> = { "x-omni-key": this.token };
if (body !== undefined) headers["content-type"] = "application/json";
const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
this.rateLimit = {
remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
};
const data = await res.json().catch(() => ({}));
if (!res.ok) throw new PatientViewError(res.status, data?.error?.code, data?.error?.message);
return data.data ?? data;
}
/** Log In */
logIn(body: unknown): Promise<any> {
return this._request("POST", "/auth/login", { body });
}
/** Log Out */
logOut(params: { "token": string }): Promise<any> {
return this._request("DELETE", "/auth/logout/{token}", { params });
}
/** Get Basic User Information */
getBasicUserInformation(params: { "token": string }): Promise<any> {
return this._request("GET", "/auth/{token}/basicuserinformation", { params });
}
/** Get Basic Patient Information */
getBasicPatientDetails(params: { "userId": number }): Promise<any> {
return this._request("GET", "/patient/{userId}/basic", { params });
}
/** getPatientManagementDiagnoses */
getPatientManagementDiagnoses(): Promise<any> {
return this._request("GET", "/patientmanagement/diagnoses", {});
}
/** getPatientManagementLookupTypes */
getPatientManagementLookupTypes(): Promise<any> {
return this._request("GET", "/patientmanagement/lookuptypes", {});
}
/** validatePatientManagement */
validatePatientManagement(): Promise<any> {
return this._request("POST", "/patientmanagement/validate", { });
}
/** getPatientManagement */
getPatientManagement(params: { "userId": number; "groupId": number; "identifierId": number }): Promise<any> {
return this._request("GET", "/patientmanagement/{userId}/group/{groupId}/identifier/{identifierId}", { params });
}
/** savePatientManagement */
savePatientManagement(body: unknown, params: { "userId": number; "groupId": number; "identifierId": number }): Promise<any> {
return this._request("POST", "/patientmanagement/{userId}/group/{groupId}/identifier/{identifierId}", { body, params });
}
/** savePatientManagementSurgeries */
savePatientManagementSurgeries(body: unknown, params: { "userId": number; "groupId": number; "identifierId": number }): Promise<any> {
return this._request("POST", "/patientmanagement/{userId}/group/{groupId}/identifier/{identifierId}/surgeries", { body, params });
}
/** Get Available Observations Types For a User */
getAvailableObservationHeadings(params: { "userId": number }): Promise<any> {
return this._request("GET", "/user/{userId}/availableobservationheadings", { params });
}
/** Get Observations of Multiple Types For a User */
getObservationsByCodes(params: { "userId": number; "code": unknown[]; "limit": number; "offset": number; "orderDirection": string }): Promise<any> {
return this._request("GET", "/user/{userId}/observations", { params });
}
/** Get Observations of a Certain Type For a User */
getObservationsByCode(params: { "userId": number; "code": string }): Promise<any> {
return this._request("GET", "/user/{userId}/observations/{code}", { params });
}
/** Get patient entered Observations of a Certain Type For a User */
getPatientEnteredObservationsByCode(params: { "userId": number; "code": string }): Promise<any> {
return this._request("GET", "/user/{userId}/observations/{code}/patiententered", { params });
}
/** Get Available Patient Entered Observations Types For a User */
getPatientEnteredObservationHeadings(params: { "userId": number }): Promise<any> {
return this._request("GET", "/user/{userId}/patiententeredobservationheadings", { params });
}
}
export default PatientView;
No reviews yet. Be the first to rate this API.
No. PatientView is included with your Omni key, so a single OmniStream key is enough to start calling it. There is no separate signup with the provider and no second key to manage.
The recommended REST API endpoints to be used when integrating with PatientView It exposes 15 endpoints over POST, DELETE, GET, including POST /auth/login, DELETE /auth/logout/{token}, GET /auth/{token}/basicuserinformation.
Install the OmniStream SDK for your language and call PatientView through it. The client is generated from this API's OpenAPI spec, so parameters and responses are fully typed, and the same client also calls every other API in the marketplace.
You can start on the free plan. OmniStream charges for the unified SDK, key storage and proxy rather than for PatientView itself.
TVmaze: A free, keyless TV database - search shows, episodes, cast, and schedules. No sign-up required.
getPatientManagement
savePatientManagement
savePatientManagementSurgeries
Get Available Observations Types For a User
Get Observations of Multiple Types For a User
Get Observations of a Certain Type For a User
Get patient entered Observations of a Certain Type For a User
Get Available Patient Entered Observations Types For a User