Sign in

v1

latestOpenAPI 3.0.02026-07-14307078.8 KB
data transfer

health information transfer API

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.

  1. This API should be implemented at HIU side. It maybe implemented by the Data Bridge representing the HIU.
  2. Entry elements maybe content or link, although for version 1, entry content is preferred.
  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.
  4. Media contains the mimetype of content, and for v1, it is "application/fhir+json"
  5. checksum is Md5 checksum of the data conent, before encryption
  6. Please refer to the NDHM Sandbox Documentation for the format of FHIR bundle that is passed through content
post/v0.5/health-information/transfer

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server, which will be sent by gateway to authenticate itself with API bridge.

Request body

pageCountinteger required

Total number of pages.

pageNumberinteger required

Current page number.

transactionIdstring uuid required

Transaction Id issued when data requested.

Example request

{
  "entries": [
    {
      "careContextReference": "RVH1008",
      "content": "Encrypted content of data packaged in FHIR bundle"
    }
  ],
  "keyMaterial": {
    "cryptoAlg": "ECDH",
    "curve": "Curve25519",
    "dhPublicKey": {
      "parameters": "Curve25519/32byte random key"
    },
    "nonce": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Response

Data accepted.