{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:ndhm-gov-in-ndhm-cm/post-v0-5-care-contexts-on-discover":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_care_contexts_on_discover","summary":"Response to patient's account discovery request","description":"POST /v0.5/care-contexts/on-discover","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-cm/post-v0-5-consent-requests-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-consent-requests-status":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-consents-fetch":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-consents-hip-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_consents_hip_on_notify","summary":"Consent notification","description":"POST /v0.5/consents/hip/on-notify","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-cm/post-v0-5-consents-hiu-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-health-information-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-health-information-on-request":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_health_information_on_request","summary":"Health information data request acknowledgement from HIP","description":"POST /v0.5/health-information/on-request","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-cm/post-v0-5-health-information-request":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_health_information_request","summary":"Health information data request from HIU","description":"POST /v0.5/health-information/request","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-cm/get-v0-5-heartbeat":{"get":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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-cm/post-v0-5-links-link-add-contexts":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_links_link_add_contexts","summary":"API for HIP initiated care-context linking for patient","description":"POST /v0.5/links/link/add-contexts","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-cm/post-v0-5-links-link-on-confirm":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_links_link_on_confirm","summary":"Token authenticated by HIP, indicating completion of linkage of care-contexts","description":"POST /v0.5/links/link/on-confirm","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-cm/post-v0-5-links-link-on-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_links_link_on_init","summary":"Response to patient's care context link request","description":"POST /v0.5/links/link/on-init","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-cm/post-v0-5-patients-find":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-patients-profile-on-share":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_patients_profile_on_share","summary":"Response to patient's share profile request","description":"POST /v0.5/patients/profile/on-share","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-cm/post-v0-5-subscription-requests-cm-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-subscription-requests-hiu-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-subscriptions-hiu-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-users-auth-confirm":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-users-auth-fetch-modes":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-users-auth-init":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_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":["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-cm/post-v0-5-users-auth-on-notify":{"post":{"operationId":"open_data_ndhm_gov_in_ndhm_cm_post_v0_5_users_auth_on_notify","summary":"callback API from HIU/HIPs as acknowledgement of auth notification (in case of DIRECT auth)","description":"POST /v0.5/users/auth/on-notify","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"}}},"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"}}}}}}}