Request and Response
The following example is brief compared to what can apply in a real-world transaction.
curl --request POST \
--url 'https://sandbox-apigw.optum.com/medicalnetwork/institutionalclaims/v1/[validation|submission]?USERNAME=johnone%20doeone' \
--header 'Authorization: Bearer eyJraWQiOiIxIiwidHlwIjoiSldUIi...' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"controlNumber": "000000001",
"tradingPartnerServiceId": "9496",
"submitter" : {
"organizationName" : "happy doctors group",
"taxId":"12345",
"contactInformation": {
"name": "janetwo doetwo",
"phoneNumber": "123456789",
"email": "[email protected]",
"faxNumber": "123456789"
}
},
"receiver": {
"organizationName": "EXTRA HEALTHY INSURANCE",
"taxId":"67890"
},
"subscriber" : {
"memberId": "0000000001",
"paymentResponsibilityLevelCode": "P",
"firstName": "johnOne",
"lastName": "doeOne",
"gender": "M",
"dateOfBirth": "19800101",
"address": {
"address1": "123 address1",
"city": "city1",
"state": "wa",
"postalCode": "981010000"
}
},
"providers": [{
"providerType": "BillingProvider",
"npi": "1760854442",
"employerId": "123456789",
"organizationName": "HAPPY DOCTORS GROUPPRACTICE",
"address": {
"address1": "123 address1",
"city": "city1",
"state": "wa",
"postalCode": "981010000"
}
}],
"claimInformation" : {
"claimFilingCode": "CI",
"patientControlNumber": "12345",
"claimChargeAmount": "3.75",
"placeOfServiceCode": "11",
"claimFrequencyCode": "1",
"signatureIndicator": "Y",
"planParticipationCode": "A",
"releaseInformationCode": "Y",
"benefitsAssignmentCertificationIndicator": "Y",
"billingNote":"ADD",
"claimDateInformation": {
"statementBeginDate": "20041209",
"statementEndDate": "20041214",
"dischargeHour":"1130",
"admissionDateAndHour": "200410131242"
},
"claimCodeInformation": {
"admissionTypeCode": "1",
"patientStatusCode": "10",
"admissionSourceCode": "7"
},
"serviceLines":[{
"assignedNumber": "1",
"institutionalService": {
"serviceLineRevenueCode": "1",
"lineItemChargeAmount": "72.50",
"measurementUnit": "UN",
"serviceUnitCount": "1"
}
}],
"principalDiagnosis": {
"qualifierCode": "BK",
"principalDiagnosisCode": "99761",
"presentOnAdmissionIndicator": "Y"
},
"admittingDiagnosis":{"qualifierCode": "BJ",
"admittingDiagnosisCode": "99762"
},
"otherSubscriberInformation": {
"paymentResponsibilityLevelCode": "A",
"individualRelationshipCode": "19",
"benefitsAssignmentCertificationIndicator": "Y",
"claimFilingIndicatorCode": "11",
"releaseOfInformationCode": "Y",
"otherPayerName":{
"otherPayerOrganizationName": "ABC Insurance Co",
"otherPayerIdentifierTypeCode": "PI",
"otherPayerIdentifier": "11122333"
},
"otherSubscriberName": {
"otherInsuredQualifier": "1",
"otherInsuredLastName": "DOE",
"otherInsuredIdentifierTypeCode": "MI",
"otherInsuredIdentifier": "123456"
}
}
}
}
In its header section, the request body supports use of either the tradingPartnerServiceId or the serviceId as the required payer identification.
{
"status": "SUCCESS",
"controlNumber": "000000001",
"tradingPartnerServiceId": "9496",
"claimReference": {
"correlationId": "200715R999898~18620063139417176",
"submitterId": "12345",
"customerClaimNumber": "000000001",
"patientControlNumber": "12345",
"timeOfResponse": "2020-07-15T12:44:17.994-05:00",
"formatVersion": "5010",
"claimType": "INS"
},
"meta": {
"submitterId": "999898",
"senderId": "IN_APIP_MN_CHC_TestApp2",
"billerId": "009998",
"traceId": "3c4cf9c8-a5db-42ff-56e4-fda689a43d29",
"applicationMode": "sandbox"
},
"editStatus": "SUCCESS",
"payer": {
"payerName": "EXTRA HEALTHY INSURANCE",
"payerID": "9496"
}
}
The submitter object describes the information for the medical institution submitting the transaction. The core claimInformation object follows the provider information. It contains the insurance coding for the claim.
The primary elements of a medical claims submission response consist of the aforementioned meta object and a claimReference object. It contains a number of tracking values.
The first response you get back from the clearinghouse does not indicate that the claim is being paid; it indicates that the clearinghouse has accepted the claim, and is getting ready to forward it to the payer.
| Institutional Claims API Response Example | Description |
|---|---|
json { "status": "SUCCESS", "controlNumber": "000000001", "tradingPartnerServiceId": "9496", "claimReference": { "correlationId": "210322R999898~66684261175841", "submitterId": "009998", "customerClaimNumber": "000000001", "patientControlNumber": "12345", "timeOfResponse": "2021-03-22T19:34:08.85-05:00", "claimType": "PRO", "formatVersion": "5010", "rhclaimNumber": "2108151508527" }, "meta": { "submitterId": "999898", "senderId": "Xxxx.Xxxxxx", "billerId": "009998", "traceId": "900773a9-c0ba-6aa2-0f61-cfcc30a0200f", "applicationMode": "pro" }, "editStatus": "SUCCESS", "payer": { "payerName": "Unknown", "payerID": "9496" }, | claimReference is the response's main object. Key values are:
|
RAW-X12-Validation/Submission endpoints
curl --request POST \
--url 'https://sandbox-apigw.optum.com/medicalnetwork/institutionalclaims/v1/[raw-x12-validation|raw-x12-submission]?USERNAME=johnone%20doeone' \
--header 'Authorization: Bearer eyJraWQiOiIxIiwidHlwIjoiSldUIi...' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{"x12": "ISA*00* *01*CYCTRANS *ZZ*009998999898 *ZZ*CLAIMSCH *200723*1401*|*00501*000000001*0*T*:~GS*HC*009998999898*1465*20200723*1401*000000001*X*005010X223A3~ST*837*000000001*005010X223A3~BHT*0019*00*000000001*20200723*1401*CH~NM1*41*2*happy doctors group*****46*009998999898~PER*IC*janetwo doetwo*EM*[email protected]~NM1*40*2*EXTRA HEALTHY INSURANCE*****46*CLAIMSCH~HL*1**20*1~NM1*85*2*HAPPY DOCTORS GROUPPRACTICE*****XX*1760854442~N3*123 address1~N4*city1*wa*981010000~REF*EI*123456789~HL*2*1*22*0~SBR*P*18*******CI~NM1*IL*1*doeOne*johnOne****MI*0000000001~N3*123 address1~N4*city1*wa*981010000~DMG*D8*19800101*M~NM1*PR*2*EXTRA HEALTHY INSURANCE*****PI*9496~CLM*12345*3.75***11:A:1**A*Y*Y~DTP*096*TM*1130~DTP*434*RD8*20041209-20041214~DTP*435*DT*200410131242~CL1*1*7*10~NTE*ADD*ADD~HI*BK:99761:::::::Y~HI*BJ:99762~SBR*A*19*******11~OI***Y***Y~NM1*IL*1*DOE*****MI*123456~NM1*PR*2*ABC Insurance Co*****PI*11122333~LX*1~SV2*1**72.50*UN*1~SE*32*000000001~GE*1*000000001~IEA*1*000000001~"}
{
"status": "SUCCESS",
"controlNumber": "0X223A3~BHT*00",
"tradingPartnerServiceId": "9496",
"claimReference": {
"correlationId": "200715R999898~18620063139417176",
"submitterId": "12345",
"customerClaimNumber": "000000001",
"patientControlNumber": "12345",
"timeOfResponse": "2020-07-15T12:44:17.994-05:00",
"formatVersion": "5010",
"claimType": "INS"
},
"meta": {
"submitterId": "999898",
"senderId": "APIM_Marketplace_SBX_Native_ExrHHlUnWaTxwjVs",
"billerId": "009998",
"traceId": "6e2c003c-3459-70ee-bcbe-01a8b5c91edf",
"applicationMode": "sandbox"
},
"editStatus": "SUCCESS",
"payer": {
"payerName": "EXTRA HEALTHY INSURANCE",
"payerID": "9496"
}
}
NOTE
We recommend using the Validation API before sending the claim request to the payer. The Validation rules help prevent claims with incorrect information from being sent to the payer, such as a typo in the NPI, errors in calculations, or poor formatting and syntax in the claim. You can use the
/institutionalclaims/v1/healthcheckendpoint to check the operating status of the service endpoint before sending the claim.
Updated 2 days ago