GET api/v1/{EMRSystem}/Population/References/HealthPlans

Returns updated Location Reference values based on date range and reference system filters.

Status: Beta

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	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

Name	Description	Type	Additional 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 UdmPopulationReferencesHealthPlansResponse

Name	Description	Type	Additional information
HealthPlanId	Gets or sets the health plan identifier.	string	None.
Name	Gets or sets the health plan name.	string	None.
Description	Gets or sets the health plan description.	string	None.
PlanType	Gets or sets the health plan type.	CodedObject	None.
FinancialClass	Gets or sets the health plan financial class.	CodedObject	None.
BeginEffectiveDateTime	Gets or sets the Begin Effective DateTime	datetime	None.
EndEffectiveDateTime	Gets or sets the End Effective DateTime	datetime	None.
CreatedUpdatedDateTime	Gets or sets the Created Updated DateTime	datetime	None.
IsActive	Gets or sets the active indicator.	boolean	None.
Addresses	Gets or sets the addresses.	Collection of Address	None.
Phones	Gets or sets the phones.	Collection of Phone	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

[
  {
    "HealthPlanId": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "PlanType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "FinancialClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BeginEffectiveDateTime": "2025-12-12T20:53:13.7245845+00:00",
    "EndEffectiveDateTime": "2025-12-12T20:53:13.724631+00:00",
    "CreatedUpdatedDateTime": "2025-12-12T20:53:13.7246654+00:00",
    "IsActive": true,
    "Addresses": [
      {
        "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:53:13.7247679+00:00"
      },
      {
        "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:53:13.7247679+00:00"
      }
    ],
    "Phones": [
      {
        "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:53:13.7248407+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:53:13.7248407+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ]
  },
  {
    "HealthPlanId": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "PlanType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "FinancialClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BeginEffectiveDateTime": "2025-12-12T20:53:13.7245845+00:00",
    "EndEffectiveDateTime": "2025-12-12T20:53:13.724631+00:00",
    "CreatedUpdatedDateTime": "2025-12-12T20:53:13.7246654+00:00",
    "IsActive": true,
    "Addresses": [
      {
        "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:53:13.7247679+00:00"
      },
      {
        "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:53:13.7247679+00:00"
      }
    ],
    "Phones": [
      {
        "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:53:13.7248407+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:53:13.7248407+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ]
  }
]

GET api/v1/{EMRSystem}/Population/References/HealthPlans

Returns updated Location Reference values based on date range and reference system filters.

Status: Beta

URI Parameters

EMRSystem

Required

UserId

Required

FromDateTime

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Header Parameters

LoginId

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

Password

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

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

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

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```