abdm

The following are the specifications for the APIs to be implemented at the Health Repository end if an entity is only serving the role of a HIU. The specs are essentially duplicates from the Gateway and Bridge, but put together so as to make it clear to HIUs which set of APIs they should implement to participate in the network.

1. The APIs are organized by the flows - identification, consent flow, data flow and monitoring. They represent the APIs that are expected to be available at the HIU end by the Gateway.
2. For majority of the APIs, if Gateway has initiated a call, there are corresponding callback APIs on the Gateway. e.g for /consents/hiu/notify API on HIU end, its expected that a corresponding callback API /consents/hiu/on-notify on Gateway is called. Such APIs are organized under the Gateway label.
3. Gateway relevant APIs for HIUs are grouped under Gateway label. These include the APIs that HIPs are required to call on the Gateway. For example, to request a CM for consent, HIU would call /consent-requests/init API on gateway.
4. NOTE, in some of the API documentations below, X-HIP-ID is mentioned in header (for example in /auth/on-init). These are the cases, when a particular API is applicable for both HIU and HIP (e.g an entity is playing the role of HRP representing both HIU and HIP). If you are only playing the role of HIP, then only X-HIU-ID header will be sent

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.5
• Package version: 1.0.0
• Generator version: 7.5.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/Technoculture/ABDM-HIU-SDK/tree/dev

pip install git+https://github.com/Technoculture/ABDM-HIU-SDK/tree/dev (you may need to run pip with root permission: sudo pip install git+)

Then import the package:

import abdm

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import abdm

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import abdm
from abdm.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dev.abdm.gov.in/gateway
# See configuration.py for a list of all supported configuration parameters.
configuration = abdm.Configuration(
    host = "https://dev.abdm.gov.in/gateway"
)



# Enter a context with an instance of the API client
with abdm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = abdm.GatewayApi(api_client)

    try:
        # Get certs for JWT verification
        api_response = api_instance.v05_certs_get()
        print("The response of GatewayApi->v05_certs_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GatewayApi->v05_certs_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://dev.abdm.gov.in/gateway

Documentation For Models

• AccessTokenValidity
• AuthConfirmIdentifier
• AuthConfirmIdentifierType
• AuthMeta
• AuthenticationMode
• CareContextDefinition
• CertificateOrKeyGetSchema
• Certs
• Consent
• ConsentAcknowledgement
• ConsentArtefactReference
• ConsentArtefactResponse
• ConsentArtefactResponseConsent
• ConsentArtefactResponseConsentConsentDetail
• ConsentArtefactResponseConsentConsentDetailCareContextsInner
• ConsentArtefactResponseConsentConsentDetailConsentManager
• ConsentArtefactResponseConsentConsentDetailHip
• ConsentArtefactResponseConsentConsentDetailHiu
• ConsentFetchRequest
• ConsentManagerPatientID
• ConsentRequest
• ConsentRequestConsent
• ConsentRequestConsentPatient
• ConsentRequestInitResponse
• ConsentRequestInitResponseConsentRequest
• ConsentRequestStatusRequest
• ConsentStatus
• DataNotification
• DataNotificationEntriesInner
• DateRange
• EntryContent
• EntryLink
• Error
• ErrorResponse
• EventCategoryDetail
• HIRequest
• HIRequestHiRequest
• HITypeEnum
• HIUConsentNotificationEvent
• HIUConsentNotificationEventNotification
• HIUConsentNotificationResponse
• HIUConsentRequestStatus
• HIUConsentRequestStatusConsentRequest
• HIUHealthInformationRequestResponse
• HIUHealthInformationRequestResponseHiRequest
• HIUSubscription
• HIUSubscriptionContext
• HIUSubscriptionEventContent
• HIUSubscriptionNotification
• HIUSubscriptionNotificationAcknowledgment
• HIUSubscriptionNotificationAcknowledgmentAcknowledgement
• HIUSubscriptionNotificationEvent
• HIUSubscriptionRequestNotificationAcknowledgement
• HIUSubscriptionRequestNotificationAcknowledgementAcknowledgement
• HIUSubscriptionRequestReceipt
• HealthInformationNotification
• HealthInformationNotificationNotification
• HealthInformationNotificationNotificationNotifier
• HealthInformationNotificationNotificationStatusNotification
• HealthInformationNotificationNotificationStatusNotificationStatusResponsesInner
• HeartbeatResponse
• HiuPatientStatusNotification
• HiuPatientStatusNotificationNotification
• HiuPatientStatusNotificationNotificationPatient
• Identifier
• IdentifierType
• KeyMaterial
• KeyObject
• OpenIdConfiguration
• OrganizationRepresentation
• PatientAddress
• PatientAuthConfirmRequest
• PatientAuthConfirmRequestCredential
• PatientAuthConfirmResponse
• PatientAuthConfirmResponseAuth
• PatientAuthInitRequest
• PatientAuthInitRequestQuery
• PatientAuthInitRequestQueryRequester
• PatientAuthInitResponse
• PatientAuthInitResponseAuth
• PatientAuthModeQueryRequest
• PatientAuthModeQueryRequestQuery
• PatientAuthModeQueryRequestQueryRequester
• PatientAuthModeQueryResponse
• PatientAuthModeQueryResponseAuth
• PatientAuthNotification
• PatientAuthNotificationAcknowledgement
• PatientAuthNotificationAcknowledgementAcknowledgement
• PatientAuthNotificationAuth
• PatientAuthPurpose
• PatientAuthRequester
• PatientDemographic
• PatientDemographicResponse
• PatientGender
• PatientIdentificationRequest
• PatientIdentificationRequestQuery
• PatientIdentificationRequestQueryPatient
• PatientIdentificationRequestQueryRequester
• PatientIdentificationResponse
• PatientIdentificationResponsePatient
• PatientStatusNotification
• Permission
• PermissionDateRange
• PermissionFrequency
• RequestReference
• Requester
• RequesterIdentifier
• SessionRequest
• SessionResponse
• SubscriptionApprovalNotification
• SubscriptionApprovalNotificationNotification
• SubscriptionCategory
• SubscriptionPeriod
• SubscriptionRequest
• SubscriptionRequestSubscription
• SubscriptionStatus
• UsePurpose

Documentation For Authorization

Endpoints do not require authorization.

Author