GET api/NE/HealthPlans
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of HealthPlan| Name | Description | Type | Additional information |
|---|---|---|---|
| AAFactor | byte |
None. |
|
| Abbreviation | string |
None. |
|
| Code | string |
None. |
|
| CreatedBy | integer |
None. |
|
| CreatedDate | date |
None. |
|
| EndDate | date |
None. |
|
| HealthPlanAdministratorId | byte |
None. |
|
| HealthPlanId | integer |
None. |
|
| IsAAAllowed | boolean |
None. |
|
| IsActive | boolean |
None. |
|
| IsReinstatementAllowed | boolean |
None. |
|
| IsVoluntaryAllowed | boolean |
None. |
|
| ModifiedBy | integer |
None. |
|
| ModifiedDate | date |
None. |
|
| Name | string |
None. |
|
| PhoneNumber | string |
None. |
|
| RegionId | integer |
None. |
|
| StartDate | date |
None. |
|
| HealthPlanProviders | Collection of HealthPlanProvider |
None. |
|
| RetroEnrollments | Collection of RetroEnrollment |
None. |
|
| HealthPlanAdministrator | HealthPlanAdministrator |
None. |
|
| Region | Region |
None. |
|
| CreatedByUser | User |
None. |
|
| ModifiedByUser | User |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"$type": "NE.Entities.Server.PROV.HealthPlan, NE.Entities.Server",
"AAFactor": 64,
"Abbreviation": "sample string 2",
"Code": "sample string 3",
"CreatedBy": 4,
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"EndDate": "2024-11-21T10:02:46.029+00:00",
"HealthPlanAdministratorId": 64,
"HealthPlanId": 7,
"IsAAAllowed": true,
"IsActive": true,
"IsReinstatementAllowed": true,
"IsVoluntaryAllowed": true,
"ModifiedBy": 1,
"ModifiedDate": "2024-11-21T10:02:46.029+00:00",
"Name": "sample string 11",
"PhoneNumber": "sample string 12",
"RegionId": 13,
"StartDate": "2024-11-21T10:02:46.029+00:00",
"HealthPlanProviders": [
{
"$id": "2",
"$type": "NE.Entities.Server.PROV.HealthPlanProvider, NE.Entities.Server",
"AcceptsCurrentPatientsOnly": true,
"AgeLimitHigh": 64,
"AgeLimitLow": 64,
"CreatedBy": 2,
"CreatedDataOriginId": 1,
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"FaxNumber": "sample string 4",
"GenderId": 1,
"HasChildCareServices": true,
"HasCriminalConviction": true,
"HasEveningHours": true,
"HasNewbornServices": true,
"HasOBGYNServices": true,
"HasOwnershipControlInterest": true,
"HasPediatricServices": true,
"HasPhysicianAssistants": true,
"HasWeekendHours": true,
"HealthPlanId": 14,
"HealthPlanProviderId": 15,
"IsActive": true,
"IsExcludedIndividual_GSA": true,
"IsExcludedIndividual_OIG": true,
"IsHandicapAccessible": true,
"IsMaxPanelSizeProviderBased": true,
"IsOfficeNearBusRoute": true,
"IsPCP": true,
"MaxPanelSize": 1,
"ModifiedBy": 1,
"ModifiedDataOriginId": 1,
"ModifiedDate": "2024-11-21T10:02:46.029+00:00",
"OtherLanguages": "sample string 23",
"PhoneNumber": "sample string 24",
"PMFId": 1,
"ServiceEndDate": "2024-11-21T10:02:46.029+00:00",
"ServiceStartDate": "2024-11-21T10:02:46.029+00:00",
"SpeaksOtherLanguages": true,
"SuspensionEndDate": "2024-11-21T10:02:46.029+00:00",
"VendorNumber": "sample string 26",
"ProviderProfiles": [
{
"$id": "3",
"$type": "NE.Entities.Server.PROV.ProviderProfile, NE.Entities.Server",
"HealthPlanProviderId": 1,
"MedicaidNumber": "sample string 2"
},
{
"$ref": "3"
}
],
"CreatedDataOrigin": {
"$id": "4",
"$type": "NE.Entities.Server.dbo.DataOrigin, NE.Entities.Server",
"DataOriginId": 1,
"Description": "sample string 2",
"ShowOnWeb": true
},
"ModifiedDataOrigin": {
"$ref": "4"
},
"Gender": {
"$id": "5",
"$type": "NE.Entities.Server.dbo.Gender, NE.Entities.Server",
"Code": "sample string 1",
"Description": "sample string 2",
"GenderId": 3
},
"HealthPlan": {
"$ref": "1"
},
"PMF": {
"$id": "6",
"$type": "NE.Entities.Server.PROV.PMF, NE.Entities.Server",
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"City": "sample string 3",
"CountyId": 1,
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"DeceasedDate": "2024-11-21T10:02:46.029+00:00",
"GroupBeginDate": "2024-11-21T10:02:46.029+00:00",
"GroupEndDate": "2024-11-21T10:02:46.029+00:00",
"GroupNumber": "sample string 5",
"HospitalAffiliationTypeId": 64,
"IsAtypicalProvider": true,
"IsPOAExempt": true,
"IsUnderReview": true,
"LicenseNumber": "sample string 9",
"LicenseNumberExpanded": "sample string 10",
"MedicaidNumber": "sample string 11",
"ModifiedDate": "2024-11-21T10:02:46.029+00:00",
"Name": "sample string 12",
"PayeeAddressLine1": "sample string 13",
"PayeeAddressLine2": "sample string 14",
"PayeeCity": "sample string 15",
"PayeeMedicaidNumber": "sample string 16",
"PayeeName": "sample string 17",
"PayeeStateId": 1,
"PayeeZip": "sample string 18",
"PayeeZip4": "sample string 19",
"PharmacyDispensingFee": 1.1,
"PharmacyDispensingFeeBeginDate": "2024-11-21T10:02:46.029+00:00",
"PharmacyDispensingFeeEndDate": "2024-11-21T10:02:46.029+00:00",
"PharmacyEncounterRate": 1.1,
"PharmacyNCPDPBeginDate": "2024-11-21T10:02:46.029+00:00",
"PharmacyNCPDPEndDate": "2024-11-21T10:02:46.029+00:00",
"PharmacyNCPDPNumber": "sample string 20",
"PMFId": 21,
"PracticeTypeId": 64,
"ProviderEnrollDate": "2024-11-21T10:02:46.029+00:00",
"ProviderEnrollStatusId": 64,
"ProviderTypeId": 64,
"SSN": "sample string 22",
"StateId": 1,
"Title": "sample string 23",
"Zip": "sample string 24",
"Zip4": "sample string 25",
"HealthPlanProviders": [
{
"$ref": "2"
},
{
"$ref": "2"
}
],
"PMFEligibilitys": [
{
"$id": "7",
"$type": "NE.Entities.Server.PROV.PMFEligibility, NE.Entities.Server",
"BeginDate": "2024-11-21T10:02:46.029+00:00",
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"EndDate": "2024-11-21T10:02:46.029+00:00",
"IsAutoEnded": true,
"ModifiedDate": "2024-11-21T10:02:46.029+00:00",
"PMFEligibilityId": 3,
"PMFId": 4,
"PMF": {
"$ref": "6"
}
},
{
"$ref": "7"
}
],
"PMFNPIs": [
{
"$id": "8",
"$type": "NE.Entities.Server.PROV.PMFNPI, NE.Entities.Server",
"BeginDate": "2024-11-21T10:02:46.029+00:00",
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"EndDate": "2024-11-21T10:02:46.029+00:00",
"IsAutoEnded": true,
"ModifiedDate": "2024-11-21T10:02:46.029+00:00",
"NPINumber": "sample string 3",
"PMFId": 4,
"PMFNPIId": 5,
"PMF": {
"$ref": "6"
}
},
{
"$ref": "8"
}
],
"PMFNPIPayees": [
{
"$id": "9",
"$type": "NE.Entities.Server.PROV.PMFNPIPayee, NE.Entities.Server",
"BeginDate": "2024-11-21T10:02:46.029+00:00",
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"EndDate": "2024-11-21T10:02:46.029+00:00",
"IsAutoEnded": true,
"ModifiedDate": "2024-11-21T10:02:46.029+00:00",
"NPINumber": "sample string 3",
"PMFId": 4,
"PMFNPIPayeeId": 5,
"TaxonomyCode": "sample string 6",
"PMF": {
"$ref": "6"
}
},
{
"$ref": "9"
}
],
"PMFSpecialties": [
{
"$id": "10",
"$type": "NE.Entities.Server.PROV.PMFSpecialty, NE.Entities.Server",
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"IsPrimary": true,
"PMFId": 3,
"PMFSpecialtyId": 4,
"SpecialtyId": 64,
"PMF": {
"$ref": "6"
},
"Specialty": {
"$id": "11",
"$type": "NE.Entities.Server.PROV.Specialty, NE.Entities.Server",
"Code": "sample string 1",
"Description": "sample string 2",
"SpecialtyId": 64
}
},
{
"$ref": "10"
}
],
"County": {
"$id": "12",
"$type": "AHS.Server.Entities.County, AHS.Server",
"CountyId": 1,
"Name": "sample string 2",
"RegionId": 1,
"Code": "sample string 3",
"Region": {
"$id": "13",
"$type": "AHS.Server.Entities.Region, AHS.Server",
"RegionId": 1,
"Name": "sample string 2",
"Counties": [
{
"$ref": "12"
},
{
"$ref": "12"
}
]
}
},
"HospitalAffiliationType": {
"$id": "14",
"$type": "NE.Entities.Server.PROV.HospitalAffiliationType, NE.Entities.Server",
"Code": "sample string 1",
"Description": "sample string 2",
"HospitalAffiliationTypeId": 64
},
"PracticeType": {
"$id": "15",
"$type": "NE.Entities.Server.PROV.PracticeType, NE.Entities.Server",
"Code": "sample string 1",
"Description": "sample string 2",
"PracticeTypeId": 64
},
"ProverEnrollStatus": {
"$id": "16",
"$type": "NE.Entities.Server.PROV.ProviderEnrollStatus, NE.Entities.Server",
"Code": "sample string 1",
"Description": "sample string 2",
"ProviderEnrollStatusId": 64
},
"ProverType": {
"$id": "17",
"$type": "NE.Entities.Server.PROV.ProviderType, NE.Entities.Server",
"Code": "sample string 1",
"Description": "sample string 2",
"IsPCP": true,
"ProviderTypeId": 64,
"Alias": "sample string 5"
},
"State": {
"$id": "18",
"$type": "AHS.Server.Entities.State, AHS.Server",
"StateId": 1,
"Name": "sample string 2",
"Abbreviation": "sample string 3"
},
"PayeeState": {
"$ref": "18"
}
},
"CreatedByUser": {
"$id": "19",
"$type": "AHS.Server.Entities.User, AHS.Server",
"UserId": 1,
"Username": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"IsActive": true,
"IsSystem": true,
"IsADBased": true,
"BusinessUnitId": 9,
"PermissionIds": [
1,
2
],
"FullName": "sample string 3 sample string 4",
"BusinessUnit": {
"$id": "20",
"$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
"BusinessUnitId": 1,
"Description": "sample string 2",
"IsAHS": true
}
},
"ModifiedByUser": {
"$ref": "19"
}
},
{
"$ref": "2"
}
],
"RetroEnrollments": [
{
"$id": "21",
"$type": "NE.Entities.Server.ENROLL.RetroEnrollment, NE.Entities.Server",
"BeginDate": "2024-11-21T10:02:46.029+00:00",
"CreatedBy": 2,
"CreatedDate": "2024-11-21T10:02:46.029+00:00",
"EndDate": "2024-11-21T10:02:46.029+00:00",
"HealthPlanAdministratorId": 64,
"HealthPlanId": 6,
"ModifiedBy": 1,
"ModifiedDate": "2024-11-21T10:02:46.029+00:00",
"PersonId": 7,
"RetroEnrollmentId": 8,
"HealthPlan": {
"$ref": "1"
},
"HealthPlanAdministrator": {
"$id": "22",
"$type": "NE.Entities.Server.PROV.HealthPlanAdministrator, NE.Entities.Server",
"Code": "sample string 1",
"FTPFolder": "sample string 2",
"HealthPlanAdministratorId": 64,
"IsAvailableInEnrollmentWizard": true,
"IsAvailableInIVR": true,
"LastUsedAsFirstIVRChoice": "2024-11-21T10:02:46.029+00:00",
"Name": "sample string 6",
"ShortName": "sample string 7",
"Abbreviation": "sample string 8",
"RestrictedEnrollmentPeriods": "sample string 9",
"HealthPlans": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"RetroEnrollments": [
{
"$ref": "21"
},
{
"$ref": "21"
}
]
}
},
{
"$ref": "21"
}
],
"HealthPlanAdministrator": {
"$ref": "22"
},
"Region": {
"$ref": "13"
},
"CreatedByUser": {
"$ref": "19"
},
"ModifiedByUser": {
"$ref": "19"
}
},
{
"$ref": "1"
}
]