Merge pull request #55 from tidepool-org/BACK-2290-dexcom-sharing

[BACK-2290] Dexcom patient connection

Author: clintonium-119

reference/clinic.v1.yaml

@@ -950,6 +950,26 @@ paths:
                   highGlucoseThreshold: 0
                   lowGlucoseThreshold: 0
         description: ''
+  '/v1/patients/{userId}/data_sources':
+    parameters:
+      - $ref: '#/components/parameters/userId'
+    put:
+      summary: Create or update a data source for a patient
+      operationId: UpdatePatientDataSources
+      responses:
+        '200':
+          description: OK
+        '404':
+          description: Not Found
+      description: Internal endpoint to upsert patient data source provider details in all their associated clinic records.
+      x-internal: true
+      tags:
+        - clinic
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DataSources'
   '/v1/clinics/{clinicId}/tier':
     parameters:
       - $ref: '#/components/parameters/clinicId'
@@ -981,6 +1001,23 @@ paths:
       description: Sends upload reminder to the patient
       tags:
         - clinic
+  '/v1/clinics/{clinicId}/patients/{patientId}/send_dexcom_connect_request':
+    parameters:
+      - $ref: '#/components/parameters/clinicId'
+      - $ref: '#/components/parameters/patientId'
+    post:
+      summary: Resend dexcom connect request email
+      operationId: SendDexcomConnectRequest
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Patient'
+      description: Resend dexcom connect request to the email address of the patient
+      tags:
+        - clinic
   '/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}':
     parameters:
       - $ref: '#/components/parameters/clinicId'
@@ -1023,6 +1060,14 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/PatientTag'
+    DateTime:
+      $ref: ./common/models/datetime.v1.yaml
+    DataSource:
+      $ref: ./clinic/models/datasource.v1.yaml
+    DataSources:
+      type: array
+      items:
+        $ref: '#/components/schemas/DataSource'
     InviteClinician:
       $ref: ./clinic/models/inviteclinician.v1.yaml
     TidepoolUserId:

reference/clinic/models/datasource.v1.yaml

@@ -0,0 +1,30 @@
+type: object
+title: Patient data source
+properties:
+  state:
+    type: string
+    title: Data source connection state
+    enum:
+      - pending
+      - pendingReconnect
+      - connected
+      - disconnected
+      - error
+    example: connected
+  providerName:
+    $ref: ../../auth/models/providers/name.v1.yaml
+  dataSourceId:
+    title: Data Source Object Id
+    type: string
+    description: String representation of a resource id
+    minLength: 24
+    maxLength: 24
+    pattern: '^[a-f0-9]{24}$'
+    readOnly: true
+  modifiedTime:
+    $ref: ../../common/models/datetime.v1.yaml
+  expirationTime:
+    $ref: ../../common/models/datetime.v1.yaml
+required:
+  - state
+  - providerName

reference/clinic/models/patient.v1.yaml

@@ -49,8 +49,17 @@ properties:
     readOnly: true
   attestationSubmitted:
     type: boolean
+  dataSources:
+    type: array
+    nullable: true
+    items:
+      $ref: ./datasource.v1.yaml
   summary:
     $ref: ./patientsummary.v1.yaml
+  lastRequestedDexcomConnectTime:
+    type: string
+    format: date-time
+    readOnly: true
   lastUploadReminderTime:
     type: string
     format: date-time

reference/confirm.v1.yaml

@@ -43,12 +43,14 @@ tags:
 paths:
   '/confirm/send/signup/{userId}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
+      - $ref: '#/components/parameters/userId'
     post:
       operationId: SendAccountSignupConfirmation
       summary: Send Account Signup Confirmation
       description: >-
         Sends account signup confirmation email.
+      requestBody:
+        $ref: '#/components/requestBodies/ConfirmationUpsert'
       responses:
         '200':
           $ref: '#/components/responses/ConfirmationSuccess'
@@ -67,7 +69,7 @@ paths:
 
   '/confirm/resend/signup/{email}':
     parameters:
-      - $ref: './confirm/parameters/email.v1.yaml'
+      - $ref: '#/components/parameters/email'
     post:
       operationId: ResendAccountSignup
       summary: Resend account signup confirmation email
@@ -87,7 +89,7 @@ paths:
 
   '/confirm/accept/signup/{key}':
     parameters:
-      - $ref: './confirm/parameters/key.v1.yaml'
+      - $ref: '#/components/parameters/key'
     put:
       operationId: ConfirmAccountSignup
       summary: Accept Account Signup
@@ -98,7 +100,7 @@ paths:
         content:
           'application/json':
             schema:
-              $ref: './confirm/models/acceptance.v1.yaml'
+              $ref: '#/components/schemas/Acceptance'
       responses:
         '200':
           $ref: '#/components/responses/ConfirmationSuccess'
@@ -113,7 +115,7 @@ paths:
 
   '/confirm/dismiss/signup/{userId}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
+      - $ref: '#/components/parameters/userId'
     put:
       operationId: DismissAccountSignup
       summary: Dismiss Account Signup
@@ -134,16 +136,15 @@ paths:
 
   '/confirm/signup/{userId}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
+      - $ref: '#/components/parameters/userId'
     get:
       operationId: GetAccountSignupConfirmation
       summary: Get Account Signup Confirmation
       description: >-
-        This endpoint is provided for completeness.
-        We don't expect to need it in the actual user flow.
+        Fetch latest account signup confirmation for the provided userId
       responses:
         '200':
-          $ref: '#/components/responses/ConfirmationList'
+          $ref: '#/components/responses/Confirmation'
         '400':
           $ref: '#/components/responses/ConfirmationError'
         '401':
@@ -156,6 +157,28 @@ paths:
         - Confirm
       security:
         - sessionToken: []
+    post:
+      operationId: UpsertAccountSignupConfirmation
+      summary: Upsert Account Signup Confirmation
+      description: >-
+        Add or refresh an account signup confirmation for the provided userId
+      requestBody:
+        $ref: '#/components/requestBodies/ConfirmationUpsert'
+      responses:
+        '200':
+          $ref: '#/components/responses/Confirmation'
+        '400':
+          $ref: '#/components/responses/ConfirmationError'
+        '403':
+          $ref: '#/components/responses/ConfirmationError'
+        '404':
+          $ref: '#/components/responses/ConfirmationError'
+        '500':
+          $ref: '#/components/responses/ConfirmationError'
+      tags:
+        - Confirm
+      security:
+        - sessionToken: []
 
     put:
       operationId: CancelAccountSignupConfirmation
@@ -180,7 +203,7 @@ paths:
 
   '/confirm/forgot/{email}':
     parameters:
-      - $ref: './confirm/parameters/email.v1.yaml'
+      - $ref: '#/components/parameters/email'
     post:
       operationId: SendPasswordReset
       summary: Send Password Reset Email
@@ -212,7 +235,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: './confirm/models/acceptpassword.v1.yaml'
+              $ref: '#/components/schemas/Password'
       responses:
         '200':
           $ref: '#/components/responses/ConfirmationError'
@@ -227,7 +250,7 @@ paths:
 
   '/confirm/send/invite/{userId}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
+      - $ref: '#/components/parameters/userId'
     post:
       operationId: SendCareTeamInvite
       summary: Send Invitation to Join Care Team
@@ -254,8 +277,8 @@ paths:
 
   '/confirm/accept/invite/{userId}/{invitedBy}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
-      - $ref: './confirm/parameters/invitedbyuser.v1.yaml'
+      - $ref: '#/components/parameters/userId'
+      - $ref: '#/components/parameters/invitedByUser'
     put:
       operationId: AcceptCareTeamInvite
       summary: Accept Invitation to Join Care Team
@@ -279,7 +302,7 @@ paths:
 
   '/confirm/invite/{userId}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
+      - $ref: '#/components/parameters/userId'
     get:
       operationId: GetSentInvitations
       summary: Get Pending Care Team Invitations
@@ -304,7 +327,7 @@ paths:
 
   '/confirm/invitations/{userId}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
+      - $ref: '#/components/parameters/userId'
     get:
       operationId: GetReceivedInvitations
       summary: Get Received Care Team Invitations
@@ -325,8 +348,8 @@ paths:
 
   '/confirm/dismiss/invite/{userId}/{invitedBy}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
-      - $ref: './confirm/parameters/invitedbyuser.v1.yaml'
+      - $ref: '#/components/parameters/userId'
+      - $ref: '#/components/parameters/invitedByUser'
     put:
       operationId: DismissInvite
       summary: Dismiss Care Team Invitation
@@ -352,8 +375,8 @@ paths:
 
   '/confirm/{userId}/invited/{invitedBy}':
     parameters:
-      - $ref: './common/parameters/tidepooluserid.yaml'
-      - $ref: './confirm/parameters/invitedbyemail.v1.yaml'
+      - $ref: '#/components/parameters/userId'
+      - $ref: '#/components/parameters/invitedByEmail'
     put:
       operationId: CancelInvite
       summary: Cancel Care Team Invitation
@@ -374,6 +397,50 @@ paths:
         - sessionToken: []
 
 components:
+  schemas:
+    Acceptance:
+      $ref: './confirm/models/acceptance.v1.yaml'
+
+    TidepoolUserId:
+      $ref: './common/models/tidepooluserid.yaml'
+
+    ClinicId:
+      $ref: './clinic/models/clinicid.v1.yaml'
+
+    EmailAddress:
+      $ref: ./common/models/emailaddress.v1.yaml
+
+    DateTime:
+      $ref: ./common/models/datetime.v1.yaml
+
+    Key:
+      $ref: ./confirm/models/key.v1.yaml
+
+    Password:
+      $ref: ./common/models/password.v1.yaml
+
+    Birthday:
+      $ref: './common/models/birthday.v1.yaml'
+
+    Confirmation:
+      $ref: ./confirm/models/confirmation.v1.yaml
+
+  parameters:
+    userId:
+      $ref: './common/parameters/tidepooluserid.yaml'
+
+    email:
+      $ref: './confirm/parameters/email.v1.yaml'
+
+    key:
+      $ref: './confirm/parameters/key.v1.yaml'
+
+    invitedByUser:
+      $ref: './confirm/parameters/invitedbyuser.v1.yaml'
+
+    invitedByEmail:
+      $ref: './confirm/parameters/invitedbyemail.v1.yaml'
+
   securitySchemes:
     sessionToken:
       $ref: './common/security/tidepoolsessiontoken.v1.yaml'
@@ -385,6 +452,12 @@ components:
           schema:
             $ref: './confirm/models/lookup.v1.yaml'
 
+    ConfirmationUpsert:
+      content:
+        'application/json':
+          schema:
+            $ref: './confirm/models/upsert.v1.yaml'
+
   responses:
     Confirmation:
       description: 'Single confirmation'

reference/confirm/models/upsert.v1.yaml

@@ -0,0 +1,7 @@
+title: Confirmation Lookup
+type: object
+properties:
+  clinicId:
+    $ref: '../../clinic/models/clinicid.v1.yaml'
+  invitedBy:
+    $ref: '../../common/models/tidepooluserid.yaml'