Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 118 additions & 4 deletions api-reference/user-app/abdm-connect/registration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1158,7 +1158,7 @@ paths:
description: OK
security:
- authApiKey: []
/abdm/uhi/v1/physical-consultation/booking/status:
/abdm/uhi/v1/physical-consultation/booking/order-status:
get:
description: Retrieve the current status of a physical consultation booking.
parameters:
Expand Down Expand Up @@ -3477,6 +3477,59 @@ paths:
description: OK
security:
- authApiKey: []
/abdm/v1/profile/share:
post:
description: Fetch the token from a hospital. <Note> Get the hip_id and counter_id
by reading the QR code of the Hospital/Clinic.</Note> <Note>Use the device
location for the location data</Note>
parameters:
- description: Eka User ID (OID)
in: header
name: X-Pt-Id
schema:
type: string
- description: Partner User ID
in: header
name: X-Partner-Pt-Id
schema:
type: string
- description: Partner HIP ID
in: header
name: X-Hip-Id
schema:
type: string
- description: OID is used to Identify the user.
in: query
name: oid
schema:
description: OID is used to Identify the user.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScanandshareRequest'
responses:
4XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GenericError'
description: ""
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GenericError'
description: ""
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/HipQRScanShareProfileResponseV2'
description: OK
security:
- authApiKey: []
/abdm/v1/provider/{hip_id}:
get:
description: Fetches the Providers based on the HIP ID.
Expand Down Expand Up @@ -4747,6 +4800,33 @@ components:
- "null"
- string
type: object
HipQRScanShareProfileResponseV2:
properties:
address:
description: Address associated with the HIP.
type: string
created_at:
format: date-time
type: string
footer:
type: string
hip_id:
description: Health Information Provider (HIP) identifier
type: string
hip_name:
description: Name of the Health Information Provider (HIP)
type: string
request_id:
description: Unique identifier for the request
type: string
show_token_screen:
type: boolean
token_expiry:
format: date-time
type: string
token_number:
type: string
type: object
InitRequest:
properties:
aadhaar_number:
Expand Down Expand Up @@ -4926,8 +5006,9 @@ components:
care_context_id:
type: string
data:
description: ABDM compliant FHIR bundle (optional, required if not opting
for webhook based implementation)
description: Base64 encoded ABDM compliant FHIR bundle (optional, required
if not opting for webhook based implementation)
type: string
display:
type: string
hi_type:
Expand Down Expand Up @@ -6043,10 +6124,15 @@ components:
ProfileResponse:
properties:
abha_address:
description: ABHA address associated with the user.
description: Primary/preferred abha address.
examples:
- shyam@abdm
type: string
abha_addresses:
description: List of abha addresses associated with aadhaar
items:
type: string
type: array
abha_number:
description: ABHA number assigned to the user.
examples:
Expand Down Expand Up @@ -6515,6 +6601,24 @@ components:
- hip_id
- counter_id
type: object
ScanandshareRequest:
properties:
counter_id:
description: Counter ID from QR Code
type: string
hip_id:
description: HIP ID from QR Code
type: string
location:
$ref: '#/components/schemas/HipLocation'
description: Location of the user
patient:
$ref: '#/components/schemas/ScanandsharePatient'
description: Patient details
required:
- counter_id
- hip_id
type: object
ScanandshareResponse:
properties:
expiry:
Expand Down Expand Up @@ -6664,6 +6768,11 @@ components:
type: object
VerifyResponse:
properties:
abha_profiles:
description: Abha profiles of the user.
items:
$ref: '#/components/schemas/VerifyAbhaProfile'
type: array
eka:
$ref: '#/components/schemas/RegistrationEkaIds'
description: Eka IDs, will be present if SkipState is abha_end
Expand Down Expand Up @@ -6697,6 +6806,11 @@ components:
type: object
VerifyResponseType2:
properties:
abha_profiles:
description: Abha profiles of the user.
items:
$ref: '#/components/schemas/VerifyAbhaProfile'
type: array
eka:
$ref: '#/components/schemas/RegistrationEkaIds'
hint:
Expand Down