openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 82.3 kB
JSON
{"openapi":"3.0.0","servers":[{"description":"Sandbox","url":"https://dev.ndhm.gov.in/gateway"}],"info":{"contact":{"name":"National Health Authority","url":"https://ndhm.gov.in/"},"description":"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. \n\n 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. \n 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. \n 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. \n 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 \n","title":"Health Repository Provider Specifications for HIU","version":"0.5","x-apisguru-categories":["open_data"],"x-origin":[{"format":"openapi","url":"https://apisetu.gov.in/api_specification_v8/ndhm-hiu.yaml","version":"3.0"}],"x-providerName":"ndhm.gov.in","x-serviceName":"ndhm-hiu"},"tags":[{"name":"user auth"},{"name":"identification"},{"name":"consent flow"},{"name":"data flow"},{"name":"subscriptions"},{"name":"monitoring"},{"name":"Gateway"}],"paths":{"/v0.5/.well-known/openid-configuration":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConfiguration"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OpenIdConfiguration"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid consent request id\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Get openid configuration","tags":["Gateway"]}},"/v0.5/certs":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certs"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Certs"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid consent request id\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Get certs for JWT verification","tags":["Gateway"]}},"/v0.5/consent-requests/init":{"post":{"description":"Creates a consent request to get data about a patient by HIU user.","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConsentRequest"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent \n * Required attributes not mentioned\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Create consent request","tags":["Gateway"]}},"/v0.5/consent-requests/on-init":{"post":{"description":"Result of consent request creation for a patient. **id** represents the consentrequest id created by CM. The result must contain either **id** or the **error** caused. <br/>\n Reasons for error may be\n * Invalid references (e.g patient id, hiu id), purpose, hiTypes, ranges, persmission\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequestInitResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConsentRequestInitResponse"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Response to consent request","tags":["consent flow"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/consent-requests/on-status":{"post":{"description":"Result of consent request done previously. Status of request can be GRANTED, DENIED, EXPIRED. If the request was GRANTED, then \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUConsentRequestStatus"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HIUConsentRequestStatus"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Result of consent request status","tags":["consent flow"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/consent-requests/status":{"post":{"description":"Get status of consent request done previously","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequestStatusRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConsentRequestStatusRequest"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Get consent request status","tags":["Gateway"]}},"/v0.5/consents/fetch":{"post":{"parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentFetchRequest"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Get consent artefact","tags":["Gateway"]}},"/v0.5/consents/hiu/notify":{"post":{"description":"Health information user will get notified about the consent request granted or denied, consent revoked, consent expired. \n1. For consent request grant, status=GRANTED, consentRequestId=<consent-request-id>, and consentArtefacts is an array of generated consent artefact Ids.\n2. For consent request expiry, status=EXPIRED, consentRequestId=<consent-request-id>\n3. For consent request denied, status=DENIED, consentRequestId=<consent-request-id>\n4. For consent revocation, status=REVOKED, consentArtefacts is an array of revoked consent artefact ids\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUConsentNotificationEvent"}}},"required":true},"responses":{"202":{"description":"Request Accepted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid/Expired/Empty token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream services are down\n"}},"summary":"Consent notification","tags":["consent flow"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/consents/hiu/on-notify":{"post":{"description":"This API is called by HIU as acknowledgement to consent notifications, specifically for cases when consent is REVOKED or EXPIRED.\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUConsentNotificationResponse"}}},"required":true},"responses":{"202":{"description":"Request Accepted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid/Expired/Empty token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream services are down\n"}},"summary":"Consent notification","tags":["Gateway"]}},"/v0.5/consents/on-fetch":{"post":{"description":"Must contain either consent or error. Possible reason of errors are \n1. consentId passed through /fetch is invalid\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentArtefactResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConsentArtefactResponse"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Result of fetch request for a consent artefact","tags":["consent flow"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/health-information/cm/request":{"post":{"description":"Request for Health information against a consent id. CM would generate a transactionId against each consent and pass it as trnasaction context / correlation id to the HIP and also return the same to HIU via /on-request. \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HIRequest"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Bad request\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Token is invalid or Link has expired\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Health information data request","tags":["Gateway"]}},"/v0.5/health-information/hiu/on-request":{"post":{"description":"Callback API for acknowledgement of Health information request made by HIU. Gateway calls this API when request has validated for the specified consent id. Either the **hiRequest** or **error** would be specified. If the health info request was valid, then the ***hiRequest.transactionId*** specifies the transaction context against which HIP would send over the data. Possible cases of errors are\n 1. **Invalid consent artefact id**\n 2. **Consent has expired**\n 3. **Date ranges are invalid**\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUHealthInformationRequestResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HIUHealthInformationRequestResponse"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Bad request\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Token is invalid or Link has expired\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Health information data request","tags":["data flow"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/health-information/notify":{"post":{"description":"API called by HIU and HIP during data-transfer.\n1. HIP on transfer of data would send **sessionStatus** - one of [TRANSFERRED, FAILED]\n2. HIP would also send **hiStatus** for each *careContextReference* - on of [DELIVERED, ERRORED]\n3. HIU on receipt of data would send **sessionStatus** - one of [TRANSFERRED, FAILED]. For example, FAILED when if data was not sent or if invalid data was sent\n4. HIU would also send **hiStatus** for each *careContextReference* - one of [OK, ERRORED]\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthInformationNotification"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HealthInformationNotification"}}},"required":true},"responses":{"204":{"description":"Notification is Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid Request\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Notifications corresponding to events during data flow","tags":["Gateway"]}},"/v0.5/health-information/transfer":{"post":{"description":"**NOTE**: This API is actually the callback URL that is passed as **dataPushUrl** in the data request API - /v0.5/health-information/hip/request. This API is directly called by HIP Data Bridge and is not mediated via CM, and hence not routed through the Gateway. \n 1. This API should be implemented at HIU side. It maybe implemented by the Data Bridge representing the HIU. \n 2. Entry elements maybe ***content*** or ***link***, although for version 1, entry ***content*** is preferred. \n 3. Entry ***content*** (or even link reference content) must be encrypted by means of Elliptic-curve Diffie–Hellman Key Exchange, utilizing the HIU keymaterials that are passed through the data request API - /v0.5/health-information/hip/request. \n 4. Media contains the mimetype of content, and for v1, it is \"application/fhir+json\"\n 5. checksum is Md5 checksum of the data conent, before encryption\n 6. Please refer to the NDHM Sandbox documentation for the format of FHIR bundle that is passed through content \n","parameters":[{"$ref":"#/components/parameters/authorization"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataNotification"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DataNotification"}}},"required":true},"responses":{"202":{"description":"Data accepted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid/Expired/Empty token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream services are down\n"}},"summary":"health information transfer API","tags":["data flow"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/heartbeat":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeartbeatResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HeartbeatResponse"}}},"description":"OK"}},"summary":"Get consent request status","tags":["monitoring"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/patients/find":{"post":{"description":"This API is meant for identify to patient given her consent-manager-user-id\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientIdentificationRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientIdentificationRequest"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid request, required attributes not provided\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Identify a patient by her consent-manager user-id","tags":["Gateway"]}},"/v0.5/patients/on-find":{"post":{"description":"If a patient is found then patient.name contains the patients name. \nOtherwise, patient is not provided, and possibly error is raised for invalid requests\nNote in addition to the \"Authorization\" header, one of the following headers must be specified\n1. specify **X-HIU-ID** if the requester is HIU (identified from /find requester.id)\n2. specify **X-HIP-ID** if the requester is HIP (identified from /find requester.id)\n","parameters":[{"$ref":"#/components/parameters/authorization"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientIdentificationResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientIdentificationResponse"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid request, required attributes not provided\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Identification result for a consent-manager user-id","tags":["identification"]},"servers":[{"url":"https://dev.ndhm.gov.in/hiu"}]},"/v0.5/sessions":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SessionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SessionResponse"}}},"description":"OK"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid client Id or secret.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid consent request id\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Get access token","tags":["Gateway"]}},"/v0.5/subscription-requests/cm/init":{"post":{"description":"creates a request for subscription. The subscription categories can be for care-contexts linkages or availability of data against existing care-contexts. Note that the requester must have HIU role","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SubscriptionRequest"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent \n * Required attributes not mentioned\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Request for subscription","tags":["Gateway"]}},"/v0.5/subscription-requests/hiu/notify":{"post":{"description":"This API is used by CM to notify a HIU to grant or deny a request for subscription, and also to notify that in case an existing subscription is revoked or expired. For notifying that a particular subscription request was GRANTED or DENIED, the **subscriptionRequestId** is passed. \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionApprovalNotification"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SubscriptionApprovalNotification"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent \n * Required attributes not mentioned\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Notification for subscription grant/deny/revoke","tags":["subscriptions"]}},"/v0.5/subscription-requests/hiu/on-init":{"post":{"description":"This callback API acknowledges the request for subscription from a HIU, and sends back a \"id\" that will be used when the patient/user approves or denies the subscription. \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUSubscriptionRequestReceipt"}}},"required":true},"responses":{"202":{"description":"Request Accepted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid/Expired/Empty token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream services are down\n"}},"summary":"callback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the request for subscription.","tags":["subscriptions"]}},"/v0.5/subscription-requests/hiu/on-notify":{"post":{"description":"This API is called by HIU as acknowledgement to subscription request relevant notifications. \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUSubscriptionRequestNotificationAcknowledgement"}}},"required":true},"responses":{"202":{"description":"Request Accepted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid/Expired/Empty token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream services are down\n"}},"summary":"Callback API for /subscription-requests/hiu/notify to acknowledge receipt of notification.","tags":["Gateway"]}},"/v0.5/subscriptions/hiu/notify":{"post":{"description":"This API is used by CM to notify a HIU for notification relevant to subscription. Notifications are sent to subscribed HIUs whenever a new care-context is linked or new data is available on an existing linked care-context. \n1. if event.category = LINK, then only care-contexts are passed when new care-contexts are linked for patient. \n2. If event.category = DATA, then hiTypes are passed. Care-context is passed only if the subscribed HIU has any valid consent for that care-context\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUSubscriptionNotification"}},"application/xml":{"schema":{"$ref":"#/components/schemas/HIUSubscriptionNotification"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid data sent \n * Required attributes not mentioned\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Expired/Invalid token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Notification to HIU on basis of a granted subscription","tags":["subscriptions"]}},"/v0.5/subscriptions/hiu/on-notify":{"post":{"description":"This API is called by HIU as acknowledgement to consent notifications, specifically for cases when consent is REVOKED or EXPIRED.\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HIUSubscriptionNotificationAcknowledgment"}}},"required":true},"responses":{"202":{"description":"Request Accepted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Invalid/Expired/Empty token.\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream services are down\n"}},"summary":"Callback API for /subscriptions/hiu/notify to acknowledge receipt of notification.","tags":["Gateway"]}},"/v0.5/users/auth/confirm":{"post":{"description":"This API is called by HIP/HIUs to confirm authentication of users. The transactionId returned by the previous callback API /users/auth/on-init must be sent. If Authentication is successful the callback API will send an \"access token\" for subsequent purpose specific API calls. Note only **credential.authCode** or **credential.demographic** should be sent\n 1. demographic details are only required for demographic auth as of now. \n 2. demographic details are required only in MEDIATED cases and if the **auth.mode** so demands. e.g. if **auth.mode** is DEMOGRAPHICS. Usually for demographic authentication, the name, gender and DOB must be exactly as specified in User Account.\n 3. demographic.identifier is optional, however maybe required if authentication so mandates. \n 4. credential.authCode is required for other MEDIATED authentication like MOBILE_OTP, AADHAAR_OTP. \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthConfirmRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthConfirmRequest"}}},"required":true},"responses":{"202":{"description":"Request accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * transaction id is not provided or invalid\n * token or other auth confirmation details not provided or invalid\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation","tags":["Gateway"]}},"/v0.5/users/auth/fetch-modes":{"post":{"description":"This API is meant for identify supported authentication modes for a patient given a specific purpose\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthModeQueryRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthModeQueryRequest"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid request, required attributes not provided\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Get a patient's authentication modes relevant to specified purpose","tags":["Gateway"]}},"/v0.5/users/auth/init":{"post":{"description":"This API is called by HIPs to initiate authentication of users. A transactionId is retuned by the corresponding callback API for confirmation of user auth.\n 1. **NOTE**, only **KYC** purpose is applicable for HIU. Hence HIU should only sent KYC in **query.authMode** in the request\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthInitRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthInitRequest"}}},"required":true},"responses":{"202":{"description":"Request accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * patient id is not provided\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Initialize authentication from HIP","tags":["Gateway"]}},"/v0.5/users/auth/notify":{"post":{"description":"This API is called by CM to confirm authentication of users. The transactionId returned is same as that passed in /auth/on-init. The \"auth.status\" conveys whether the request was GRANTED or DENIED.\n\n 1. **auth.accessToken** - is specific to the purpose mentioned in the /auth/init. This token needs to be used for initiating the intended action. For example for HIP initiated linking of care-contexts\n 2. **NOTE**, only one of **X-HIP-ID** or **X-HIU-ID** will be sent as part of header, not both.\n 3. The payload is conditional to the purpose of auth. If purpose specified in /auth/init is KYC or KYC_AND_LINK, then patient details are passed. **auth.accessToken** is passed only if the purpose is LINK or KYC_AND_LINK.\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIP-ID"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthNotification"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthNotification"}}},"required":true},"responses":{"202":{"description":"Request accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * required details not provided\n * neither auth nor error specified \n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"notification API in case of DIRECT mode of authentication by the CM","tags":["user auth"]}},"/v0.5/users/auth/on-confirm":{"post":{"description":"This API is called by CM to confirm authentication of users.\n\n 1. **auth.accessToken** - is specific to the purpose mentioned in the /auth/init. This token needs to be used for initiating the intended action. For example for HIP initiated linking of care-contexts\n 2. **NOTE**, only one of **X-HIP-ID** or **X-HIU-ID** will be sent as part of header, not both. \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIP-ID"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthConfirmResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthConfirmResponse"}}},"required":true},"responses":{"202":{"description":"Request accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * required details not provided\n * neither auth nor error specified \n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"callback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not","tags":["user auth"]}},"/v0.5/users/auth/on-fetch-modes":{"post":{"description":"If a patient is found then **auth** attribute contains the supported modes for the specified purpose. \nOtherwise, error is raised for invalid requests or for non-existent id.\nNote in addition to the \"Authorization\" header, one of the following headers must be specified\n1. **X-HIU-ID** if the requester is HIU (identified from /auth/fetch-modes requester.id)\n2. **X-HIP-ID** if the requester is HIP (identified from /auth/fetch-modes requester.id)\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIP-ID"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthModeQueryResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthModeQueryResponse"}}},"required":true},"responses":{"202":{"description":"Request Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Invalid request, required attributes not provided\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Identification result for a consent-manager user-id","tags":["user auth"]}},"/v0.5/users/auth/on-init":{"post":{"description":"If the patient's id is valid, CM will return a transactionId as initialization of user auth. If the request is valid, then 'auth.mode' will convey how the authentication should be done. The authentication can be *mediated* or *direct*. For mediated authentication modes, HIP or HIU is epected to send over relevant code (OTP/token) or demographic info via subsequent API call to /auth/confirm. for direct authentication case, CM will notify requester through/users/auth/notify API. \n\n 1. **auth.mode** conveys whats the mode of authentication is, and what is expected from HIP/HIU in the subsequent /auth/confirm API call. Possible values \n 1. MOBILE_OTP - auth via OTP to registered mobile. Mediated. \n 2. AADHAAR_OTP - auth initiated with Aadhaar with OTP. Mediated. \n 3. DEMOGRAPHICS - auth initiated with demographic verification\n 4. DIRECT - for authentication directly with the patient. e.g. Mobile App, SMS. In this case, the HIP/HIU is not expected to call subsequent /auth/confirm call. CM will do direct authentication with the User (e.g. Mobile App, SMS etc) and will notify requester\n 2. **meta.expiry** conveys the expiry time of the token and the authentication session\n 3. **NOTE**, only one of **X-HIP-ID** or **X-HIU-ID** will be sent as part of header, not both. \n 4. **NOTE**, only KYC purpose is applicable for HIU\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \nThe error section in the body, represents the potential errors that may have occurred. Possible reasons:\n 1. Patient id is invalid\n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-HIP-ID"},{"$ref":"#/components/parameters/X-HIU-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthInitResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthInitResponse"}}},"required":true},"responses":{"202":{"description":"Request accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * required information not provided\n * neither authInit nor error specified \n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"Response to user authentication initialization from HIP","tags":["user auth"]}},"/v0.5/users/auth/on-notify":{"post":{"description":"This API is called by HIU/HIPs to confirm acknowledgement for receipt of auth notification is case of DIRECT authentication. \n","parameters":[{"$ref":"#/components/parameters/authorization"},{"$ref":"#/components/parameters/X-CM-ID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAuthNotificationAcknowledgement"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatientAuthNotificationAcknowledgement"}}},"required":true},"responses":{"202":{"description":"Request accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * required details not provided\n * neither auth nor error specified \n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Unauthorized request\n"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"**Causes:**\n * Downstream system(s) is down.\n * Unhandled exceptions.\n"}},"summary":"callback API by HIU/HIPs as acknowledgement of auth notification","tags":["Gateway"]}}},"components":{"parameters":{"ConsentId":{"description":"Consent request's identifier","in":"path","name":"consentId","required":true,"schema":{"format":"uuid","type":"string"}},"ConsentRequestId":{"description":"Consent request's identifier","in":"path","name":"consentRequestId","required":true,"schema":{"format":"uuid","type":"string"}},"LinkRefNumber":{"description":"Reference number for the link request made earlier.","in":"path","name":"linkRefNumber","required":true,"schema":{"$ref":"#/components/schemas/UuidSchema"}},"X-CM-ID":{"description":"Suffix of the consent manager to which the request was intended.","in":"header","name":"X-CM-ID","required":true,"schema":{"type":"string"}},"X-HIP-ID":{"description":"Identifier of the health information provider to which the request was intended.","in":"header","name":"X-HIP-ID","required":true,"schema":{"type":"string"}},"X-HIU-ID":{"description":"Identifier of the health information user to which the request was intended.","in":"header","name":"X-HIU-ID","required":true,"schema":{"type":"string"}},"X-Origin-ID":{"description":"Identifier of the health information provider user from which the request came. (Necessity of this header depends on the authentication at the Bridge) If gateway uses JWT authentication, from access