GET Appointments by Id

GET api/v1/{EMRSystem}/Appointments/{AppointmentId}

Returns the details of a past or future scheduled appointment.

HTTP Method

GET

Applicable Emissary Products

Interactive

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Epic

Released

Meditech

In Dev

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

AppointmentId

The appointment identifier.

string

Required

UserId

Gets or sets the user identifier.

string

Required

UserType

Gets or sets the type of the user.

UserType

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing Appointments Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EncounterId

Gets or sets the encounter identifier.

string

None.

FinancialNumber

Gets or sets the financial number.

string

None.

PatientId

Gets or sets the patient identifier.

string

None.

AppointmentId

Gets or sets the appointment identifier.

string

None.

Status

Gets or sets the status.

CodedObjectViewModel

None.

AppointmentDateTime

Gets or sets the date time.

date

None.

Duration

Gets or sets the duration.

string

None.

VisitType

Gets or sets the type of the visit.

VisitTypeViewModel

None.

PatientInstructions

Gets or sets the patient instructions.

string

None.

AppointmentComments

Gets or sets the appointment comments.

string

None.

ResourceDepartments

Gets or sets the resource departments.

Collection of ResourceDepartmentViewModel

None.

ConfirmedDateTime

Gets or sets the confirmed date time.

date

None.

PatientCanCancel

Gets or sets a value indicating whether [patient can cancel].

boolean

None.

PatientCanRequestCancel

Gets or sets a value indicating whether [patient can request cancel].

boolean

None.

PatientCancelRequestSent

Gets or sets a value indicating whether [patient cancel request sent].

boolean

None.

Copay

Gets or sets the copay.

string

None.

ECheckIn

Gets or sets the e check in.

ECheckInViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.AppointmentResponseViewModel

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

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

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
{
  "EncounterId": "sample string 1",
  "FinancialNumber": "sample string 2",
  "PatientId": "sample string 3",
  "AppointmentId": "sample string 4",
  "Status": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "AppointmentDateTime": "2018-02-13T20:21:03.3752962Z",
  "Duration": "sample string 5",
  "VisitType": {
    "ExternalName": "sample string 1",
    "VisitTypeId": "sample string 2",
    "VisitTypeName": "sample string 3"
  },
  "PatientInstructions": "sample string 6",
  "AppointmentComments": "sample string 7",
  "ResourceDepartments": [
    {
      "Department": {
        "ExternalName": "sample string 1",
        "Specialty": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "ZIP": "sample string 6",
          "Type": "sample string 7",
          "Country": "sample string 8"
        },
        "PhoneNumbers": [
          {
            "PhoneId": "sample string 1",
            "Number": "sample string 2",
            "SequenceNumber": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "PhoneId": "sample string 1",
            "Number": "sample string 2",
            "SequenceNumber": "sample string 3",
            "Type": "sample string 4"
          }
        ],
        "DrivingDirections": [
          "sample string 1",
          "sample string 2"
        ],
        "DepartmentId": "sample string 2",
        "DepartmentName": "sample string 3"
      },
      "Resource": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2",
        "URLs": [
          {
            "Type": "sample string 1",
            "URL": "sample string 2"
          },
          {
            "Type": "sample string 1",
            "URL": "sample string 2"
          }
        ]
      }
    },
    {
      "Department": {
        "ExternalName": "sample string 1",
        "Specialty": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "ZIP": "sample string 6",
          "Type": "sample string 7",
          "Country": "sample string 8"
        },
        "PhoneNumbers": [
          {
            "PhoneId": "sample string 1",
            "Number": "sample string 2",
            "SequenceNumber": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "PhoneId": "sample string 1",
            "Number": "sample string 2",
            "SequenceNumber": "sample string 3",
            "Type": "sample string 4"
          }
        ],
        "DrivingDirections": [
          "sample string 1",
          "sample string 2"
        ],
        "DepartmentId": "sample string 2",
        "DepartmentName": "sample string 3"
      },
      "Resource": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2",
        "URLs": [
          {
            "Type": "sample string 1",
            "URL": "sample string 2"
          },
          {
            "Type": "sample string 1",
            "URL": "sample string 2"
          }
        ]
      }
    }
  ],
  "ConfirmedDateTime": "2018-02-13T20:21:03.3752962Z",
  "PatientCanCancel": true,
  "PatientCanRequestCancel": true,
  "PatientCancelRequestSent": true,
  "Copay": "sample string 8",
  "ECheckIn": {
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AvailableDate": "2018-02-13T20:21:03.3752962Z",
    "Barcode": "sample string 1",
    "ECheckInSteps": [
      {
        "Step": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Status": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "CompletedDateTime": "2018-02-13T20:21:03.3752962Z"
      },
      {
        "Step": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Status": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "CompletedDateTime": "2018-02-13T20:21:03.3752962Z"
      }
    ]
  }
}
Sample Message
<AppointmentResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <AppointmentComments xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 7</AppointmentComments>
  <AppointmentDateTime xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">2018-02-13T14:21:03.3752962-06:00</AppointmentDateTime>
  <AppointmentId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 4</AppointmentId>
  <ConfirmedDateTime xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">2018-02-13T14:21:03.3752962-06:00</ConfirmedDateTime>
  <Copay xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 8</Copay>
  <Duration xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 5</Duration>
  <ECheckIn xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <AvailableDate>2018-02-13T14:21:03.3752962-06:00</AvailableDate>
    <Barcode>sample string 1</Barcode>
    <ECheckInSteps>
      <ECheckInStepViewModel>
        <CompletedDateTime>2018-02-13T14:21:03.3752962-06:00</CompletedDateTime>
        <Status>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </Status>
        <Step>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </Step>
      </ECheckInStepViewModel>
      <ECheckInStepViewModel>
        <CompletedDateTime>2018-02-13T14:21:03.3752962-06:00</CompletedDateTime>
        <Status>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </Status>
        <Step>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </Step>
      </ECheckInStepViewModel>
    </ECheckInSteps>
    <Status>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Status>
  </ECheckIn>
  <EncounterId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 1</EncounterId>
  <FinancialNumber xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 2</FinancialNumber>
  <PatientCanCancel xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">true</PatientCanCancel>
  <PatientCanRequestCancel xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">true</PatientCanRequestCancel>
  <PatientCancelRequestSent xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">true</PatientCancelRequestSent>
  <PatientId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 3</PatientId>
  <PatientInstructions xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 6</PatientInstructions>
  <ResourceDepartments xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <ResourceDepartmentViewModel>
      <Department>
        <DepartmentId>sample string 2</DepartmentId>
        <DepartmentName>sample string 3</DepartmentName>
        <Address>
          <Address1>sample string 2</Address1>
          <Address2>sample string 3</Address2>
          <AddressId>sample string 1</AddressId>
          <City>sample string 4</City>
          <Country>sample string 8</Country>
          <State>sample string 5</State>
          <Type>sample string 7</Type>
          <ZIP>sample string 6</ZIP>
        </Address>
        <DrivingDirections xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </DrivingDirections>
        <ExternalName>sample string 1</ExternalName>
        <PhoneNumbers>
          <PhoneViewModel>
            <Number>sample string 2</Number>
            <PhoneId>sample string 1</PhoneId>
            <SequenceNumber>sample string 3</SequenceNumber>
            <Type>sample string 4</Type>
          </PhoneViewModel>
          <PhoneViewModel>
            <Number>sample string 2</Number>
            <PhoneId>sample string 1</PhoneId>
            <SequenceNumber>sample string 3</SequenceNumber>
            <Type>sample string 4</Type>
          </PhoneViewModel>
        </PhoneNumbers>
        <Specialty>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </Specialty>
      </Department>
      <Resource>
        <ProviderId>sample string 1</ProviderId>
        <ProviderName>sample string 2</ProviderName>
        <URLs>
          <UrlViewModel>
            <Type>sample string 1</Type>
            <URL>sample string 2</URL>
          </UrlViewModel>
          <UrlViewModel>
            <Type>sample string 1</Type>
            <URL>sample string 2</URL>
          </UrlViewModel>
        </URLs>
      </Resource>
    </ResourceDepartmentViewModel>
    <ResourceDepartmentViewModel>
      <Department>
        <DepartmentId>sample string 2</DepartmentId>
        <DepartmentName>sample string 3</DepartmentName>
        <Address>
          <Address1>sample string 2</Address1>
          <Address2>sample string 3</Address2>
          <AddressId>sample string 1</AddressId>
          <City>sample string 4</City>
          <Country>sample string 8</Country>
          <State>sample string 5</State>
          <Type>sample string 7</Type>
          <ZIP>sample string 6</ZIP>
        </Address>
        <DrivingDirections xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </DrivingDirections>
        <ExternalName>sample string 1</ExternalName>
        <PhoneNumbers>
          <PhoneViewModel>
            <Number>sample string 2</Number>
            <PhoneId>sample string 1</PhoneId>
            <SequenceNumber>sample string 3</SequenceNumber>
            <Type>sample string 4</Type>
          </PhoneViewModel>
          <PhoneViewModel>
            <Number>sample string 2</Number>
            <PhoneId>sample string 1</PhoneId>
            <SequenceNumber>sample string 3</SequenceNumber>
            <Type>sample string 4</Type>
          </PhoneViewModel>
        </PhoneNumbers>
        <Specialty>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
        </Specialty>
      </Department>
      <Resource>
        <ProviderId>sample string 1</ProviderId>
        <ProviderName>sample string 2</ProviderName>
        <URLs>
          <UrlViewModel>
            <Type>sample string 1</Type>
            <URL>sample string 2</URL>
          </UrlViewModel>
          <UrlViewModel>
            <Type>sample string 1</Type>
            <URL>sample string 2</URL>
          </UrlViewModel>
        </URLs>
      </Resource>
    </ResourceDepartmentViewModel>
  </ResourceDepartments>
  <Status xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </Status>
  <VisitType xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <ExternalName>sample string 1</ExternalName>
    <VisitTypeId>sample string 2</VisitTypeId>
    <VisitTypeName>sample string 3</VisitTypeName>
  </VisitType>
</AppointmentResponseViewModel>

Submit a Comment

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

 

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