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

Returns a Referral.

Status: Beta

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
ReferralId	The Referral identifier	string	Required
UserId	The identifier of the user requesting the referral	string	Required

Header Parameters

Name	Description	Type	Additional information
LoginId	Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Password	Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
EmrInstance	Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
ApplicationName	Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if using application keys
ApplicationKey	Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if using application keys
AuthorizationToken	Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
RequestVerboseLogging	Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.	boolean	None.

Response Information

UdmReferralResponse

Name	Description	Type	Additional information
ReferralId	The referral identifier	string	None.
PatientId	The patient identifier	string	None.
Status	The status of the referral	CodedObject	None.
AuthorizationNumber	The authorization number	string	None.
Priority	The priority of the referral	CodedObject	None.
StartDate	The authorized service start date	datetime	None.
EndDate	The authorized service end date	datetime	None.
ReferringProvider	The provider referring the patient	Provider	None.
ReferredToProvider	The provider the patient is being referred to	Provider	None.
ReferralClass	The class of the referral	CodedObject	None.
ReferralType	The type of the referral	CodedObject	None.
ReasonForReferral	The reason the patient is being referred	string	None.
Procedures	The procedures the referring provider requested for the patient	Collection of OrderableCode	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 ReferralNote	None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

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

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

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

application/json

{
  "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": "2025-12-12T21:06:26.1316456+00:00",
  "EndDate": "2025-12-12T21:06:26.1319183+00:00",
  "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"
        }
      ],
      "OrderDetail": [
        {
          "Action": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OrderDetailName": "sample string 1",
          "Id": "sample string 2",
          "ContextType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SiteId": "sample string 3",
          "RelatedOrderDetails": []
        },
        {
          "Action": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OrderDetailName": "sample string 1",
          "Id": "sample string 2",
          "ContextType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SiteId": "sample string 3",
          "RelatedOrderDetails": []
        }
      ]
    },
    {
      "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"
        }
      ],
      "OrderDetail": [
        {
          "Action": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OrderDetailName": "sample string 1",
          "Id": "sample string 2",
          "ContextType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SiteId": "sample string 3",
          "RelatedOrderDetails": []
        },
        {
          "Action": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "OrderDetailName": "sample string 1",
          "Id": "sample string 2",
          "ContextType": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "SiteId": "sample string 3",
          "RelatedOrderDetails": []
        }
      ]
    }
  ],
  "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": "2025-12-12T21:06:26.1328238+00:00",
      "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": "2025-12-12T21:06:26.1328238+00:00",
      "CreatedBy": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "NoteFormat": "sample string 2",
      "NoteText": "sample string 3"
    }
  ]
}

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

Returns a Referral.

Status: Beta

URI Parameters

EMRSystem

Required

ReferralId

Required

UserId

Required

Header Parameters

LoginId

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

Request: {{ method }} {{ url }}

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```