PATCH api/v1/{EMRSystem}/PatientEncounterInsurances/{InsuranceId}
Patches a Patient Encounter Insurance and returns the InsuranceId
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InsuranceId |
Gets or sets the insurance identifier. |
string |
Required |
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmPatientEncounterInsurancePatchRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| CompanyId |
Gets or sets the company identifier. |
string |
None. |
| CompanyName |
Gets or sets the company override name. |
string |
None. |
| HealthPlanId |
Gets or sets the health plan identifier. |
string |
None. |
| GroupName |
Gets or sets the group name. |
string |
None. |
| GroupNumber |
Gets or sets the group number. |
string |
None. |
| EligibilityStatusId |
Gets or sets the eligibility status identifier. |
string |
None. |
| EligibilityStatusDate |
Gets or sets the eligibility status date. |
datetime |
Date only |
| SubscriberId |
Gets or sets the subscriberid. |
string |
None. |
| Subscriber |
Gets or sets the subscriber. |
string |
None. |
| PolicyNumber |
Gets or sets the policy number. |
string |
None. |
| PatientRelationshipToSubscriber |
Gets or sets the patient relationship to subscriber. |
string |
None. |
| SubscriberRelationshipToPatientId |
Gets or sets the subscriber relationship to patient. |
string |
None. |
| Priority |
Gets or sets the priority. |
string |
None. |
| BeginEffectiveDateTime |
Gets or sets the begin effective date time. |
datetime |
None. |
| EndEffectiveDateTime |
Gets or sets the end effective date time. |
datetime |
None. |
| InsuranceCardCopiedId |
Gets or sets the insurance card copied identifier. |
string |
None. |
| InsuranceCardNameLast |
Gets or sets the last name on the insurance card. |
string |
None. |
| InsuranceCardNameFirst |
Gets or sets the first name on the insurance card. |
string |
None. |
| InsuranceCardNameMiddle |
Gets or sets the middle name on the insurance card. |
string |
None. |
| SubscriberMemberNumber |
Gets or sets the subscriber member number. |
string |
None. |
| MemberNumber |
Gets or sets the member number. |
string |
None. |
| VerificationStatusId |
Gets or sets the verification status identifier. |
string |
None. |
| VerificationSourceId |
Gets or sets the verification source identifier. |
string |
None. |
| VerificationDateTime |
Gets or sets the verification date time. |
datetime |
None. |
| VerificationPersonnelId |
Gets or sets the verification personnel identifier. |
string |
None. |
| AssignmentOfBenefitsId |
Gets or sets the assignment of benefits identifier. |
string |
None. |
| DeductibleAmount |
Gets or sets the deductible amount. |
string |
None. |
| DeductibleRemaining |
Gets or sets the remainder of the deductible. |
string |
None. |
| DeductibleIncludingMaxOutOfPocket |
Gets or sets the deductible amount including max out of pocket. |
string |
None. |
| CopayAmount |
Gets or sets the copay amount. |
string |
None. |
| CopayIncludingMaxOutOfPocket |
Gets or sets the copay amount including max out of pocket. |
string |
None. |
| MaxOutOfPocket |
Gets or sets the maximum out of pocket amount. |
string |
None. |
| FamilyDeductibleMetAmount |
Gets or sets the family deductible met amount. |
string |
None. |
| CoinsurancePercentage | string |
None. |
|
| EstimatedFinancialRespAmount | string |
None. |
|
| Address |
Gets or sets the address. |
AddressUpdate |
None. |
| Phones |
Gets or sets the phones. |
Collection of PhoneUpdate |
None. |
| CustomFields |
Gets or sets Custom Fields |
Collection of CustomField |
None. |
| Prioritization |
Gets or sets insurance prioritization. |
Collection of EncounterInsurancePrioritization |
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. |
Request Formats
application/json
{
"UserId": "sample string 1",
"CompanyId": "sample string 3",
"CompanyName": "sample string 4",
"HealthPlanId": "sample string 5",
"GroupName": "sample string 6",
"GroupNumber": "sample string 7",
"EligibilityStatusId": "sample string 8",
"EligibilityStatusDate": "2025-12-12T21:05:10.2752808+00:00",
"SubscriberId": "sample string 9",
"Subscriber": "sample string 10",
"PolicyNumber": "sample string 11",
"PatientRelationshipToSubscriber": "sample string 12",
"SubscriberRelationshipToPatientId": "sample string 13",
"Priority": "sample string 14",
"BeginEffectiveDateTime": "2025-12-12T21:05:10.2756329+00:00",
"EndEffectiveDateTime": "2025-12-12T21:05:10.2756797+00:00",
"InsuranceCardCopiedId": "sample string 15",
"InsuranceCardNameLast": "sample string 16",
"InsuranceCardNameFirst": "sample string 17",
"InsuranceCardNameMiddle": "sample string 18",
"SubscriberMemberNumber": "sample string 19",
"MemberNumber": "sample string 20",
"VerificationStatusId": "sample string 21",
"VerificationSourceId": "sample string 22",
"VerificationDateTime": "2025-12-12T21:05:10.2759827+00:00",
"VerificationPersonnelId": "sample string 23",
"AssignmentOfBenefitsId": "sample string 24",
"DeductibleAmount": "sample string 25",
"DeductibleRemaining": "sample string 26",
"DeductibleIncludingMaxOutOfPocket": "sample string 27",
"CopayAmount": "sample string 28",
"CopayIncludingMaxOutOfPocket": "sample string 29",
"MaxOutOfPocket": "sample string 30",
"FamilyDeductibleMetAmount": "sample string 31",
"CoinsurancePercentage": "sample string 32",
"EstimatedFinancialRespAmount": "sample string 33",
"Address": {
"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",
"TypeId": "sample string 8",
"County": "sample string 9",
"Country": "sample string 10"
},
"Phones": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"TypeId": "sample string 3",
"Extension": "sample string 4",
"FormatId": "sample string 5",
"Contact": "sample string 6"
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"TypeId": "sample string 3",
"Extension": "sample string 4",
"FormatId": "sample string 5",
"Contact": "sample string 6"
}
],
"CustomFields": [
{
"FieldId": "sample string 1",
"ResponseValue": "sample string 2"
},
{
"FieldId": "sample string 1",
"ResponseValue": "sample string 2"
}
],
"Prioritization": [
{
"InsuranceId": "sample string 1",
"Priority": "sample string 2"
},
{
"InsuranceId": "sample string 1",
"Priority": "sample string 2"
}
],
"LoginId": "sample string 35",
"Password": "sample string 36",
"EmrInstance": "sample string 37",
"ApplicationName": "sample string 38",
"ApplicationKey": null,
"AuthorizationToken": "sample string 40",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmPatientEncounterInsuranceUpdateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| InsuranceId |
The identifier of the insurance plan that was updated. |
string |
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
{
"InsuranceId": "sample string 1"
}