Overview
The Telecom Formatter API uses a POST request with a JSON payload to retrieve a payer sheet claim format record from the Payer Sheet Service and provide records that match the specified criteria.
| Attribute | Value |
|---|---|
| Method | POST |
| URL | /v1/standards-based-messaging/services/payer-sheet-service/telecomFormat/fetch |
| Content Type | application/json |
| Description | Retrieves a claim format record that matches the search criteria |
IMPORTANT
All fields are optional. You only need to supply the field(s) required to identify the target claim format.
Request Details
The request body must be wrapped in a getClaimFormatRequest object.
Request Structure
{
"getClaimFormatRequest": {
"code": "string",
"bin": "string",
"iin": "string",
"pcn": "string",
"groupCode": "string",
"rems": "string",
"billingSequence": "string",
"customer": "string",
"sourceSystemId": "string",
"externalMessageId": "string",
"siteCode": "string",
"transactionCode": "string",
"chainID": "string"
}
}
Request Fields
The following is a list of fields and their associated details within the Request.
| Field | Type | Max Length | Allowed Values | Description |
|---|---|---|---|---|
| code | string | 3 | Claim format code | |
| bin | string | 6 | Bank identification number | |
| iin | string | 8 | Issuer identification number | |
| pcn | string | 10 | Processor control number | |
| groupCode | string | 15 | Group code | |
| rems | string | 1 | y, n, Y, N | REMS indicator |
| billingSequence | string | 2 | Billing sequence | |
| customer | string | 128 | Customer name | |
| sourceSystemId | string | 30 | Source system identifier | |
| externalMessageId | string | 30 | External message identifier | |
| siteCode | string | 80 | Site code | |
| transactionCode | string | 2 | “B1”, “B2", “B3”, “C1”, “C2”, “C3”, “D1”, “E1”, “N1”, “N2”, “N3”, “P1”, “P2”, “P3”, “P4”, “S1”, “S2”, “S3” | Transaction code |
| chainID | string | 38 | Chain Identifier |
Request Example
{
"getClaimFormatRequest": {
"bin": "123456",
"pcn": "ABCD1234",
"groupCode": "GRP01"
}
}
Response Details
The response is wrapped in a getClaimFormatResponse object.
Response Structure
{
"getClaimFormatResponse": {
"claimFormat": {
"billingSequence": "string",
"bin": "string",
"chainID": "string",
"code": "string",
"customer": "string",
"description": "string",
"effectiveDate": "string",
"expirationDate": "string",
"externalMessageId": "string",
"groupCode": "string",
"iin": "string",
"pcn": "string",
"rems": "string",
"siteCode": "string",
"sourceSystemId": "string",
"standard": "string",
"transmissions": [
{
"code": "string",
"type": "string",
"standard": "string",
"segments": [
{
"segmentIdentifier": "string",
"usageCode": "string",
"sequence": 0,
"segmentFields": [
{
"fieldIdentifier": "string",
"fieldNumber": "string",
"description": "string",
"fieldDataType": "string",
"fieldDataTypeId": 0,
"maximumLength": 0,
"usageCode": "string",
"includeIfNull": false,
"fieldType": "string",
"mantissaSize": 0,
"sequence": 0,
"customName": "string",
"useIfNull": "string",
"customProcessingCode": "string",
"fieldGroups": [
{
"fieldGroupId": 0,
"groupCode": "string",
"fieldNumber": "string",
"fieldIdentifier": "string",
"maximumCount": "string"
}
],
"segmentFieldQualifiers": [
{
"qualifierCode": "string",
"qualifierDescription": "string",
"sequence": 0
}
]
}
]
}
]
}
]
}
}
}
Response Objects and Fields
The following is a list of objects and associated fields within the Response.
claimFormat Object
claimFormat Object| Field | Type | Max Length | Allowed Values | Description |
|---|---|---|---|---|
| billingSequence | string | 2 | Billing sequence | |
| bin | string | 6 | Bank identification number | |
| chainID | string | 38 | Chain identifier | |
| code | string | 3 | Claim format code | |
| customer | string | 128 | Customer name | |
| description | string | 250 | Description of the claim format | |
| effectiveDate | string | Effective date | ||
| expriationDate | string | Expiration date | ||
| externalMessageId | string | 30 | External message identifier uniquely identifying the request | |
| groupCode | string | 15 | Group code | |
| iin | string | 8 | Issuer identification number | |
| pcn | string | 10 | Processor control number | |
| rems | string | 1 | y, n, Y, N, null | REMS indicator |
| siteCode | string | 80 | Site code - identifies the Switch | |
| sourceSystemId | string | 30 | Source system identifier | |
| standard | string 2 | D0 | Telecom standard | |
| transmissions | array | List of transmissions (see below) |
transmissions Object
transmissions Object| Field | Type | Max Length | Allowed Values | Description |
|---|---|---|---|---|
| code | string | 10 | Transmission code | |
| type | string | 50 | Transmission type | |
| standard | string | 2 | D0, F6 | Telecom standard |
| segments | array | List of segments (see below) |
segments Object
segments Object| Field | Type | Max Length | Description |
|---|---|---|---|
| segmentIdentifier | string | 32 | Segment identifier |
| usageCode | string | 10 | Usage code |
| sequence | integer (int32) | 2 | Sequence numbers |
| segmentFields | array | List of segment fields (see below) |
segmentFields Object
segmentFields Object| Field | Type | Max Length | Description |
|---|---|---|---|
| fieldIdentifier | string | 3 | Field identifier |
| fieldNumber | string | 4 | Field number |
| description | string | 250 | Description |
| fieldDataType | string | 250 | Field data type |
| fieldDataTypeId | integer (int64) | Field data type identifier | |
| maximumLength | integer (int32) | 3 | Maximum allowed length of the field value |
| usageCode | string | 10 | Usage code |
| includeIfNull | boolean | Whether to include this field when value is null | |
| fieldType | string | 1 | Field type |
| mantissaSize | integer (int32) | Mantissa size for numeric fields | |
| sequence | integer (int32) | 2 | Sequence number |
| customName | string | 250 | Custom display name for the field |
| useIfNull | string | 250 | Value to use when the field value is null |
| customProcessingCode | string | 10 | Custom processing code |
| fieldGroups | array | List of field groups (see below) | |
| segmentFieldQualifiers | array | List of segment field qualifiers (see below) |
fieldGroups Object
fieldGroups Object| Field | Type | Max Length | Description |
|---|---|---|---|
| fieldGroupId | integer (int64) | 2 | Field group identifier |
| groupCode | string | Group code | |
| fieldNumber | string | 4 | Field number |
| fieldIdentifier | string | 3 | Field identifier |
| maximumCount | string | 2 | Maximum count |
segmentFieldQualifiers Object
segmentFieldQualifiers Object| Field | Type | Max Length | Description |
|---|---|---|---|
| qualifierCode | string | 10 | Qualifier code |
| qualifierDescription | string | 250 | Qualifier description |
| sequence | integer (int32) | 2 | Sequence numbers |
Request and Response Example
{
"getClaimFormatRequest": {
"bin": "123456",
"pcn": "ABCD1234",
"groupCode": "GRP01",
"rems": "N"
}
}
{
"getClaimFormatResponse": {
"claimFormat": {
"billingSequence": "01",
"bin": "123456",
"chainID": null,
"code": "D01",
"customer": "Customer Pharmacy Name",
"description": "Standard D0 claim format",
"effectiveDate": "2024-01-01",
"expirationDate": "2099-12-31",
"externalMessageId": null,
"groupCode": "GRP01",
"iin": null,
"pcn": "ABCD1234",
"rems": "N",
"siteCode": null,
"sourceSystemId": "SYS01",
"standard": "D0",
"transmissions": [
{
"code": "B1",
"type": "NCPDP",
"standard": "D0",
"segments": [
{
"segmentIdentifier": "AM",
"usageCode": "M",
"sequence": 1,
"segmentFields": [
{
"fieldIdentifier": "AM",
"fieldNumber": "101",
"description": "Version/Release Number",
"fieldDataType": "AN",
"fieldDataTypeId": 1,
"maximumLength": 2,
"usageCode": "M",
"includeIfNull": false,
"fieldType": "A",
"mantissaSize": 0,
"sequence": 1,
"customName": null,
"useIfNull": null,
"customProcessingCode": null,
"fieldGroups": [],
"segmentFieldQualifiers": []
}
]
}
]
}
]
}
}
}