Skip to main content

Communication

The payer's asynchronous channel to the provider: a turnaround alert, a grievance, a policy or wallet change, or a request for documents. The provider acknowledges within thirty seconds, whether or not the issue is resolved.

The request​

Sent on /v1/communication/request.

The bundle​

#ResourceProfile
1TaskTask
2CommunicationRequestCommunicationRequest
3ClaimClaim
4PatientPatient
5Organization (ins)Organization
6Organization (prov)Organization
7PractitionerPractitioner
8CoverageCoverage

Elements​

Task​

NRCeS profile: Task.

ElementExample
statusrequested
intentorder
reasonCode.coding[]additionalinfo Additional Information Request in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-reason-code
code.coding[]poll in http://terminology.hl7.org/CodeSystem/financialtaskcode
descriptionShare the pre-operative X-ray and the clinical notes.
authoredOn2026-09-10T23:51:47+05:30
requesterreference urn:uuid:39cd4b51-bddd-5cc1-a65a-6fa4a2a83cb5, display Organization
ownerreference urn:uuid:84d112ec-041c-57f8-986c-6619ccd8245e, display Organization
input[].type.coding[]include in http://terminology.hl7.org/CodeSystem/financialtaskinputtype
input[].valueReferencereference urn:uuid:4b35a6eb-3f99-5d0c-b0c8-5b2f049fdbde, display CommunicationRequest

CommunicationRequest​

NRCeS profile: CommunicationRequest.

ElementExample
identifier[]value NM-26-0SE00002I
basedOn[]reference urn:uuid:c1a17d6e-c718-58de-8d3d-fd4c0607d729, display Claim-preauth
statusactive
category[].coding[]alert in http://terminology.hl7.org/CodeSystem/communication-category
priorityroutine
payload[]contentString Share the pre-operative X-ray and the clinical notes.
authoredOn2026-09-10T23:51:47+05:30
requesterreference urn:uuid:39cd4b51-bddd-5cc1-a65a-6fa4a2a83cb5, display Organization
recipient[]reference urn:uuid:84d112ec-041c-57f8-986c-6619ccd8245e, display Organization
senderreference urn:uuid:39cd4b51-bddd-5cc1-a65a-6fa4a2a83cb5, display Organization
reasonCode[]text Share the pre-operative X-ray and the clinical notes.
reasonCode[].coding[]additionalinfo Additional Information Request in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-reason-code

The Claim, Patient, Organization, Practitioner, Coverage entries are shaped as in the chapters that introduce them.

A notification​

Sent on /v1/communication/request, workflow N02.

The bundle​

#ResourceProfile
1Tasknone declared; NRCeS Task
2CommunicationRequestnone declared; NRCeS CommunicationRequest
3Organization (pay)none declared; NRCeS Organization
4Organization (prov)none declared; NRCeS Organization

Elements​

Task​

NRCeS profile: Task.

ElementExample
statuscompleted
intentproposal
code.coding[]poll Poll in http://terminology.hl7.org/CodeSystem/financialtaskcode
reasonCode.coding[]information Information in http://terminology.hl7.org/CodeSystem/communication-category
input[].type.coding[]include Include in http://terminology.hl7.org/CodeSystem/financialtaskinputtype
input[].valueReferencereference https://payer.pmajy.nha.gov.in/CommunicationRequest/1a857700-c6f3-49e1-b5d1-049…, display Communication

CommunicationRequest​

NRCeS profile: CommunicationRequest.

ElementExample
statuscompleted
category[].coding[]notification Notification in http://terminology.hl7.org/CodeSystem/communication-category
payload[]contentString Required Message for the provider
recipient[]reference https://payer.nha.gov.in/v1/communication/request/organization/provider/1000003…
senderreference https://payer.nha.gov.in/v1/communication/request/organization/payer/1518@hcx

The Organization entries are shaped as in the chapters that introduce them.

The acknowledgement​

Sent on /v1/communication/on_request.

The bundle​

#ResourceProfile
1TaskTask
2CommunicationCommunication
3CommunicationRequestCommunicationRequest
4ClaimClaim
5PatientPatient
6Organization (prov)Organization
7Organization (pay)Organization
8PractitionerPractitioner
9CoverageCoverage

Elements​

Task​

NRCeS profile: Task.

ElementExample
authoredOn2026-03-08T11:01:00+05:30
code.coding[]deliver in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-codes
input[].type.coding[]include in http://terminology.hl7.org/CodeSystem/financialtaskinputtype
input[].valueReferencedisplay Communication, reference urn:uuid:7d9e2a64-3b1f-4f0c-8a5e-6c4b2d9f1e37
intentorder
ownerdisplay Organization, reference https://nhcx.abdm.gov.in/payer
reasonCode.coding[]additionalinfo Additional information request in https://nhcx.abdm.gov.in/communication-reason
requesterdisplay Organization, reference https://nhcx.abdm.gov.in/provider
statuscompleted

Communication​

NRCeS profile: Communication.

ElementExample
about[]display Claim VB26AA2600001, reference https://nhcx.abdm.gov.in/preauth/request
basedOn[]display CommunicationRequest, reference urn:uuid:08f1bb6f-c3f5-4578-b5e8-c042764e2477
category[].coding[]notification in http://terminology.hl7.org/CodeSystem/communication-category
identifier[]value 4524657454
payload[]contentString The angiography report is attached.
payload[].contentAttachmentcontentType application/pdf, title Angiography report
payload[].extension[]url <participant-defined>, valueString DIA
priorityroutine
recipient[]display Organization, reference https://nhcx.abdm.gov.in/payer
senderdisplay Organization, reference https://nhcx.abdm.gov.in/provider
statuscompleted

The CommunicationRequest, Claim, Patient, Organization, Practitioner, Coverage entries are shaped as in the chapters that introduce them.

Rules​

The push pattern​

Task.code poll with an input of type include referencing the resource being delivered, a CommunicationRequest from the payer. intent is order on a request and proposal on a notification. Resolve the reference and read its type.

Switch on the reason​

Task.reasonCode from ndhm-reason-code: tatquery, grievance, walletupdate, policychange, additionalinfo, claimArbitration. Accept the misspelling claimArbitartion on receipt.

Notifications​

A notification carries its reason under the communication-category system, such as information, and a CommunicationRequest with category notification and the message in payload.

Category, priority, topic​

category alert, reminder, notification, instruction or questionnaire; priority routine, urgent, asap or stat; topic progress-update for anything about a live case.

completed is the event​

Task.status and Communication.status read completed when the message is delivered. Do not close a case on them.

The acknowledgement​

A Task coded deliver, completed, whose include input references a Communication with basedOn naming the request. Same correlation id. Take each organisation's role from Organization.type, not from the identifier type.

PMJAY​

The generic bundle above is what every payer takes, IRDAI-regulated insurers and TPAs included. PMJAY takes it with the changes and requirements below.

What changes in the bundle​

PMJAY sends this exchange in the generic shape.

What PMJAY specifies​

  • PMJAY does not use this channel for queries. A PMJAY CommunicationRequest is a notification: a turnaround alert, a grievance, a wallet or policy change, or an arbitration intimation.

What PMJAY requires​

  • Acknowledge within thirty seconds with the same Task bundle and Task.status completed, and leave the case's status alone.

Use cases, APIs and data elements​

C6 Raise a communication (payer)​

A message about a case, typed by its reason code: additionalinfo, tatquery for a turnaround breach, grievance, walletupdate, policychange, claimArbitration. A generic or IRDAI payer raises its document queries here, as a CommunicationRequest task bundle carrying 24, 241 or 27, and takes the answer as a Communication task bundle on on_request echoing the correlation id and workflow id. PMJAY does not use it for queries; its query is the ClaimResponse on the case's own thread.

API/v1/communication/request apis/07-communication/v1-communication-request.bru
Callback/v1/communication/on_request apis/07-communication/v1-communication-on-request.bru
Workflow24, 241, 27 for a generic payer's queries; N02 and the intimation codes for the rest
Carries JWEyes
Focal resourceCommunicationRequest / Task

Request headers

HeaderExample value
x-hcx-sender_code1518@hcx
x-hcx-recipient_code1000004446@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id15
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
24Preauth Request Queriedpayerrequest.initiatedPayer needs more information - respond using workflow 19
241Enhancement Request Queriedpayerrequest.initiatedEnhancement request queried by payer
27Claim Request Queriedpayerrequest.initiated, response.partial/completeFinal claim queried - payer needs additional documents; under PMJAY answer with 161
N02Notifications Intended To Providerstatus sheet onlyrequest.initiated

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
taskReasonQuery ReasonQuerycode1..1Task.reasonCode.coding[0].codeadditionalinfo
queryTextQuery QuestionsQuerystring1..1CommunicationRequest.payload[0].contentStringPlease attach pre-operative ultrasound scan.

NRCeS profiles: CommunicationRequest, Task.

B4 Respond to a communication (provider)​

Acknowledge or answer a message the payer sent about a case. A generic or IRDAI payer raises its query here, as a CommunicationRequest task bundle carrying 24, 241 or 27; the answer is a Communication task bundle on on_request that echoes the request's correlation id and workflow id. The payer's reason code says what kind of message it was.

API/v1/communication/on_request apis/07-communication/v1-communication-on-request.bru
Callback/v1/communication/request apis/07-communication/v1-communication-request.bru
Workflow24, 241 or 27, echoed from the payer's request
Carries JWEyes
Focal resourceCommunication / Task

Request headers

HeaderExample value
x-hcx-sender_code1000004446@hcx
x-hcx-recipient_code1518@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id15
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusresponse.complete
x-hcx-ben-abha-id91711234567890

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
24Preauth Request Queriedpayerrequest.initiatedPayer needs more information - respond using workflow 19
241Enhancement Request Queriedpayerrequest.initiatedEnhancement request queried by payer
27Claim Request Queriedpayerrequest.initiated, response.partial/completeFinal claim queried - payer needs additional documents; under PMJAY answer with 161

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
communicationIdCommunication IdentifierCasestring1..1Communication.identifier[0].valueCOMM-RESP-001
queryRequestIdOriginal Query ReferenceCasereference1..1Communication.basedOn[0].referenceTask/task-comm-req-1
replyTextClarification TextPayloadstring0..1Communication.payload[0].contentStringPlatelet count attached as requested.
attachmentDataAttached Document Base64Payloadbase64Binary0..*Communication.payload[0].contentAttachment.dataJVBERi0xLjQK...

NRCeS profiles: Communication.