Conversation
contracts/gateway.yaml
Outdated
| '400': | ||
| description: > | ||
| **Causes:** | ||
| * Token is not provided |
There was a problem hiding this comment.
This should be Invalid Request Details instead of Token is not provided
| schema: | ||
| $ref: '#/components/schemas/PatientShareRequest' | ||
| responses: | ||
| '202': |
There was a problem hiding this comment.
Since the user waits for the whole process to be finished a 200 would be better than 202. If we were making this call async where user gets a notification later a 202 would have been appropriate.
| example: "Jane Doe" | ||
| gender: | ||
| $ref: '#/components/schemas/PatientGender' | ||
| address: |
There was a problem hiding this comment.
Check the /on-confirm API .. we already use an "address" attribute.
something like:
address: {
"line": "abc",
"state": "",
"district": "",
"pincode": ""
}
contracts/gateway.yaml
Outdated
| example: 2000 | ||
| dateOfBirth: | ||
| type: string | ||
| example: "1972-02-29" |
There was a problem hiding this comment.
do you mean DOB or day-of-birth?
contracts/gateway.yaml
Outdated
| description: date of birth in YYYY-MM-DD format. | ||
| monthOfBirth: | ||
| type: string | ||
| example: "1972-02-29" |
There was a problem hiding this comment.
why is month-of-birth a date type? Why not a simple integer?
contracts/gateway.yaml
Outdated
| xml: | ||
| name: verifiedIdentifiers | ||
| wrapped: true | ||
| unverifiedIdentifiers: |
There was a problem hiding this comment.
Why do we need to pass verifiedIdentifiers?
contracts/gateway.yaml
Outdated
| type: string | ||
| example: "1972-02-29" | ||
| description: date of birth in YYYY-MM-DD format. | ||
| verifiedIdentifiers: |
There was a problem hiding this comment.
why can't we just say "identifiers"
| type: string | ||
| enum: | ||
| - SUCCESS | ||
| healthId: |
There was a problem hiding this comment.
Why do we need to pass this? Just acknowledgement status should be fine.
There was a problem hiding this comment.
healthId is just to verify for which user we are sharing details.
| - hip facing | ||
| parameters: | ||
| - $ref: "#/components/parameters/authorization" | ||
| - $ref: "#/components/parameters/X-HIP-ID" |
There was a problem hiding this comment.
Isn't the profile sharable even with HIU? in that case, the header can be a X-HIP-ID or X-HIU-ID
There was a problem hiding this comment.
Done, it can be shared with HIU as well
contracts/gateway.yaml
Outdated
| example: 5f7a535d-a3fd-416b-b069-c97d021fbacd | ||
| timestamp: | ||
| $ref: '#/components/schemas/TimestampSchema' | ||
| hipDetails: |
There was a problem hiding this comment.
few things
- In all our APIs, we usually have a single root object as payload. Lets try to keep it so.
- Why do we need to pass the HIP ID? note, this share can be done even with HIU - right?
There was a problem hiding this comment.
Removed HipDetails part.
Revert "Merge pull request #36 from ProjectEKA/JAS-863"
JAS-863 | Defining contract for share call on QR Scan
5 participants
NOTE: Changes are made on gateway once approved. CM and HIP will be modified accordingly