{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-well-known-openid-configuration":{"get":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_get_v0_5_well_known_openid_configuration","summary":"Get openid configuration","description":"GET /v0.5/.well-known/openid-configuration","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-certs":{"get":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_get_v0_5_certs","summary":"Get certs for JWT verification","description":"GET /v0.5/certs","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consent_requests_init","summary":"Create consent request","description":"POST /v0.5/consent-requests/init","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-on-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consent_requests_on_init","summary":"Response to consent request","description":"POST /v0.5/consent-requests/on-init","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-on-status":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consent_requests_on_status","summary":"Result of consent request status","description":"POST /v0.5/consent-requests/on-status","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-status":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consent_requests_status","summary":"Get consent request status","description":"POST /v0.5/consent-requests/status","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-fetch":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consents_fetch","summary":"Get consent artefact","description":"POST /v0.5/consents/fetch","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-hiu-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consents_hiu_notify","summary":"Consent notification","description":"POST /v0.5/consents/hiu/notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-hiu-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consents_hiu_on_notify","summary":"Consent notification","description":"POST /v0.5/consents/hiu/on-notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-on-fetch":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_consents_on_fetch","summary":"Result of fetch request for a consent artefact","description":"POST /v0.5/consents/on-fetch","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-cm-request":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_health_information_cm_request","summary":"Health information data request","description":"POST /v0.5/health-information/cm/request","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-hiu-on-request":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_health_information_hiu_on_request","summary":"Health information data request","description":"POST /v0.5/health-information/hiu/on-request","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_health_information_notify","summary":"Notifications corresponding to events during data flow","description":"POST /v0.5/health-information/notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-transfer":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_health_information_transfer","summary":"health information transfer API","description":"POST /v0.5/health-information/transfer","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-heartbeat":{"get":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_get_v0_5_heartbeat","summary":"Get consent request status","description":"GET /v0.5/heartbeat","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-patients-find":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_patients_find","summary":"Identify a patient by her consent-manager user-id","description":"POST /v0.5/patients/find","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-patients-on-find":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_patients_on_find","summary":"Identification result for a consent-manager user-id","description":"POST /v0.5/patients/on-find","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-sessions":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_sessions","summary":"Get access token","description":"POST /v0.5/sessions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-cm-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_subscription_requests_cm_init","summary":"Request for subscription","description":"POST /v0.5/subscription-requests/cm/init","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-hiu-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_subscription_requests_hiu_notify","summary":"Notification for subscription grant/deny/revoke","description":"POST /v0.5/subscription-requests/hiu/notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-hiu-on-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_subscription_requests_hiu_on_init","summary":"callback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the…","description":"POST /v0.5/subscription-requests/hiu/on-init","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-hiu-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_subscription_requests_hiu_on_notify","summary":"Callback API for /subscription-requests/hiu/notify to acknowledge receipt of notification.","description":"POST /v0.5/subscription-requests/hiu/on-notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscriptions-hiu-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_subscriptions_hiu_notify","summary":"Notification to HIU on basis of a granted subscription","description":"POST /v0.5/subscriptions/hiu/notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIU-ID","body"],"properties":{"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscriptions-hiu-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_subscriptions_hiu_on_notify","summary":"Callback API for /subscriptions/hiu/notify to acknowledge receipt of notification.","description":"POST /v0.5/subscriptions/hiu/on-notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-confirm":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_confirm","summary":"Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation","description":"POST /v0.5/users/auth/confirm","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-fetch-modes":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_fetch_modes","summary":"Get a patient's authentication modes relevant to specified purpose","description":"POST /v0.5/users/auth/fetch-modes","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_init","summary":"Initialize authentication from HIP","description":"POST /v0.5/users/auth/init","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_notify","summary":"notification API in case of DIRECT mode of authentication by the CM","description":"POST /v0.5/users/auth/notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIP-ID","X-HIU-ID","body"],"properties":{"X-HIP-ID":{"type":"string","description":"Identifier of the health information provider to which the request was intended."},"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-confirm":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_on_confirm","summary":"callback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not","description":"POST /v0.5/users/auth/on-confirm","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIP-ID","X-HIU-ID","body"],"properties":{"X-HIP-ID":{"type":"string","description":"Identifier of the health information provider to which the request was intended."},"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-fetch-modes":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_on_fetch_modes","summary":"Identification result for a consent-manager user-id","description":"POST /v0.5/users/auth/on-fetch-modes","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIP-ID","X-HIU-ID","body"],"properties":{"X-HIP-ID":{"type":"string","description":"Identifier of the health information provider to which the request was intended."},"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_on_init","summary":"Response to user authentication initialization from HIP","description":"POST /v0.5/users/auth/on-init","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-HIP-ID","X-HIU-ID","body"],"properties":{"X-HIP-ID":{"type":"string","description":"Identifier of the health information provider to which the request was intended."},"X-HIU-ID":{"type":"string","description":"Identifier of the health information user to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_hiu_post_v0_5_users_auth_on_notify","summary":"callback API by HIU/HIPs as acknowledgement of auth notification","description":"POST /v0.5/users/auth/on-notify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-CM-ID","body"],"properties":{"X-CM-ID":{"type":"string","description":"Suffix of the consent manager to which the request was intended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}