GET api/v1/{EMRSystem}/PatientEncounters/{EncounterId}

Returns Patient Encounter details for a given Encounter Id. FHIR connectors use the following resources for R4: Encounter.Read, Patient.Read, Practitioner.Read, and Location.Read.

Status: Released

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
UserId	Gets or sets the user identifier.	string	Required
EncounterId	The Patient Encounter identifier	string	Required
EncounterAlias	Gets or sets the alias of the encounter.	string	None.
IncludeInsurancePlans	Gets or sets a value indicating whether [include insurance plans].	boolean	None.
IncludeComments	Gets or sets a value indicating whether [include Comments].	boolean	None.
IncludePriorAuthorizations	Gets or sets a value indicating whether [include Prior Authorizations].	boolean	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

UdmPatientEncounterResponse

Name	Description	Type	Additional information
AttendingProvider	Gets or sets the attending provider name.	string	None.
AttendingProviderId	Gets or sets the attending provider identifier.	string	None.
DischargeDisposition	Gets or sets the discharge dispositions	string	None.
EncounterAlias	Gets or sets the encounter status.	string	None.
EncounterDateTime	Gets or sets the encounter date time.	datetime	None.
EncounterStatus	Gets or sets the encounter status.	string	None.
Location	Gets or sets the location.	Location	None.
LocationHistory	Gets or sets the location history.	Collection of LocationHistory	None.
MedicalService	Gets or sets the medical service.	string	None.
PatientCareTeams	Gets or sets the patient care teams.	Collection of PatientCareTeam	None.
PatientId	Gets or sets the patient identifier.	string	None.
ReasonForVisit	Gets or sets the reason for visit.	string	None.
PatientClass	Gets or sets the Patient Class	CodedObject	None.
AdmitPriority	Gets or sets the Admit Priority	CodedObject	None.
AdmitSource	Gets or sets the Admit Source	CodedObject	None.
InsurancePlans	Gets or sets the insurance plans.	Collection of InsurancePlan	None.
DischargeToLocation	Gets or sets the discharged to location	string	None.
CustomFields	Gets or sets the CustomFields	Collection of CustomFieldObject	None.
RegistrationDateTime	Gets or sets the registration date time.	datetime	None.
PreRegistrationDateTime	Gets or sets the pre-registration date time.	datetime	None.
ArrivalDateTime	Gets or sets the arrival date time.	datetime	None.
Isolation	Gets or sets the Isolation	CodedObject	None.
Comments		Collection of Comment	None.
PatientValuables	Gets or sets the Patient Valuables.	Collection of CodedObject	None.
EncounterRelationships	Gets or sets the Encounter Relationships.	Collection of EncounterRelationship	None.
EncounterPriorAuthorizations	Gets or sets the Encounter Prior Authorizations.	Collection of EncounterPriorAuthorization	None.
EncounterIdentifiers	Gets or sets the Encounter unique Identifiers.	Collection of Identity	None.
EncounterId	Gets or sets the encounter identifier.	string	None.
EncounterType	Gets or sets the encounter type.	CodedObject	None.
DischargeDateTime	Gets or sets the discharge date time.	datetime	None.
FinancialNumber	Gets or sets the financial number.	string	None.

Response Codes

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

Http Status Code 404 - Indicates that the resource to get could not be found.

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

{
  "AttendingProvider": "sample string 1",
  "AttendingProviderId": "sample string 2",
  "DischargeDisposition": "sample string 3",
  "EncounterAlias": "sample string 4",
  "EncounterDateTime": "2025-12-12T21:05:50.2416022+00:00",
  "EncounterStatus": "sample string 5",
  "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"
  },
  "LocationHistory": [
    {
      "Bed": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Room": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Unit": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Hospital": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EffectiveFromDate": "2025-12-12T21:05:50.2424087+00:00",
      "EffectiveToDate": "2025-12-12T21:05:50.2425374+00:00",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "Bed": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Room": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Unit": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Hospital": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EffectiveFromDate": "2025-12-12T21:05:50.2424087+00:00",
      "EffectiveToDate": "2025-12-12T21:05:50.2425374+00:00",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "MedicalService": "sample string 6",
  "PatientCareTeams": [
    {
      "NPI": "sample string 1",
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "RelationshipType": "sample string 2",
      "FromDate": "2025-12-12T21:05:50.2429465+00:00",
      "ToDate": "2025-12-12T21:05:50.2429486+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-12T21:05:50.2430921+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-12T21:05:50.2430921+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "IsManuallyAdded": true,
      "InternalSequence": "sample string 4"
    },
    {
      "NPI": "sample string 1",
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "RelationshipType": "sample string 2",
      "FromDate": "2025-12-12T21:05:50.2429465+00:00",
      "ToDate": "2025-12-12T21:05:50.2429486+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-12T21:05:50.2430921+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-12T21:05:50.2430921+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "IsManuallyAdded": true,
      "InternalSequence": "sample string 4"
    }
  ],
  "PatientId": "sample string 7",
  "ReasonForVisit": "sample string 8",
  "PatientClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "AdmitPriority": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "AdmitSource": {
    "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-12T21:05:50.2437093+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-12T21:05:50.2437473+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-12T21:05:50.2430921+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-12T21:05:50.2430921+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "Priority": "sample string 10",
      "EffectiveFromDate": "2025-12-12T21:05:50.2437579+00:00",
      "EffectiveToDate": "2025-12-12T21:05:50.2437591+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-12T21:05:50.2437473+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-12T21:05:50.2437964+00:00",
      "DataStatusId": "sample string 20",
      "DataStatus": "sample string 21",
      "DataStatusPersonnelId": "sample string 22",
      "DataStatusDateTime": "2025-12-12T21:05:50.2438007+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-12T21:05:50.2438121+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-12T21:05:50.2437093+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-12T21:05:50.2437473+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-12T21:05:50.2430921+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-12T21:05:50.2430921+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "Priority": "sample string 10",
      "EffectiveFromDate": "2025-12-12T21:05:50.2437579+00:00",
      "EffectiveToDate": "2025-12-12T21:05:50.2437591+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-12T21:05:50.2437473+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-12T21:05:50.2437964+00:00",
      "DataStatusId": "sample string 20",
      "DataStatus": "sample string 21",
      "DataStatusPersonnelId": "sample string 22",
      "DataStatusDateTime": "2025-12-12T21:05:50.2438007+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-12T21:05:50.2438121+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"
    }
  ],
  "DischargeToLocation": "sample string 9",
  "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"
      ]
    }
  ],
  "RegistrationDateTime": "2025-12-12T21:05:50.2441886+00:00",
  "PreRegistrationDateTime": "2025-12-12T21:05:50.2443299+00:00",
  "ArrivalDateTime": "2025-12-12T21:05:50.2444789+00:00",
  "Isolation": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "Comments": [
    {
      "CommentText": "sample string 1",
      "CommentUpdateDateTime": "2025-12-12T21:05:50.24468+00:00",
      "CommentUpdatePersonnel": "2025-12-12",
      "InternalSequence": "sample string 2"
    },
    {
      "CommentText": "sample string 1",
      "CommentUpdateDateTime": "2025-12-12T21:05:50.24468+00:00",
      "CommentUpdatePersonnel": "2025-12-12",
      "InternalSequence": "sample string 2"
    }
  ],
  "PatientValuables": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "EncounterRelationships": [
    {
      "EncounterRelationshipId": "sample string 1",
      "RelatedPerson": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "RelationshipType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "RelatedPersonRelationToPatient": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientRelationToRelatedPerson": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "EncounterRelationshipId": "sample string 1",
      "RelatedPerson": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "RelationshipType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "RelatedPersonRelationToPatient": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientRelationToRelatedPerson": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "EncounterPriorAuthorizations": [
    {
      "PriorAuthorizationId": "sample string 1",
      "PriorAuthorizationNumber": "sample string 2",
      "PriorAuthorizationInsurance": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "PriorAuthorizationId": "sample string 1",
      "PriorAuthorizationNumber": "sample string 2",
      "PriorAuthorizationInsurance": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "EncounterIdentifiers": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "EncounterId": "sample string 10",
  "EncounterType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "DischargeDateTime": "2025-12-12T21:05:50.2458728+00:00",
  "FinancialNumber": "sample string 11"
}

GET api/v1/{EMRSystem}/PatientEncounters/{EncounterId}

Returns Patient Encounter details for a given Encounter Id. FHIR connectors use the following resources for R4: Encounter.Read, Patient.Read, Practitioner.Read, and Location.Read.

Status: Released

URI Parameters

EMRSystem

Required

UserId

Required

EncounterId

Required

EncounterAlias

IncludeInsurancePlans

IncludeComments

IncludePriorAuthorizations

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}}
```