POST Encounters

Developer Tools

POST api/v1/{EMRSystem}/PatientEncounters/

Creates a patient encounter and returns the encounter Id.

HTTP Method

POST

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

Released

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

 
Body Parameters
The Patient Encounter Create Request View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

PatientIdType

Gets or sets the patient identifier type.

string

None.

Encounter

Gets or sets the patient encounter.

EncounterCreateViewModel

Required

 

Response Information

 
Resource Description
Http response containing a encounter Id.
None
 
Response Codes

Http Status Code 201 – Indicates that the request was processed successfully.

Http Status Code 400 – Indicates that the request did not contain all the required fields.

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
Sample Message
Download Json Schema
{
  "UserId": "sample string 1",
  "PatientId": "sample string 2",
  "PatientIdType": "sample string 3",
  "Encounter": {
    "EncounterDateTime": "2018-02-14T18:51:22.2782962Z",
    "AttendingProviderId": "sample string 1",
    "DischargeDateTime": "2018-02-14T18:51:22.2782962Z",
    "EncounterStatusId": "sample string 2",
    "EncounterTypeId": "sample string 3",
    "Location": {
      "BedId": "sample string 1",
      "UnitId": "sample string 2",
      "HospitalId": "sample string 3",
      "RoomId": "sample string 4"
    },
    "MedicalServiceId": "sample string 4",
    "ReasonForVisit": "sample string 5",
    "PatientClassId": "sample string 6",
    "AdmitPriorityId": "sample string 7",
    "AdmitSourceId": "sample string 8",
    "EncounterAlias": "sample string 9",
    "GuarantorId": "sample string 10",
    "Insurances": [
      {
        "CompanyId": "sample string 1",
        "EligibilityStatusId": "sample string 2",
        "EligibilityStatusDate": "2018-02-14T18:51:22.2782962Z",
        "Subscriber": "sample string 3",
        "PolicyNumber": "sample string 4",
        "PatientRelationshipToSubscriber": "sample string 5"
      },
      {
        "CompanyId": "sample string 1",
        "EligibilityStatusId": "sample string 2",
        "EligibilityStatusDate": "2018-02-14T18:51:22.2782962Z",
        "Subscriber": "sample string 3",
        "PolicyNumber": "sample string 4",
        "PatientRelationshipToSubscriber": "sample string 5"
      }
    ],
    "FinancialNumber": "sample string 11"
  },
  "Domain": "sample string 4",
  "LoginId": "sample string 5",
  "Password": "sample string 6",
  "EmrInstance": "sample string 7",
  "ApplicationName": "sample string 8",
  "ApplicationKey": "sample string 9"
}
Sample Message
<PatientEncounterCreateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 9</ApplicationKey>
  <ApplicationName>sample string 8</ApplicationName>
  <Domain>sample string 4</Domain>
  <EmrInstance>sample string 7</EmrInstance>
  <LoginId>sample string 5</LoginId>
  <Password>sample string 6</Password>
  <Encounter xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:AdmitPriorityId>sample string 7</d2p1:AdmitPriorityId>
    <d2p1:AdmitSourceId>sample string 8</d2p1:AdmitSourceId>
    <d2p1:AttendingProviderId>sample string 1</d2p1:AttendingProviderId>
    <d2p1:DischargeDateTime>2018-02-14T12:51:22.2782962-06:00</d2p1:DischargeDateTime>
    <d2p1:EncounterAlias>sample string 9</d2p1:EncounterAlias>
    <d2p1:EncounterDateTime>2018-02-14T12:51:22.2782962-06:00</d2p1:EncounterDateTime>
    <d2p1:EncounterStatusId>sample string 2</d2p1:EncounterStatusId>
    <d2p1:EncounterTypeId>sample string 3</d2p1:EncounterTypeId>
    <d2p1:FinancialNumber>sample string 11</d2p1:FinancialNumber>
    <d2p1:GuarantorId>sample string 10</d2p1:GuarantorId>
    <d2p1:Insurances>
      <d2p1:InsuranceCreateViewModel>
        <d2p1:CompanyId>sample string 1</d2p1:CompanyId>
        <d2p1:EligibilityStatusDate>2018-02-14T12:51:22.2782962-06:00</d2p1:EligibilityStatusDate>
        <d2p1:EligibilityStatusId>sample string 2</d2p1:EligibilityStatusId>
        <d2p1:PatientRelationshipToSubscriber>sample string 5</d2p1:PatientRelationshipToSubscriber>
        <d2p1:PolicyNumber>sample string 4</d2p1:PolicyNumber>
        <d2p1:Subscriber>sample string 3</d2p1:Subscriber>
      </d2p1:InsuranceCreateViewModel>
      <d2p1:InsuranceCreateViewModel>
        <d2p1:CompanyId>sample string 1</d2p1:CompanyId>
        <d2p1:EligibilityStatusDate>2018-02-14T12:51:22.2782962-06:00</d2p1:EligibilityStatusDate>
        <d2p1:EligibilityStatusId>sample string 2</d2p1:EligibilityStatusId>
        <d2p1:PatientRelationshipToSubscriber>sample string 5</d2p1:PatientRelationshipToSubscriber>
        <d2p1:PolicyNumber>sample string 4</d2p1:PolicyNumber>
        <d2p1:Subscriber>sample string 3</d2p1:Subscriber>
      </d2p1:InsuranceCreateViewModel>
    </d2p1:Insurances>
    <d2p1:Location>
      <d2p1:BedId>sample string 1</d2p1:BedId>
      <d2p1:HospitalId>sample string 3</d2p1:HospitalId>
      <d2p1:RoomId>sample string 4</d2p1:RoomId>
      <d2p1:UnitId>sample string 2</d2p1:UnitId>
    </d2p1:Location>
    <d2p1:MedicalServiceId>sample string 4</d2p1:MedicalServiceId>
    <d2p1:PatientClassId>sample string 6</d2p1:PatientClassId>
    <d2p1:ReasonForVisit>sample string 5</d2p1:ReasonForVisit>
  </Encounter>
  <PatientId>sample string 2</PatientId>
  <PatientIdType>sample string 3</PatientIdType>
  <UserId>sample string 1</UserId>
</PatientEncounterCreateRequestViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?