GET api/v1/{EMRSystem}/Population/EncounterInsurances

Returns all encounter insurance activity for all patients for a given date range and optionally filtered by a list of locations (facilities).

Status: Released

URI Parameters

NameDescriptionTypeAdditional information
EMRSystem

The emr system.

EMRSystem

None.

LocationList

Gets or sets the location list.

string

None.

IncludeCustomFields

Gets or sets a value of the getting the custom fields

boolean

None.

UserId

Identifier of the user initiating the request.

string

Required

FromDateTime

Gets or sets from date time.

datetime

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Gets or sets to date time.

datetime

None.

Header Parameters

NameDescriptionTypeAdditional information
LoginId

Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.

string

Data type: Password

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.

string

None.

ApplicationName

Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if using application keys

ApplicationKey

Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.

string

Data type: Password

Required if using application keys

AuthorizationToken

Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.

string

None.

RequestVerboseLogging

Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.

boolean

None.

Response Information

Collection of UdmPopulationEncounterInsurancesResponse
NameDescriptionTypeAdditional information
CreatedUpdatedDateTime

Gets or sets the created/updated date time.

datetime

None.

Patient

Gets or sets the patient.

BasePatient

None.

Encounter

Gets or sets the encounter.

PopulationEncounterInsurancesEncounter

None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.

Response Formats

application/json

[
  {
    "CreatedUpdatedDateTime": "2025-12-12T20:52:59.0719426+00:00",
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "2025-12-12T20:52:59.0790558+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T20:52:59.0790676+00:00"
    },
    "Encounter": {
      "EncounterDateTime": "2025-12-12T20:52:59.0792291+00:00",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsurancePlans": [
        {
          "MemberId": "sample string 1",
          "PlanName": "sample string 2",
          "PlanDesc": "sample string 3",
          "GroupNumber": "sample string 4",
          "PayorName": "sample string 5",
          "PayorPhone": "sample string 6",
          "PayorState": "sample string 7",
          "PatientRelationToSubscriber": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberRelationToPatient": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberFirstName": "sample string 8",
          "SubscriberLastName": "sample string 9",
          "SubscriberBirthDate": "2025-12-12T20:52:59.0896622+00:00",
          "SubscriberAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "SubscriberPhones": [
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "Priority": "sample string 10",
          "EffectiveFromDate": "2025-12-12T20:52:59.0942087+00:00",
          "EffectiveToDate": "2025-12-12T20:52:59.0943466+00:00",
          "InsuranceClass": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsurancePlanAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "CustomFields": [
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ],
          "InsuranceId": "sample string 11",
          "HealthPlanId": "sample string 12",
          "SubscriberId": "sample string 13",
          "SubscriberMemberNumber": "sample string 14",
          "GroupName": "sample string 15",
          "IsActive": true,
          "ActiveStatusId": "sample string 17",
          "ActiveStatus": "sample string 18",
          "ActiveStatusPersonnelId": "sample string 19",
          "ActiveStatusDateTime": "2025-12-12T20:52:59.1008082+00:00",
          "DataStatusId": "sample string 20",
          "DataStatus": "sample string 21",
          "DataStatusPersonnelId": "sample string 22",
          "DataStatusDateTime": "2025-12-12T20:52:59.1075761+00:00",
          "InsuranceCardCopied": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "EligibilityStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceCardNameFirst": "sample string 23",
          "InsuranceCardNameMiddle": "sample string 24",
          "InsuranceCardNameLast": "sample string 25",
          "InsuranceCardName": "sample string 26",
          "VerificationStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationSource": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationPersonnelId": "sample string 27",
          "VerificationDateTime": "2025-12-12T20:52:59.1126125+00:00",
          "AssignmentOfBenefits": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "DeductibleAmount": "sample string 28",
          "DeductibleRemaining": "sample string 29",
          "DeductibleIncludingMaxOutOfPocket": "sample string 30",
          "CopayAmount": "sample string 31",
          "CopayIncludingMaxOutOfPocket": "sample string 32",
          "MaxOutOfPocket": "sample string 33",
          "FamilyDeductibleMetAmount": "sample string 34"
        },
        {
          "MemberId": "sample string 1",
          "PlanName": "sample string 2",
          "PlanDesc": "sample string 3",
          "GroupNumber": "sample string 4",
          "PayorName": "sample string 5",
          "PayorPhone": "sample string 6",
          "PayorState": "sample string 7",
          "PatientRelationToSubscriber": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberRelationToPatient": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberFirstName": "sample string 8",
          "SubscriberLastName": "sample string 9",
          "SubscriberBirthDate": "2025-12-12T20:52:59.0896622+00:00",
          "SubscriberAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "SubscriberPhones": [
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "Priority": "sample string 10",
          "EffectiveFromDate": "2025-12-12T20:52:59.0942087+00:00",
          "EffectiveToDate": "2025-12-12T20:52:59.0943466+00:00",
          "InsuranceClass": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsurancePlanAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "CustomFields": [
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ],
          "InsuranceId": "sample string 11",
          "HealthPlanId": "sample string 12",
          "SubscriberId": "sample string 13",
          "SubscriberMemberNumber": "sample string 14",
          "GroupName": "sample string 15",
          "IsActive": true,
          "ActiveStatusId": "sample string 17",
          "ActiveStatus": "sample string 18",
          "ActiveStatusPersonnelId": "sample string 19",
          "ActiveStatusDateTime": "2025-12-12T20:52:59.1008082+00:00",
          "DataStatusId": "sample string 20",
          "DataStatus": "sample string 21",
          "DataStatusPersonnelId": "sample string 22",
          "DataStatusDateTime": "2025-12-12T20:52:59.1075761+00:00",
          "InsuranceCardCopied": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "EligibilityStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceCardNameFirst": "sample string 23",
          "InsuranceCardNameMiddle": "sample string 24",
          "InsuranceCardNameLast": "sample string 25",
          "InsuranceCardName": "sample string 26",
          "VerificationStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationSource": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationPersonnelId": "sample string 27",
          "VerificationDateTime": "2025-12-12T20:52:59.1126125+00:00",
          "AssignmentOfBenefits": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "DeductibleAmount": "sample string 28",
          "DeductibleRemaining": "sample string 29",
          "DeductibleIncludingMaxOutOfPocket": "sample string 30",
          "CopayAmount": "sample string 31",
          "CopayIncludingMaxOutOfPocket": "sample string 32",
          "MaxOutOfPocket": "sample string 33",
          "FamilyDeductibleMetAmount": "sample string 34"
        }
      ],
      "CustomFields": [
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DischargeDateTime": "2025-12-12T20:52:59.1245917+00:00",
      "FinancialNumber": "sample string 2"
    }
  },
  {
    "CreatedUpdatedDateTime": "2025-12-12T20:52:59.0719426+00:00",
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "2025-12-12T20:52:59.0790558+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T20:52:59.0790676+00:00"
    },
    "Encounter": {
      "EncounterDateTime": "2025-12-12T20:52:59.0792291+00:00",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsurancePlans": [
        {
          "MemberId": "sample string 1",
          "PlanName": "sample string 2",
          "PlanDesc": "sample string 3",
          "GroupNumber": "sample string 4",
          "PayorName": "sample string 5",
          "PayorPhone": "sample string 6",
          "PayorState": "sample string 7",
          "PatientRelationToSubscriber": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberRelationToPatient": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberFirstName": "sample string 8",
          "SubscriberLastName": "sample string 9",
          "SubscriberBirthDate": "2025-12-12T20:52:59.0896622+00:00",
          "SubscriberAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "SubscriberPhones": [
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "Priority": "sample string 10",
          "EffectiveFromDate": "2025-12-12T20:52:59.0942087+00:00",
          "EffectiveToDate": "2025-12-12T20:52:59.0943466+00:00",
          "InsuranceClass": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsurancePlanAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "CustomFields": [
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ],
          "InsuranceId": "sample string 11",
          "HealthPlanId": "sample string 12",
          "SubscriberId": "sample string 13",
          "SubscriberMemberNumber": "sample string 14",
          "GroupName": "sample string 15",
          "IsActive": true,
          "ActiveStatusId": "sample string 17",
          "ActiveStatus": "sample string 18",
          "ActiveStatusPersonnelId": "sample string 19",
          "ActiveStatusDateTime": "2025-12-12T20:52:59.1008082+00:00",
          "DataStatusId": "sample string 20",
          "DataStatus": "sample string 21",
          "DataStatusPersonnelId": "sample string 22",
          "DataStatusDateTime": "2025-12-12T20:52:59.1075761+00:00",
          "InsuranceCardCopied": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "EligibilityStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceCardNameFirst": "sample string 23",
          "InsuranceCardNameMiddle": "sample string 24",
          "InsuranceCardNameLast": "sample string 25",
          "InsuranceCardName": "sample string 26",
          "VerificationStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationSource": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationPersonnelId": "sample string 27",
          "VerificationDateTime": "2025-12-12T20:52:59.1126125+00:00",
          "AssignmentOfBenefits": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "DeductibleAmount": "sample string 28",
          "DeductibleRemaining": "sample string 29",
          "DeductibleIncludingMaxOutOfPocket": "sample string 30",
          "CopayAmount": "sample string 31",
          "CopayIncludingMaxOutOfPocket": "sample string 32",
          "MaxOutOfPocket": "sample string 33",
          "FamilyDeductibleMetAmount": "sample string 34"
        },
        {
          "MemberId": "sample string 1",
          "PlanName": "sample string 2",
          "PlanDesc": "sample string 3",
          "GroupNumber": "sample string 4",
          "PayorName": "sample string 5",
          "PayorPhone": "sample string 6",
          "PayorState": "sample string 7",
          "PatientRelationToSubscriber": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberRelationToPatient": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SubscriberFirstName": "sample string 8",
          "SubscriberLastName": "sample string 9",
          "SubscriberBirthDate": "2025-12-12T20:52:59.0896622+00:00",
          "SubscriberAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "SubscriberPhones": [
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "PhoneId": "sample string 1",
              "Number": "sample string 2",
              "SequenceNumber": "sample string 3",
              "Type": "sample string 4",
              "TypeId": "sample string 5",
              "Extension": "sample string 6",
              "EndEffectiveDateTime": "2025-12-12T20:52:59.0913739+00:00",
              "Format": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "Priority": "sample string 10",
          "EffectiveFromDate": "2025-12-12T20:52:59.0942087+00:00",
          "EffectiveToDate": "2025-12-12T20:52:59.0943466+00:00",
          "InsuranceClass": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsurancePlanAddress": {
            "AddressId": "sample string 1",
            "Address1": "sample string 2",
            "Address2": "sample string 3",
            "Address3": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "ZIP": "sample string 7",
            "Type": "sample string 8",
            "TypeId": "sample string 9",
            "SequenceNumber": "sample string 10",
            "Country": "sample string 11",
            "County": "sample string 12",
            "EndEffectiveDateTime": "2025-12-12T20:52:59.0912583+00:00"
          },
          "CustomFields": [
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Field": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              },
              "CodedResponseValue": [
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                },
                {
                  "Id": "sample string 1",
                  "Name": "sample string 2"
                }
              ],
              "TextResponseValue": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ],
          "InsuranceId": "sample string 11",
          "HealthPlanId": "sample string 12",
          "SubscriberId": "sample string 13",
          "SubscriberMemberNumber": "sample string 14",
          "GroupName": "sample string 15",
          "IsActive": true,
          "ActiveStatusId": "sample string 17",
          "ActiveStatus": "sample string 18",
          "ActiveStatusPersonnelId": "sample string 19",
          "ActiveStatusDateTime": "2025-12-12T20:52:59.1008082+00:00",
          "DataStatusId": "sample string 20",
          "DataStatus": "sample string 21",
          "DataStatusPersonnelId": "sample string 22",
          "DataStatusDateTime": "2025-12-12T20:52:59.1075761+00:00",
          "InsuranceCardCopied": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "EligibilityStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "InsuranceCardNameFirst": "sample string 23",
          "InsuranceCardNameMiddle": "sample string 24",
          "InsuranceCardNameLast": "sample string 25",
          "InsuranceCardName": "sample string 26",
          "VerificationStatus": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationSource": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "VerificationPersonnelId": "sample string 27",
          "VerificationDateTime": "2025-12-12T20:52:59.1126125+00:00",
          "AssignmentOfBenefits": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "DeductibleAmount": "sample string 28",
          "DeductibleRemaining": "sample string 29",
          "DeductibleIncludingMaxOutOfPocket": "sample string 30",
          "CopayAmount": "sample string 31",
          "CopayIncludingMaxOutOfPocket": "sample string 32",
          "MaxOutOfPocket": "sample string 33",
          "FamilyDeductibleMetAmount": "sample string 34"
        }
      ],
      "CustomFields": [
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DischargeDateTime": "2025-12-12T20:52:59.1245917+00:00",
      "FinancialNumber": "sample string 2"
    }
  }
]

'

GET api/v1/{EMRSystem}/Population/EncounterInsurances

Returns all encounter insurance activity for all patients for a given date range and optionally filtered by a list of locations (facilities).

Status: Released

URI Parameters


Required
Required if EMRSystem = Cerner, or Epic, or Meditech

Header Parameters

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Required if using application keys
Data type: Password , Required if using application keys

Request: {{ method }} {{ url }}

  • Http Request Headers
  • {{header.name}} : {{header.value}} ******
  • Http Request Body
  • {{httpRequestBody}}
  • Http Response Headers
  • {{header.name}} : {{header.value}} ******
  • Http Response Data
  • {{httpResponseData}}