Set ready Service

{
  "id": "id",
  "organizationId": "organizationId",
  "status": "PENDING",
  "createdAt": "2024-01-15T09:30:00Z",
  "serviceType": {
    "id": "id",
    "name": "name",
    "placeOfService": "TELEHEALTH_HOME",
    "providerType": "MD",
    "providerTypes": [
      "MD",
      "MD"
    ],
    "cost": 1,
    "noteFields": [
      "noteFields",
      "noteFields"
    ],
    "conditionalPatientResponsibility": true,
    "selfPayCost": 1
  },
  "dateOfService": "2024-01-15T09:30:00Z",
  "patientId": "patientId",
  "location": {
    "state": "AL",
    "line1": "line1",
    "line2": "line2",
    "city": "city",
    "postalCode": "postalCode",
    "country": "US"
  },
  "serviceEligibility": {
    "id": "id",
    "organizationId": "organizationId",
    "serviceTypeId": "serviceTypeId",
    "dateOfService": "2024-01-15T09:30:00Z",
    "status": "PENDING",
    "providers": [
      {
        "id": "id",
        "name": "name",
        "type": "MD",
        "npi": "npi",
        "externalId": "externalId",
        "providerEligibilityEnabled": true,
        "serviceEligibilityEnabled": true
      },
      {
        "id": "id",
        "name": "name",
        "type": "MD",
        "npi": "npi",
        "externalId": "externalId",
        "providerEligibilityEnabled": true,
        "serviceEligibilityEnabled": true
      }
    ],
    "policyIds": [
      "policyIds",
      "policyIds"
    ],
    "state": "AL",
    "validatedAt": "2024-01-15T09:30:00Z",
    "patientResponsibility": {
      "total": 1,
      "fallback": 1,
      "deductible": 1,
      "coinsurance": 1,
      "coinsurancePercent": 1.1,
      "copayment": 1,
      "oopFallback": 1,
      "oopCopayment": 1,
      "oopCoinsurance": 1,
      "oopDeductible": 1,
      "deductibleType": "INDIVIDUAL"
    },
    "messages": [
      "messages",
      "messages"
    ],
    "clinicalInfo": {
      "diagnoses": [
        "diagnoses",
        "diagnoses"
      ]
    },
    "conditionalPatientResponsibilities": [
      {
        "conditions": [
          {
            "diagnoses": [
              "diagnoses",
              "diagnoses"
            ]
          },
          {
            "diagnoses": [
              "diagnoses",
              "diagnoses"
            ]
          }
        ],
        "limit": {
          "type": "UNKNOWN",
          "value": 1,
          "metric": "VISIT",
          "period": "ANNUAL",
          "units": {
            "minutes": 1,
            "min": 1,
            "max": 1
          }
        },
        "patientResponsibility": {
          "total": 1,
          "fallback": 1,
          "deductible": 1,
          "coinsurance": 1,
          "coinsurancePercent": 1.1,
          "copayment": 1,
          "oopFallback": 1,
          "oopCopayment": 1,
          "oopCoinsurance": 1,
          "oopDeductible": 1,
          "deductibleType": "INDIVIDUAL"
        }
      },
      {
        "conditions": [
          {
            "diagnoses": [
              "diagnoses",
              "diagnoses"
            ]
          },
          {
            "diagnoses": [
              "diagnoses",
              "diagnoses"
            ]
          }
        ],
        "limit": {
          "type": "UNKNOWN",
          "value": 1,
          "metric": "VISIT",
          "period": "ANNUAL",
          "units": {
            "minutes": 1,
            "min": 1,
            "max": 1
          }
        },
        "patientResponsibility": {
          "total": 1,
          "fallback": 1,
          "deductible": 1,
          "coinsurance": 1,
          "coinsurancePercent": 1.1,
          "copayment": 1,
          "oopFallback": 1,
          "oopCopayment": 1,
          "oopCoinsurance": 1,
          "oopDeductible": 1,
          "deductibleType": "INDIVIDUAL"
        }
      }
    ]
  },
  "coverageStatus": "PENDING",
  "provider": {
    "id": "id",
    "name": "name",
    "type": "MD",
    "npi": "npi",
    "externalId": "externalId",
    "providerEligibilityEnabled": true,
    "serviceEligibilityEnabled": true
  },
  "payments": [
    {
      "id": "id",
      "createdAt": "2024-01-15T09:30:00Z",
      "serviceId": "serviceId",
      "paidAt": "2024-01-15T09:30:00Z",
      "transactionId": "transactionId",
      "type": "PATIENT",
      "amount": 1,
      "externalId": "externalId",
      "memo": "memo"
    },
    {
      "id": "id",
      "createdAt": "2024-01-15T09:30:00Z",
      "serviceId": "serviceId",
      "paidAt": "2024-01-15T09:30:00Z",
      "transactionId": "transactionId",
      "type": "PATIENT",
      "amount": 1,
      "externalId": "externalId",
      "memo": "memo"
    }
  ],
  "responsibleParty": "PATIENT",
  "patientResponsibility": {
    "amount": {
      "total": 1,
      "fallback": 1,
      "deductible": 1,
      "coinsurance": 1,
      "coinsurancePercent": 1.1,
      "copayment": 1,
      "oopFallback": 1,
      "oopCopayment": 1,
      "oopCoinsurance": 1,
      "oopDeductible": 1,
      "deductibleType": "INDIVIDUAL"
    },
    "status": "UNKNOWN",
    "paid": 1
  },
  "tasks": [
    {
      "type": "PATIENT_CONSENT",
      "inReviewAt": "2024-01-15T09:30:00Z",
      "ready": true,
      "memo": "memo"
    },
    {
      "type": "PATIENT_CONSENT",
      "inReviewAt": "2024-01-15T09:30:00Z",
      "ready": true,
      "memo": "memo"
    }
  ],
  "externalId": "externalId",
  "noteId": "noteId",
  "claimStatus": "CREATED",
  "priorAuthorizationNumber": "priorAuthorizationNumber",
  "cancellationReason": "NO_SHOW",
  "metadata": {
    "exampleKey": "exampleKey"
  }
}

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idstringRequired

typeenumRequired

Request

This endpoint expects an object.

readybooleanRequired

Response

This endpoint returns an object.

idstring

organizationIdstring

statusenum

createdAtdatetime

serviceTypeobject

dateOfServicedatetime

patientIdstring

locationobject

Location of the Patient at the date of service, requires only the state value for telehealth

serviceEligibilityobject

coverageStatusenum

Allowed values:

providerobject

paymentslist of objects

responsiblePartyenum

Allowed values:

patientResponsibilityobject

taskslist of objects

externalIdstringOptional

noteIdstringOptional

claimStatusenumOptional

Allowed values:

priorAuthorizationNumberstringOptional

cancellationReasonenumOptional

Allowed values:

metadataobjectOptional

Customizable object of string to string key-value data