From fb401635b0ca8658c7b5d12d4d0ddc7e66609ca7 Mon Sep 17 00:00:00 2001 From: Samantha Date: Tue, 2 Apr 2024 15:13:51 -0400 Subject: [PATCH] [ALS-6175] Add 'what is the PIC-SURE API page' (#21) --- src/lib/configuration.ts | 2 +- src/routes/api/+page.svelte | 6 +- src/routes/api/help/+page.svelte | 147 ++++++++++++++++++++++++++++++ src/routes/api/start/+page.svelte | 13 +++ 4 files changed, 166 insertions(+), 2 deletions(-) create mode 100644 src/routes/api/help/+page.svelte create mode 100644 src/routes/api/start/+page.svelte diff --git a/src/lib/configuration.ts b/src/lib/configuration.ts index 1a445e23..77ebfcf0 100644 --- a/src/lib/configuration.ts +++ b/src/lib/configuration.ts @@ -5,7 +5,7 @@ export const branding = { { header: 'What is the PIC‑SURE API?', body: 'The PIC-SURE Application Programming Interface allows you to search, query, and export data using Python or R. \n\nClick this card to read more about the PIC-SURE API.', - link: 'https://pic-sure.org/about', + link: '/api/help', }, { header: 'PIC‑SURE API Examples', diff --git a/src/routes/api/+page.svelte b/src/routes/api/+page.svelte index 08b2fb68..feddece2 100644 --- a/src/routes/api/+page.svelte +++ b/src/routes/api/+page.svelte @@ -9,7 +9,11 @@
{#each branding.apiPage.cards as card} - +

{card.header}

diff --git a/src/routes/api/help/+page.svelte b/src/routes/api/help/+page.svelte new file mode 100644 index 00000000..9666a2e6 --- /dev/null +++ b/src/routes/api/help/+page.svelte @@ -0,0 +1,147 @@ + + + +
+ + Back + +

PIC-SURE Application Programming Interface (API)

+
+ +
+

What is the PICSURE API?

+

+ The Patient-Centered Information Commons: Standardized Unification of Research Elements + (PIC-SURE) Application Programming Interface (API) is a powerful tool designed to simplify + access to a diverse range of databases in the healthcare and research domains. These databases + often have varying architectures and data organizations, presenting challenges for researchers + looking to extract and interpret medical insights +

+

+ Despite the inherent diversity among these databases, the PIC-SURE API facilitates a seamless + interaction with a wide range of data, providing researchers with a unified interface for + database access. This approach significantly simplifies the data access process, empowering + researchers to concentrate their efforts on research analysis and deriving valuable medical + insights. +

+
+ +
Placeholder image
+ +
+
+

Key Features

+
+
Search and Query:
+
+ Easily search and query the data using intuitive commands and syntax, allowing you to + filter datasets based on specific criteria and keywords. +
+
Participant-Level Data:
+
+ Access and export participant-level data, enabling you to conduct detailed analysis and + exploration of individual participant data. +
+
Python and R:
+
+ The API is available in Python and R, enabling researchers to query databases using their + preferred coding language. +
+
Open Source:
+
+ The PIC-SURE API is open source with an Apache 2.0 license, providing transparency, + flexibility, and community-driven development. +
+
+
+
+

More Information

+ +
+
+ +
+ + Get started using the PIC-Sure API + +
+ + + diff --git a/src/routes/api/start/+page.svelte b/src/routes/api/start/+page.svelte new file mode 100644 index 00000000..3e52e48e --- /dev/null +++ b/src/routes/api/start/+page.svelte @@ -0,0 +1,13 @@ + + + +
+ + Back + +

Get Started

+
+