deprecated `patid`, replaced with `patPubId`:

It's the ID used in the GPIS and it could be textual. patid needs to go away at some point.

paths/patient_base.yaml

@@ -63,6 +63,8 @@ get:
                 $ref: '../schemas/PatIdentity.yaml#/insurance'
               patid:
                 $ref: '../schemas/PatIdentity.yaml#/patid'
+              patPubId:
+                $ref: '../schemas/PatIdentity.yaml#/patPubId'
               patUnid:
                 $ref: '../schemas/PatIdentity.yaml#/patUnid'
               startDate:

paths/patient_dossier.yaml

@@ -112,6 +112,14 @@ get:
                 description: |-
                   Contains core identification information about this patient; a duplication of the `/patient/base` API.
                 type: object
+                required:
+                  - bsn
+                  - name
+                  - gender
+                  - patid
+                  - patUnid
+                  - category
+                  - startDate
                 properties:
                   bsn:
                     $ref: '../schemas/PatIdentity.yaml#/bsn'
@@ -133,6 +141,8 @@ get:
                     $ref: '../schemas/PatIdentity.yaml#/insurance'
                   patid:
                     $ref: '../schemas/PatIdentity.yaml#/patid'
+                  patPubId:
+                    $ref: '../schemas/PatIdentity.yaml#/patPubId'
                   patUnid:
                     $ref: '../schemas/PatIdentity.yaml#/patUnid'
                   startDate:

paths/population_frequentUser_patients.yaml

@@ -95,6 +95,8 @@ get:
                   $ref: '../schemas/PatIdentity.yaml#/insurance'
                 patid:
                   $ref: '../schemas/PatIdentity.yaml#/patid'
+                patPubId:
+                  $ref: '../schemas/PatIdentity.yaml#/patPubId'
                 patUnid:
                   $ref: '../schemas/PatIdentity.yaml#/patUnid'
                 feats:

paths/population_statistics_deprived_{neighborhood}.yaml

@@ -62,6 +62,8 @@ get:
                   $ref: '../schemas/PatIdentity.yaml#/insurance'
                 patid:
                   $ref: '../schemas/PatIdentity.yaml#/patid'
+                patPubId:
+                  $ref: '../schemas/PatIdentity.yaml#/patPubId'
                 patUnid:
                   $ref: '../schemas/PatIdentity.yaml#/patUnid'
                 startDate:

paths/qoc_checkupList_{setKey}.yaml

@@ -115,8 +115,10 @@ get:
                 items:
                   type: object
                   properties:
-                    patid:
+                    patPubId:
-                      $ref: '../schemas/PatIdentity.yaml#/patid'
+                      $ref: '../schemas/PatIdentity.yaml#/patPubId'
+                    patUnid:
+                      $ref: '../schemas/PatIdentity.yaml#/patUnid'
                     doctor:
                       type: integer
                       format: int32
@@ -162,7 +164,7 @@ get:
                         * `+` – The measurement lasts for 9 or more quarters (for example, the measurement only needs to be done once ever and it has been done).
                         * `x` – unknown situation (should not occur).
                   required:
-                    - patid
+                    - patUnid
                     - doctor
                     - status
                     - dob

schemas/PatIdentity.yaml

@@ -110,6 +110,8 @@ insurance:
       $ref: 'insurer-Uzovi.yaml'
 patid:
   $ref: 'pat-patId.yaml'
+patPubId:
+  $ref: 'pat-patPubId.yaml'
 patUnid:
   $ref: 'pat-patUnid.yaml'
 startDate:

schemas/fundus-status.yaml

@@ -49,6 +49,8 @@ properties:
           $ref: 'PatIdentity.yaml#/insurance'
         patid:
           $ref: 'PatIdentity.yaml#/patid'
+        patPubId:
+          $ref: 'PatIdentity.yaml#/patPubId'
         patUnid:
           $ref: 'PatIdentity.yaml#/patUnid'
         startDate:

schemas/pat-patId.yaml

@@ -1,4 +1,8 @@
 description: |-
+  _DEPRECATED_ this value will be removed in some future version and you should no longer
+  rely on it. Some GPIS use non-numeric public IDs. Use value `patPubId` instead which is like
+  this one, except a string instead of a number.
+  
   Patient's "public" ID, as used and shown on the GPIS patient page. Not necessarily unique,
   and not necessarily present; 0 indicates no patid is known or this GPIS does not use (numeric)
   public IDs.

schemas/pat-patPubId.yaml

@@ -0,0 +1,11 @@
+description: |-
+  Patient's "public" ID, as used and shown on the GPIS patient page. Not necessarily unique,
+  and not necessarily present; 0 indicates no patid is known or this GPIS does not use public IDs.
+  
+  The primary purpose of this field is to show it to medical professionals working at this practice
+  who can use it to search for this dossier and is a way to communicate without sharing privacy-sensitive
+  details.
+  
+  If this isn't present, the value in `patUnid` is the public ID (i.e. there is no difference).
+type: string
+example: P000123