POST Patients

Developer Tools

POST api/v1/{EMRSystem}/Patients/

Creates a patient and returns the patient Id.

HTTP Method

POST

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

In Dev

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 Create Request View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

string

Required

FacilityId

Gets or sets the facility identifier

string

Required if EMRSystem = Meditech.

Patient

Gets or sets the patient.

PatientCreateViewModel

Required

 

Response Information

 
Resource Description
Http response containing a patient 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",
  "FacilityId": "sample string 2",
  "Patient": {
    "DeceasedDateTime": "2018-02-14T20:57:27.1093073Z",
    "LastName": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "Suffix": "sample string 4",
    "Prefix": "sample string 5",
    "BirthDateTime": "2018-02-14T20:57:27.1093073Z",
    "GenderId": "sample string 6",
    "SSN": "sample string 7",
    "VipId": "sample string 8",
    "ConfidentialityId": "sample string 9",
    "ExtendedInfo": {
      "Addresses": [
        {
          "Address1": "sample string 1",
          "Address2": "sample string 2",
          "City": "sample string 3",
          "State": "sample string 4",
          "ZIP": "sample string 5",
          "TypeId": "sample string 6"
        },
        {
          "Address1": "sample string 1",
          "Address2": "sample string 2",
          "City": "sample string 3",
          "State": "sample string 4",
          "ZIP": "sample string 5",
          "TypeId": "sample string 6"
        }
      ],
      "Phones": [
        {
          "Number": "sample string 1",
          "TypeId": "sample string 2"
        },
        {
          "Number": "sample string 1",
          "TypeId": "sample string 2"
        }
      ],
      "EthnicityId": "sample string 1",
      "LanguageId": "sample string 2",
      "RaceId": "sample string 3",
      "ReligionId": "sample string 4",
      "MaritalStatusId": "sample string 5",
      "Email": "sample string 6",
      "NeedsInterpreter": true
    }
  },
  "Domain": "sample string 3",
  "LoginId": "sample string 4",
  "Password": "sample string 5",
  "EmrInstance": "sample string 6",
  "ApplicationName": "sample string 7",
  "ApplicationKey": "sample string 8"
}
Sample Message
<PatientCreateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 8</ApplicationKey>
  <ApplicationName>sample string 7</ApplicationName>
  <Domain>sample string 3</Domain>
  <EmrInstance>sample string 6</EmrInstance>
  <LoginId>sample string 4</LoginId>
  <Password>sample string 5</Password>
  <FacilityId>sample string 2</FacilityId>
  <Patient xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:BirthDateTime>2018-02-14T14:57:27.1093073-06:00</d2p1:BirthDateTime>
    <d2p1:ConfidentialityId>sample string 9</d2p1:ConfidentialityId>
    <d2p1:DeceasedDateTime>2018-02-14T14:57:27.1093073-06:00</d2p1:DeceasedDateTime>
    <d2p1:ExtendedInfo>
      <d2p1:Addresses>
        <d2p1:AddressCreateViewModel>
          <d2p1:Address1>sample string 1</d2p1:Address1>
          <d2p1:Address2>sample string 2</d2p1:Address2>
          <d2p1:City>sample string 3</d2p1:City>
          <d2p1:State>sample string 4</d2p1:State>
          <d2p1:TypeId>sample string 6</d2p1:TypeId>
          <d2p1:ZIP>sample string 5</d2p1:ZIP>
        </d2p1:AddressCreateViewModel>
        <d2p1:AddressCreateViewModel>
          <d2p1:Address1>sample string 1</d2p1:Address1>
          <d2p1:Address2>sample string 2</d2p1:Address2>
          <d2p1:City>sample string 3</d2p1:City>
          <d2p1:State>sample string 4</d2p1:State>
          <d2p1:TypeId>sample string 6</d2p1:TypeId>
          <d2p1:ZIP>sample string 5</d2p1:ZIP>
        </d2p1:AddressCreateViewModel>
      </d2p1:Addresses>
      <d2p1:Email>sample string 6</d2p1:Email>
      <d2p1:EthnicityId>sample string 1</d2p1:EthnicityId>
      <d2p1:LanguageId>sample string 2</d2p1:LanguageId>
      <d2p1:MaritalStatusId>sample string 5</d2p1:MaritalStatusId>
      <d2p1:NeedsInterpreter>true</d2p1:NeedsInterpreter>
      <d2p1:Phones>
        <d2p1:PhoneCreateViewModel>
          <d2p1:Number>sample string 1</d2p1:Number>
          <d2p1:TypeId>sample string 2</d2p1:TypeId>
        </d2p1:PhoneCreateViewModel>
        <d2p1:PhoneCreateViewModel>
          <d2p1:Number>sample string 1</d2p1:Number>
          <d2p1:TypeId>sample string 2</d2p1:TypeId>
        </d2p1:PhoneCreateViewModel>
      </d2p1:Phones>
      <d2p1:RaceId>sample string 3</d2p1:RaceId>
      <d2p1:ReligionId>sample string 4</d2p1:ReligionId>
    </d2p1:ExtendedInfo>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:GenderId>sample string 6</d2p1:GenderId>
    <d2p1:LastName>sample string 1</d2p1:LastName>
    <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
    <d2p1:Prefix>sample string 5</d2p1:Prefix>
    <d2p1:SSN>sample string 7</d2p1:SSN>
    <d2p1:Suffix>sample string 4</d2p1:Suffix>
    <d2p1:VipId>sample string 8</d2p1:VipId>
  </Patient>
  <UserId>sample string 1</UserId>
</PatientCreateRequestViewModel>

Submit a Comment

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

 

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