Check Patient Eligibility

Endpoint Overview

This API endpoint checks patient eligibility through the Nphies module using customer, patient, and insurance information.

Endpoint Details

• Method: POST
• URL: /api/v1/nphies/eligibility
• Summary: Check patient eligibility
• Authentication: Bearer Token required
• Content-Type: application/json

Parameters

• Path Parameters: None
• Query Parameters: None

Request Body

A JSON request body is required.

{
  "customer": "demo",
  "transfer": true,
  "patientInfo": {
    "id": "string",
    "identifier_type": "string",
    "name": "string",
    "phone": "string",
    "gender": "string",
    "date_of_birth": "string",
    "insurance_info": "string",
    "insurance_id": "string",
    "marital_status": "M",
    "coverage_class": "string",
    "patient_occupation": "string"
  },
  "babyInfo": {
    "birthdate": "string",
    "gender": "M",
    "mrn": "string",
    "name": "string",
    "weight": 3
  }
}

Field Descriptions

Main Fields

• customer (string): Customer identifier.
• transfer (boolean): Transfer flag.
• patientInfo (object): Patient identification and insurance information.
• babyInfo (object): Baby information.

Patient Information (patientInfo)

• id (string): Patient identifier.
• identifier_type (string): Patient identifier type.
• name (string): Patient name.
• phone (string): Patient phone number.
• gender (string): Patient gender.
• date_of_birth (string): Patient date of birth.
• insurance_info (string): Patient insurance information.
• insurance_id (string): Insurance identifier.
• marital_status (string): Patient marital status code.
• coverage_class (string): Insurance coverage class.
• patient_occupation (string): Patient occupation.

Baby Information (babyInfo)

• birthdate (string): Baby date of birth.
• gender (string): Baby gender code.
• mrn (string): Medical record number.
• name (string): Baby name.
• weight (number): Baby weight.

note

The example shows the request structure. Individual field requirements, date formats, supported codes, weight units, and conditions for including babyInfo are not specified in the available API reference.

Response

• 201 Created
• 400 Bad Request: Bad request.
• 401 Unauthorized: Unauthorized.

Response Body

The available API reference does not specify success or error response bodies.

Example

Request

curl

curl -X POST \
  "https://$ACCOUNT_NAME.juleb.com/api/v1/nphies/eligibility" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  --data @eligibility.json

Save the request body above as eligibility.json and replace the example values before sending the request.

NodeJS

const axios = require('axios');
const body = require('./eligibility.json');

const accountName = process.env.ACCOUNT_NAME;
const apiKey = process.env.API_KEY;

axios.post(
  `https://${accountName}.juleb.com/api/v1/nphies/eligibility`,
  body,
  {
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${apiKey}`
    }
  }
)
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error:', error.response?.data || error.message);
});

Save the request body above as eligibility.json and replace the example values before running the example.