clinic sites

Update: re-based on top of the redocly changes.

BACK-3634

Author: ewollesen

reference/clinic.v1.yaml

@@ -872,6 +872,16 @@ paths:
           description: Comma-separated list of patient tag IDs
           style: form
           explode: false
+        - name: sites
+          schema:
+            type: array
+            items:
+              type: string
+              format: '^[a-f0-9]{24}$'
+          in: query
+          description: Comma-separated list of clinic site IDs
+          style: form
+          explode: false
       description: Retrieve a list of patients of a clinic
     post:
       summary: Create Patient Account
@@ -908,6 +918,75 @@ paths:
               $ref: '#/components/schemas/patientTag.v1'
       tags:
         - Clinics
+  '/v1/clinics/{clinicId}/sites':
+    parameters:
+      - $ref: '#/components/parameters/clinicId'
+    get:
+      summary: List Sites
+      operationId: ListSites
+      responses:
+        '200':
+          description: List of clinic sites
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clinicSites.v1'
+      description: List sites
+      tags:
+        - Clinics
+    post:
+      summary: Create a Site
+      operationId: CreateSite
+      responses:
+        '200':
+          description: List of clinic sites
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clinicSites.v1'
+      description: Create a Site
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/site.v1'
+      tags:
+        - Clinics
+  '/v1/clinics/{clinicId}/sites/{siteId}':
+    parameters:
+      - $ref: '#/components/parameters/clinicId'
+      - $ref: '#/components/parameters/siteId'
+    put:
+      summary: Update a Site
+      operationId: UpdateSite
+      responses:
+        '200':
+          description: List of clinic sites
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clinicSites.v1'
+      description: Update a Site
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/site.v1'
+      tags:
+        - Clinics
+    delete:
+      summary: Delete a Site
+      operationId: DeleteSite
+      responses:
+        '200':
+          description: List of clinic sites
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clinicSites.v1'
+      description: 'Delete a Site'
+      tags:
+        - Clinics
   '/v1/clinics/{clinicId}/clinicians/{clinicianId}':
     parameters:
       - $ref: '#/components/parameters/clinicId'
@@ -2131,6 +2210,12 @@ components:
       type: array
       items:
         $ref: ./clinic/models/dataSource.v1.yaml
+    clinicSites.v1:
+      type: array
+      items:
+        $ref: ./clinic/models/clinicSite.v1.yaml
+    site.v1:
+      $ref: ./clinic/models/site.v1.yaml
     tidepoolUserIds.v1:
       type: array
       nullable: true
@@ -2182,6 +2267,8 @@ components:
           minLength: 1
         tags:
           $ref: ./clinic/models/patientTagIds.v1.yaml
+        siteIds:
+          $ref: ./clinic/models/siteIds.v1.yaml
     associateClinicianToUser.v1:
       title: Associate Clinician
       type: object
@@ -2494,6 +2581,13 @@ components:
       schema:
         type: string
         pattern: '^[a-f0-9]{24}$'
+    siteId:
+      name: siteId
+      in: path
+      required: true
+      schema:
+        type: string
+        pattern: '^[a-f0-9]{24}$'
     userId:
       name: userId
       in: path

reference/clinic/models/clinic.v1.yaml

@@ -18,6 +18,10 @@ properties:
     type: array
     items:
       $ref: ./patientTag.v1.yaml
+  sites:
+    type: array
+    items:
+      $ref: ./clinicSite.v1.yaml
   lastDeletedPatientTag:
     $ref: ./patientTag.v1.yaml
   phoneNumbers:

reference/clinic/models/clinicSite.v1.yaml

@@ -0,0 +1,3 @@
+allOf:
+  - $ref: ./site.v1.yaml
+  - $ref: ./sitePatients.v1.yaml

reference/clinic/models/patient.v1.yaml

@@ -61,6 +61,12 @@ properties:
       id: 502rliv0l2tyy
     description: Requests for each provider are listed in reverse chronological order
     readOnly: true
+  sites:
+    type: array
+    nullable: true
+    x-go-type-skip-optional-pointer: true
+    items:
+      $ref: ./site.v1.yaml
 required:
   - id
   - fullName

reference/clinic/models/site.v1.yaml

@@ -0,0 +1,22 @@
+type: object
+title: Site
+description: "A clinic's physical or logical location."
+properties:
+  id:
+    title: Object Id
+    type: string
+    x-go-type-skip-optional-pointer: true
+    description: String representation of a resource id
+    minLength: 24
+    maxLength: 24
+    pattern: '^[a-f0-9]{24}$'
+  name:
+    type: string
+    x-go-type-skip-optional-pointer: true
+    description: The site description.
+    minLength: 1
+    maxLength: 200
+    pattern: '^[[:graph:]\p{L}\p{N}][[:graph:]\p{L}\p{N} ]*$'
+required:
+  - id
+  - name

reference/clinic/models/siteId.v1.yaml

@@ -0,0 +1,9 @@
+title: Site ID
+description: >-
+  Site identifier.
+type: string
+minLength: 24
+maxLength: 24
+pattern: '^[a-f0-9]{24}$'
+readOnly: true
+example: 2fe2488217ee43e1b2e83c2f

reference/clinic/models/siteIds.v1.yaml

@@ -0,0 +1,13 @@
+type: array
+title: Site ID List
+uniqueItems: true
+nullable: true
+items:
+  title: Site ID
+  description: >-
+    Site identifier.
+  type: string
+  minLength: 24
+  maxLength: 24
+  pattern: '^[a-f0-9]{24}$'
+  readOnly: true

reference/clinic/models/sitePatients.v1.yaml

@@ -0,0 +1,13 @@
+# sitepatients extends site with the clinic-specific patient count
+type: object
+title: Site Patients
+description: Site properties specific to a clinic.
+properties:
+  patients:
+    type: integer
+    x-go-type-skip-optional-pointer: true
+    description: The number of patients associated with the site.
+    readOnly: true
+    minimum: 0
+required:
+  - patients

reference/clinic/parameters/siteId.v1.yaml

@@ -0,0 +1,7 @@
+description: >-
+  Site ID
+name: siteId
+in: path
+required: true
+schema:
+  $ref: '../models/siteid.v1.yaml'