Merge remote-tracking branch 'spdci/draft' into draft incl encrypted msg jwe spec from dci.

Author: vvujjini

LICENSE.md

@@ -29,12 +29,12 @@ do
 
 ## Building Open API consolidated yaml file
 1. Make sure all the yaml file have relative path references are resolved and core_xxx_api_vx.x.x.yaml files have reference to all the required files.
-1. Install the swagger command line tool using npm (Note: you may need to use root privileges if installing it globally).
+2. Install the swagger command line tool using npm (Note: you may need to use root privileges if installing it globally).
 
 ```
 sudo npm install -g swagger-cli
 ```
-2. Generate the resolved OpenAPI definition file <br>
+3. Generate the resolved OpenAPI definition file <br>
     a. Go to the root directory of this repository i.e standards/ <br>
     b. Run the build_apis.cmd from standards/ folder  <br>
     b. Alternatively, Run the following command for each index file in ./standards/ folder. for e.g., <br>
@@ -48,16 +48,21 @@ If the command runs successfully, you should see an output like this for each ap
 ```
 Created registry_core_api_v1.0.0.html from release/yaml/registry_core_api_v1.0.0.yaml
 ```
+4. Install the redocly command line tool using npm (Note: you may need to use root privileges if installing it globally).
 
-3. To create redoc html pages for easy readability 
+```
+sudo npm install -g @redocly/cli
+```
+
+5. To create redoc html pages for easy readability 
 
 ```
-redoc build-docs ./src/registry_core_api_v1.0.0.yaml -o ./release/html/registry_core_api_v1.0.0.html
+redocly build-docs ./release/yaml/registry_core_api_v1.0.0.yaml -o ./release/html/registry_core_api_v1.0.0.html
 ```
 
 If the command runs successfully, you should see an output like this for each api index file
 ```
 bundled successfully in: ./release/html/registry_core_api_v1.0.0.html
 ```
 
-5. Commit the changes and push the updated code to git repo. Create pull requests for teams to collaborate and merge to main branch!
+6. Commit the changes and push the updated code to git repo. Create pull requests for teams to collaborate and merge to main branch!

build/build_instructions.md

@@ -990,23 +990,23 @@ components:
             - alg
             - enc
             - kid
-        data:
+        ciphertext:
           type: string
           description: This is the result of encrypting the plaintext using the CEK and the IV. It's Base64Url-encoded.
         encrypted_key:
           type: string
           description: The base64-url encoded encrypted key
-        auth_tag:
+        tag:
           type: string
           description: 'This is a Base64Url-encoded value that provides evidence of the integrity and authenticity of the ciphertext, Initialization Vector, and Additional Authenticated Data'
         iv:
           type: string
           description: This is a Base64Url-encoded random bit string to be used as the Initialization Vector (IV) when encrypting the plaintext to produce the ciphertext. The size of the IV depends on the encryption algorithm used.
       required:
         - header
-        - data
+        - ciphertext
         - encrypted_key
-        - auth_tag
+        - tag
         - iv
     Error:
       description: |

release/html/disburse_core_api_v1.0.0.html

@@ -1734,23 +1734,23 @@ components:
             - alg
             - enc
             - kid
-        data:
+        ciphertext:
           type: string
           description: This is the result of encrypting the plaintext using the CEK and the IV. It's Base64Url-encoded.
         encrypted_key:
           type: string
           description: The base64-url encoded encrypted key
-        auth_tag:
+        tag:
           type: string
           description: 'This is a Base64Url-encoded value that provides evidence of the integrity and authenticity of the ciphertext, Initialization Vector, and Additional Authenticated Data'
         iv:
           type: string
           description: This is a Base64Url-encoded random bit string to be used as the Initialization Vector (IV) when encrypting the plaintext to produce the ciphertext. The size of the IV depends on the encryption algorithm used.
       required:
         - header
-        - data
+        - ciphertext
         - encrypted_key
-        - auth_tag
+        - tag
         - iv
     Error:
       description: |

release/html/mapper_core_api_v1.0.0.html

@@ -924,16 +924,16 @@ components:
       type: string
       description: |
         Standardized codes/values representing diverse Sex categories.
-        Reference: [ISO/IEC 5218:2022](https://www.iso.org/standard/81682.html)
+        Reference: [FHIR Administrative Gender](https://build.fhir.org/valueset-administrative-gender.html)
         1 : Male
         2 : Female
         3 : Others
         4 : Unknown
       enum:
-        - '1'
-        - '2'
-        - '3'
-        - '4'
+        - male
+        - female
+        - other
+        - unknown
     dci_VitalEvents:
       type: string
       description: |
@@ -946,12 +946,12 @@ components:
         5 : Divorce <br>
         6 : Adoption <br>
       enum:
-        - '1'
-        - '2'
-        - '3'
-        - '4'
-        - '5'
-        - '6'
+        - live_birth
+        - death
+        - fetal_death
+        - marriage
+        - divorce
+        - adoption
     GooglePlusCode:
       type: object
       description: 'Refer [Plus Codes](https://github.com/google/open-location-code/wiki/Plus-codes-API) for more details'
@@ -2134,23 +2134,23 @@ components:
             - alg
             - enc
             - kid
-        data:
+        ciphertext:
           type: string
           description: This is the result of encrypting the plaintext using the CEK and the IV. It's Base64Url-encoded.
         encrypted_key:
           type: string
           description: The base64-url encoded encrypted key
-        auth_tag:
+        tag:
           type: string
           description: 'This is a Base64Url-encoded value that provides evidence of the integrity and authenticity of the ciphertext, Initialization Vector, and Additional Authenticated Data'
         iv:
           type: string
           description: This is a Base64Url-encoded random bit string to be used as the Initialization Vector (IV) when encrypting the plaintext to produce the ciphertext. The size of the IV depends on the encryption algorithm used.
       required:
         - header
-        - data
+        - ciphertext
         - encrypted_key
-        - auth_tag
+        - tag
         - iv
     Error:
       description: |

release/html/registry_core_api_v1.0.0.html

@@ -12,26 +12,26 @@ properties:
         description: The encryption algorithm used for encrypting the plaintext
       kid:
         type: string
-        description: The key identifier for the encryption key       
+        description: The key identifier for the encryption key
     required:
-      - alg     
+      - alg
       - enc
       - kid
-  data:
+  ciphertext:
     type: string
     description: This is the result of encrypting the plaintext using the CEK and the IV. It's Base64Url-encoded.
   encrypted_key:
     type: string
     description: The base64-url encoded encrypted key
-  auth_tag:
+  tag:
     type: string
     description: This is a Base64Url-encoded value that provides evidence of the integrity and authenticity of the ciphertext, Initialization Vector, and Additional Authenticated Data
   iv:
     type: string
     description:  This is a Base64Url-encoded random bit string to be used as the Initialization Vector (IV) when encrypting the plaintext to produce the ciphertext. The size of the IV depends on the encryption algorithm used.
 required:
   - header
-  - data
+  - ciphertext
   - encrypted_key
-  - auth_tag
-  - iv
+  - tag
+  - iv

release/yaml/disburse_core_api_v1.0.0.yaml

@@ -1,13 +1,13 @@
 type: string
 description: |
   Standardized codes/values representing diverse Sex categories.
-  Reference: [ISO/IEC 5218:2022](https://www.iso.org/standard/81682.html)
+  Reference: [FHIR Administrative Gender](https://build.fhir.org/valueset-administrative-gender.html)
   1 : Male
   2 : Female
   3 : Others
   4 : Unknown
 enum:
-  - "1"
-  - "2"
-  - "3"
-  - "4"
+  - "male"
+  - "female"
+  - "other"
+  - "unknown"

release/yaml/mapper_core_api_v1.0.0.yaml

@@ -9,9 +9,9 @@ description: |
   5 : Divorce <br>
   6 : Adoption <br>
 enum:
-  - "1"
-  - "2"
-  - "3"
-  - "4"
-  - "5"
-  - "6"
+  - "live_birth"
+  - "death"
+  - "fetal_death"
+  - "marriage"
+  - "divorce"
+  - "adoption"