clinic sites

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'
       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'
+      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'
+      description: 'Create a Site'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Site'
+      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'
+      description: 'Update a Site'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: './clinic/models/site.v1.yaml'
+      tags:
+        - Clinics
+    delete:
+      summary: 'Delete a Site'
+      operationId: 'DeleteSite'
+      responses:
+        '200':
+          description: 'List of clinic sites'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ClinicSites'
+      description: 'Delete a Site'
+      tags:
+        - Clinics
   '/v1/clinics/{clinicId}/clinicians/{clinicianId}':
     parameters:
       - $ref: '#/components/parameters/clinicId'
@@ -2139,6 +2218,14 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/PatientTag'
+    ClinicSites:
+      type: array
+      items:
+        $ref: '#/components/schemas/ClinicSite'
+    ClinicSite:
+      $ref: ./clinic/models/clinicsite.v1.yaml
+    Site:
+      $ref: ./clinic/models/site.v1.yaml
     DateTime:
       $ref: ./common/models/datetime.v1.yaml
     DataSource:
@@ -2210,6 +2297,8 @@ components:
           minLength: 1
         tags:
           $ref: '#/components/schemas/PatientTagIds'
+        siteIds:
+          $ref: '#/components/schemas/SiteIds'
     AssociateClinicianToUser:
       title: Associate Clinician
       type: object
@@ -2313,6 +2402,8 @@ components:
           type: boolean
     PatientTagIds:
       $ref: ./clinic/models/patienttagids.v1.yaml
+    SiteIds:
+      $ref: ./clinic/models/siteids.v1.yaml
     TideConfig:
       $ref: ./clinic/models/tide/config.v1.yaml
     TideFilters:
@@ -2596,6 +2687,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,24 @@
+type: 'object'
+title: 'Site'
+description: 'A clinic''s phyical 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}$'
+    readOnly: true
+
+  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'