GET Referrals

Developer Tools

HTTP Method

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

Released

Cerner

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

UserId

The identifier of the user requesting the referrals

string

Required

PatientId

The identifier of the patient to get referrals from

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
None
 
Response Codes

Http Status Code 200 – Returns a collection of Sansoro.Shared.SansoroServiceBus.Models.ReferralResponseViewModel

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
[
  {
    "ReferralId": "sample string 1",
    "PatientId": "sample string 2",
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AuthorizationNumber": "sample string 3",
    "Priority": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "StartDate": "2018-02-15T16:48:20.2009057Z",
    "EndDate": "2018-02-15T16:48:20.2009057Z",
    "ReferringProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "ReferredToProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "ReferralClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ReferralType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ReasonForReferral": "sample string 4",
    "Procedures": [
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      },
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      }
    ],
    "ProcedureNotes": "sample string 5",
    "LinkedOrderIds": [
      "sample string 1",
      "sample string 2"
    ],
    "Notes": [
      {
        "NoteId": "sample string 1",
        "NoteType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "NoteDateTime": "2018-02-15T16:48:20.2009057Z",
        "CreatedBy": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteFormat": "sample string 2",
        "NoteText": "sample string 3"
      },
      {
        "NoteId": "sample string 1",
        "NoteType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "NoteDateTime": "2018-02-15T16:48:20.2009057Z",
        "CreatedBy": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteFormat": "sample string 2",
        "NoteText": "sample string 3"
      }
    ]
  },
  {
    "ReferralId": "sample string 1",
    "PatientId": "sample string 2",
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AuthorizationNumber": "sample string 3",
    "Priority": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "StartDate": "2018-02-15T16:48:20.2009057Z",
    "EndDate": "2018-02-15T16:48:20.2009057Z",
    "ReferringProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "ReferredToProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "ReferralClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ReferralType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ReasonForReferral": "sample string 4",
    "Procedures": [
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      },
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      }
    ],
    "ProcedureNotes": "sample string 5",
    "LinkedOrderIds": [
      "sample string 1",
      "sample string 2"
    ],
    "Notes": [
      {
        "NoteId": "sample string 1",
        "NoteType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "NoteDateTime": "2018-02-15T16:48:20.2009057Z",
        "CreatedBy": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteFormat": "sample string 2",
        "NoteText": "sample string 3"
      },
      {
        "NoteId": "sample string 1",
        "NoteType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "NoteDateTime": "2018-02-15T16:48:20.2009057Z",
        "CreatedBy": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteFormat": "sample string 2",
        "NoteText": "sample string 3"
      }
    ]
  }
]
Sample Message
<ArrayOfReferralResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ReferralResponseViewModel>
    <AuthorizationNumber>sample string 3</AuthorizationNumber>
    <EndDate>2018-02-15T10:48:20.2009057-06:00</EndDate>
    <LinkedOrderIds xmlns:d3p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LinkedOrderIds>
    <Notes xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ReferralNoteViewModel>
        <d3p1:CreatedBy>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:CreatedBy>
        <d3p1:NoteDateTime>2018-02-15T10:48:20.2009057-06:00</d3p1:NoteDateTime>
        <d3p1:NoteFormat>sample string 2</d3p1:NoteFormat>
        <d3p1:NoteId>sample string 1</d3p1:NoteId>
        <d3p1:NoteText>sample string 3</d3p1:NoteText>
        <d3p1:NoteType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:NoteType>
      </d3p1:ReferralNoteViewModel>
      <d3p1:ReferralNoteViewModel>
        <d3p1:CreatedBy>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:CreatedBy>
        <d3p1:NoteDateTime>2018-02-15T10:48:20.2009057-06:00</d3p1:NoteDateTime>
        <d3p1:NoteFormat>sample string 2</d3p1:NoteFormat>
        <d3p1:NoteId>sample string 1</d3p1:NoteId>
        <d3p1:NoteText>sample string 3</d3p1:NoteText>
        <d3p1:NoteType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:NoteType>
      </d3p1:ReferralNoteViewModel>
    </Notes>
    <PatientId>sample string 2</PatientId>
    <Priority xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Priority>
    <ProcedureNotes>sample string 5</ProcedureNotes>
    <Procedures xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:OrderableCodeViewModel>
        <d3p1:Active>true</d3p1:Active>
        <d3p1:OrderableCodeDesc>sample string 2</d3p1:OrderableCodeDesc>
        <d3p1:OrderableCodeId>sample string 1</d3p1:OrderableCodeId>
        <d3p1:OrderableCodeIdentities>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
        </d3p1:OrderableCodeIdentities>
      </d3p1:OrderableCodeViewModel>
      <d3p1:OrderableCodeViewModel>
        <d3p1:Active>true</d3p1:Active>
        <d3p1:OrderableCodeDesc>sample string 2</d3p1:OrderableCodeDesc>
        <d3p1:OrderableCodeId>sample string 1</d3p1:OrderableCodeId>
        <d3p1:OrderableCodeIdentities>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
        </d3p1:OrderableCodeIdentities>
      </d3p1:OrderableCodeViewModel>
    </Procedures>
    <ReasonForReferral>sample string 4</ReasonForReferral>
    <ReferralClass xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ReferralClass>
    <ReferralId>sample string 1</ReferralId>
    <ReferralType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ReferralType>
    <ReferredToProvider xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
      <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
    </ReferredToProvider>
    <ReferringProvider xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
      <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
    </ReferringProvider>
    <StartDate>2018-02-15T10:48:20.2009057-06:00</StartDate>
    <Status xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Status>
  </ReferralResponseViewModel>
  <ReferralResponseViewModel>
    <AuthorizationNumber>sample string 3</AuthorizationNumber>
    <EndDate>2018-02-15T10:48:20.2009057-06:00</EndDate>
    <LinkedOrderIds xmlns:d3p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LinkedOrderIds>
    <Notes xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ReferralNoteViewModel>
        <d3p1:CreatedBy>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:CreatedBy>
        <d3p1:NoteDateTime>2018-02-15T10:48:20.2009057-06:00</d3p1:NoteDateTime>
        <d3p1:NoteFormat>sample string 2</d3p1:NoteFormat>
        <d3p1:NoteId>sample string 1</d3p1:NoteId>
        <d3p1:NoteText>sample string 3</d3p1:NoteText>
        <d3p1:NoteType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:NoteType>
      </d3p1:ReferralNoteViewModel>
      <d3p1:ReferralNoteViewModel>
        <d3p1:CreatedBy>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:CreatedBy>
        <d3p1:NoteDateTime>2018-02-15T10:48:20.2009057-06:00</d3p1:NoteDateTime>
        <d3p1:NoteFormat>sample string 2</d3p1:NoteFormat>
        <d3p1:NoteId>sample string 1</d3p1:NoteId>
        <d3p1:NoteText>sample string 3</d3p1:NoteText>
        <d3p1:NoteType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:NoteType>
      </d3p1:ReferralNoteViewModel>
    </Notes>
    <PatientId>sample string 2</PatientId>
    <Priority xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Priority>
    <ProcedureNotes>sample string 5</ProcedureNotes>
    <Procedures xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:OrderableCodeViewModel>
        <d3p1:Active>true</d3p1:Active>
        <d3p1:OrderableCodeDesc>sample string 2</d3p1:OrderableCodeDesc>
        <d3p1:OrderableCodeId>sample string 1</d3p1:OrderableCodeId>
        <d3p1:OrderableCodeIdentities>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
        </d3p1:OrderableCodeIdentities>
      </d3p1:OrderableCodeViewModel>
      <d3p1:OrderableCodeViewModel>
        <d3p1:Active>true</d3p1:Active>
        <d3p1:OrderableCodeDesc>sample string 2</d3p1:OrderableCodeDesc>
        <d3p1:OrderableCodeId>sample string 1</d3p1:OrderableCodeId>
        <d3p1:OrderableCodeIdentities>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
          <d3p1:OrderableCodeIdentityViewModel>
            <d3p1:Type>sample string 2</d3p1:Type>
            <d3p1:Value>sample string 1</d3p1:Value>
          </d3p1:OrderableCodeIdentityViewModel>
        </d3p1:OrderableCodeIdentities>
      </d3p1:OrderableCodeViewModel>
    </Procedures>
    <ReasonForReferral>sample string 4</ReasonForReferral>
    <ReferralClass xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ReferralClass>
    <ReferralId>sample string 1</ReferralId>
    <ReferralType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ReferralType>
    <ReferredToProvider xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
      <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
    </ReferredToProvider>
    <ReferringProvider xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
      <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
    </ReferringProvider>
    <StartDate>2018-02-15T10:48:20.2009057-06:00</StartDate>
    <Status xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Status>
  </ReferralResponseViewModel>
</ArrayOfReferralResponseViewModel>

Submit a Comment

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

 

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