/
ND
ndhm
/
Health Repository Provider Specifications for HIP
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v1
latest
OpenAPI 3.0.0
2026-07-14
30
70
78.8 KB
Gateway
Get openid configuration
get
/v0.5/.well-known/openid-configuration
Response
OK
OpenIdConfiguration
required
jwks_uri
string
uri
Example response
{ "jwks_uri": "https://ncg-gateway/certs" }
All 30 operations
get
Get openid configuration
post
Discover patient's accounts
post
Response to patient's account discovery request
get
Get certs for JWT verification
post
Consent notification
post
Consent notification
post
Health information data request
post
Health information data request
post
Notifications corresponding to events during data flow
post
health information transfer API
get
Get consent request status
post
API for HIP initiated care-context linking for patient
post
Token submission by Consent Manager for link confirmation
post
Link patient's care contexts
post
callback API for HIP initiated patient linking /link/add-context
post
Token authenticated by HIP, indicating completion of linkage of care-contexts
post
Response to patient's care context link request
post
Response to patient's share profile request
post
Share patient profile details
post
API for HIP to send SMS notifications to patients
post
Acknowledgment response for SMS notification sent to patient by HIP
post
Get access token
post
Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation
post
Get a patient's authentication modes relevant to specified purpose
post
Initialize authentication from HIP
post
notification API in case of DIRECT mode of authentication by the CM
post
callback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not
post
Identification result for a consent-manager user-id
post
Response to user authentication initialization from HIP
post
callback API by HIU/HIPs as acknowledgement of auth notification