National Health AuthorityNHA Docs

Command Palette

Search for a command to run...

Sandbox Onboarding

Create, update, and delete NHCX sandbox participants for providers, payers, and TPAs.

The NHCX participant registry is the source of truth for each sandbox participant. It stores participant details and exposes registry APIs.

A validated participant can exchange claim data through NHCX. NHCX validates each participant against a trusted registry.

ParticipantTrusted registryValidation
ProviderHFR registry of ABDMNHCX validates the linked provider registry code.
PayerTrusted payer registryNHCX validates the linked payer registry code.
TPATrusted TPA registryNHCX validates the linked TPA registry code.

Sandbox onboarding procedure

Prepare the registry details

Collect the registry code for each provider, payer, or TPA.

Register the provider in HFR before you create a provider participant.

Register the payer or TPA in its trusted registry before you create a payer participant.

Create the participant

Call POST /participate/create with the registry type, registry code, role, endpoint URL, mobile number, and email.

NHCX validates the linked registry codes.

NHCX returns a participant code such as 100001@sbx.

Store the participant code

Save the participant code.

Use it for all claims traffic.

Update participant details

Call POST /participate/update when the bridge URL or the encryption certificate changes.

Include the participant code in the request.

NHCX validates the linked registry codes again.

Delete a test participant

Call POST /participate/delete when a test participant is no longer valid.

This API applies a soft delete only.

Do not reuse the deleted participant code for a new entity.

Create a participant

POST/participate/create

Create a participant in the sandbox registry.

FieldValue
CallerProviders and payers
Key validationValidate the linked registry codes
Success response200 with participant_code
Error codes400 client error, 404 resource not found, 500 downstream system error
Response (200)
{
  "participant_code": "100001@sbx"
}

Update a participant

POST/participate/update

Update participant details in the sandbox registry.

Use this API to update the bridge URL, the encryption certificate, or another participant attribute.

FieldValue
CallerProviders and payers
Required fieldparticipant_code
Key validationValidate the linked registry codes
Success response200 with participant_code
Error codes400 client error, 404 resource not found, 500 downstream system error
Response (200)
{
  "participant_code": "100001@sbx"
}

Delete a participant

POST/participate/delete

Apply a soft delete to a sandbox participant.

FieldValue
CallerProviders and payers
Key validationValidate the participant code
Success response200 with message
Error codes400 client error, 404 resource not found, 500 downstream system error
Request
{
  "participant_code": "10001@sbx"
}
Response (200)
{
  "message": "Deleted"
}

Read Encryption Certificate before you upload a public key.

Sources

  • onboarding-sandbox.md (NHCX sandbox portal)
PreviousStandards and FHIRNext Production Onboarding