Fb orscf

.env.sample

@@ -8,13 +8,25 @@ database-user='compass_user'
 # a secret used for JWT generation
 JWT_SECRET='mein_schatz'
 
+# ORSCF api endpoint configuration
+JWT_ALLOWED_HOSTS='localhost'
+JWT_ALLOWED_ISSUERS='TrustedIssuer1;TrustedIssuer2'
+
+# independend from the 'JWT_SECRET' above, this ist used to VERIFY the JWTs accessing the ORSCF api (one key per allowed issuer)
+ORSCF_JWT_PUBLIC_KEY_OR_SECRET_TrustedIssuer1 = '...the..signkey..which..was..used..by..TrustedIssuer1...'
+ORSCF_JWT_PUBLIC_KEY_OR_SECRET_TrustedIssuer2 = '...the..signkey..which..was..used..by..TrustedIssuer2...'
+
+# ORSCF study uid (needs to be inside the jwt's "scope" claim) as follows: Study:00000000-0000-000...
+STUDY_UID='00000000-0000-0000-0000-000000000000'
+
 # optional Push Service configuration
 GOOGLE_APPLICATION_CREDENTIALS='./google-services.json'
 
 # have node use a common time zone
 TZ = 'Europe/Amsterdam'
 
 # encryption keys
+
 COMPASS_PUBLIC_KEY='-----BEGIN PUBLIC KEY-----\nMII ... \n ... \n-----END PUBLIC KEY-----'
 COMPASS_PRIVATE_KEY='-----BEGIN PRIVATE KEY-----\nMII ... \n ... =\n-----END PRIVATE KEY-----'
 
@@ -27,3 +39,4 @@ COMPASS_RECIPIENT_CERTIFICATE='-----BEGIN CERTIFICATE-----\nMII .... \n ... \n--
 # if you don't use the ibm cloud (openshift) for deployment
 # Attention: self signed certificates won't work!
 # DB_SSL_CA='-----BEGIN CERTIFICATE-----\nMII .... \n ... \n-----END CERTIFICATE-----'
+

.gitignore

@@ -77,3 +77,9 @@ private*.pem
 public*.pem
 *cert*.pem
 google-services.json
+
+# vs
+/.vs/ProjectSettings.json
+/.vs/slnx.sqlite
+/.vs/*
+.vscode/*

README.adoc

@@ -121,3 +121,7 @@ The current configuration is suited for an OpenShift deployment. Find detailed i
 == Database Setup
 
 Dedicated documentation for the database setup can be found here link:./db[DB Setup].
+
+== Interoperability
+
+This backend provides API access that conforms to the https://orscf.org[ORSCF] standard's SDR and VDR endpoint definitions.

db/flyway.js

@@ -3,7 +3,7 @@ module.exports = function() {
     return {
         flywayArgs: {
             // JDBC string that addresses the database
-            url: 'jdbc:postgresql://localhost:15432/compass',
+            url: 'jdbc:postgresql://localhost:5432/compass',
             // the default schema of a Postgresql database
             schemas: 'public',
             // local location where the db migration scripts are stored

db/migration/V008__Sdr.sql

@@ -0,0 +1,13 @@
+-- Add column to store device token for Firebase push notifications
+ALTER TABLE
+    studyparticipant
+ADD
+    COLUMN subject_uid character varying NULL,
+ADD
+    COLUMN study_uid character varying NULL,
+ADD
+    COLUMN actual_site_uid character varying NULL,
+ADD
+    COLUMN enrolling_site_uid character varying NULL,
+ADD
+    COLUMN actual_site_defined_patient_identifier character varying NULL;

db/migration/V009__Vdr.sql

@@ -0,0 +1,44 @@
+CREATE TABLE visits
+(
+    id character varying(355) NOT NULL,
+
+    study_uid character varying(355) NOT NULL,
+    site_uid character varying(355) NOT NULL,
+    subject_identifier character varying(355) NOT NULL,
+    modification_timestamp_utc int NOT NULL,
+
+    visit_procedure_name character varying(355) NOT NULL,
+    visit_execution_title character varying(355) NOT NULL,
+    scheduled_date_utc timestamp without time zone NULL,
+    execution_date_utc timestamp without time zone NULL,
+    execution_state int NOT NULL,
+    execution_person character varying(355) NOT NULL,
+    CONSTRAINT visits_pkey PRIMARY KEY (id),
+    CONSTRAINT visits_id_key UNIQUE (id)
+);
+
+CREATE TABLE datarecordings
+(
+    id character varying(355) NOT NULL,
+
+    modification_timestamp_utc int NOT NULL,
+
+    data_recording_name character varying(355) NOT NULL,
+    task_execution_title character varying(355) NOT NULL,
+    scheduled_date_utc timestamp without time zone NULL,
+    execution_date_utc timestamp without time zone NULL,
+    execution_state int NOT NULL,
+    data_scheme_url character varying(355) NOT NULL,
+    notes_regarding_outcome character varying(355) NOT NULL,
+    execution_person character varying(355) NOT NULL,
+
+    visit_id character varying(355) NOT NULL,
+
+    recorded_data character varying(355) NOT NULL,
+    CONSTRAINT datarecordings_pkey PRIMARY KEY (id),
+    CONSTRAINT datarecordings_id_key UNIQUE (id),
+    CONSTRAINT fk_visit
+      FOREIGN KEY(visit_id)
+	  REFERENCES visits(id)
+
+)