GET Referrals by Id

GET api/v1/{EMRSystem}/Referrals/{ReferralId}

Returns a referral.

HTTP Method

GET

Applicable Emissary Products

Interactive

Allscripts

In Dev

Athena

In Dev

Cerner

In Dev

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

ReferralId

The referral identifier

string

Required

UserId

The identifier of the user requesting the referral

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing Referral Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

ReferralId

The referral identifier

string

None.

PatientId

The patient identifier

string

None.

Status

The status of the referral

CodedObjectViewModel

None.

AuthorizationNumber

The authorization number

string

None.

Priority

The priority of the referral

CodedObjectViewModel

None.

StartDate

The authorized service start date

date

None.

EndDate

The authorized service end date

date

None.

ReferringProvider

The provider referring the patient

ProviderViewModel

None.

ReferredToProvider

The provider the patient is being referred to

ProviderViewModel

None.

ReferralClass

The class of the referral

CodedObjectViewModel

None.

ReferralType

The type of the referral

CodedObjectViewModel

None.

ReasonForReferral

The reason the patient is being referred

string

None.

Procedures

The procedures the referring provider requested for the patient

Collection of OrderableCodeViewModel

None.

ProcedureNotes

Any special requests the referring provider may have made

string

None.

LinkedOrderIds

List of the identifiers of any orders linked to the referral

Collection of string

None.

Notes

Notes regarding the referral

Collection of ReferralNoteViewModel

None.

 
Response Codes

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

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

Submit a Comment

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

 

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