NAV Navbar
Logo cerner
Ruby Shell

Referral API v1

The Referral Request API allows you to create, update, and retrieve referral requests exchanged between providers in a health care system. A referral request can be generated by one provider to refer a patient to another provider or specialist for specific health care services such as treatments, labs, radiology and imaging, assessments, or consults.

Through applications that use this API, a practitioner or related clinical staff member can generate and manage outbound referral requests, access the referral requests sent to them, and exchange notes and other related status activity details about the request. In addition to the requesting and receiving providers, this API can also support other roles in the health care system such as referral coordinators or referral managers. These roles are responsible for the review and approval or denial of referral requests flowing through the system when such requests are not permitted for automatic approval.

The referral request list endpoints of this API allow for multiple filtering options when retrieving referral request records. The primary filtering within a HealtheIntent tenant is based on the personnel ID. Based upon the specified personnel ID (the ID of a user of the system), the resulting list of referral records is filtered per the following criteria:

Beyond this, the requests can be further filtered using various parameters such as the organization, requester, recipient, patient, or service type.

Referral requests managed by this API can transition among multiple statuses over the course of their life. Additionally, you can add information such as pending activities and notes to a request record to indicate when additional actions must be taken in order to progress to the next status.

For example, a referral request may start in a Draft status and then be submitted for approval. Depending on the configured characteristics of the service or providers identified in the request, the request may not be allowed to automatically move to the Approved status. Instead, it may require prior review and preauthorization. It may also require an electronic signature by a referring practitioner prior to being moved to the Submitted or Approved status. Once a referral request is in the Submitted status, a reviewing referral coordinator may add activity and a note to the referral asking for additional information from the requesting provider. Another example is adding an activity to change a request to one of the following statuses:

Activities for referral requests have corresponding pending and completion states. For example, an activity of NEED_MORE_INFO has a corresponding activity of INFO_UPDATED.

URL: https://cernerdemo.api.us.healtheintent.com/referral/v1

Referral Requests

Referral requests can be generated by one provider to refer a patient to another provider or specialist for specific health care services such as treatments, labs, radiology and imaging, assessments, or consults.

Retrieve a List of Referral Requests by Patient

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/referral/v1/populations/005769fa-ffc0-11e7-a3d6-46705f8c9e77/patients/ae5769fa-ffc0-11e7-a3d6-46705f8c9e77/referral-requests', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/referral/v1/populations/005769fa-ffc0-11e7-a3d6-46705f8c9e77/patients/ae5769fa-ffc0-11e7-a3d6-46705f8c9e77/referral-requests \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "d81f8d60ffbd11e7a3d646705f8c9e77",
      "referralNumber": "R000001",
      "status": "DRAFT",
      "intent": {
        "code": "Proposal",
        "system": "https://hl7.org/fhir/request-intent",
        "display": "Proposal"
      },
      "priority": {
        "code": "urgent",
        "system": "https://hl7.org/fhir/request-priority",
        "display": "Emergent"
      },
      "serviceRequested": {
        "id": "f97d42caffbf11e7a3d646705f8c9e77",
        "name": "CT Scan - Spine"
      },
      "serviceCategory": {
        "id": "2687a170ffc011e7a3d646705f8c9e77",
        "name": "Radiology"
      },
      "patient": {
        "id": "ae5769fa-ffc0-11e7-a3d6-46705f8c9e77",
        "name": "Smith, Howard",
        "address": {
          "use": "WORK",
          "text": "200 East chestnut blvd, Fairbury, Illinois 61739",
          "lines": [
            "200 East chestnut blvd"
          ],
          "city": "Bel Air",
          "state": "Illinois",
          "postalCode": "61739",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "815-452-6754"
          }
        ]
      },
      "diagnoses": [
        {
          "text": "Abnormal findings on Diagnostic imaging of central nervous system",
          "codings": [
            {
              "code": "R90",
              "system": "https://hl7.org/fhir/sid/icd-10",
              "display": "Abnormal findings on Diagnostic imaging of central nervous system"
            }
          ]
        }
      ],
      "providerAuthorization": {
        "authorizedBy": {
          "id": "3ccba232-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Babbin, Lindsey"
        },
        "authorizedAt": "2017-08-21T23:14:53.924Z"
      },
      "basedOn": {
        "id": "af0ced42ffc111e7a3d646705f8c9e77"
      },
      "referredFrom": {
        "requester": {
          "id": "3ccba232-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Babbin, Lindsey",
          "address": {
            "use": "WORK",
            "text": "3000 N Halsted St, Suite 401, Chicago, IL 60657",
            "lines": [
              "3000 N Halsted St",
              "Suite 401"
            ],
            "city": "Chicago",
            "state": "IL",
            "postalCode": "60657",
            "country": "USA"
          },
          "telecoms": [
            {
              "system": "PHONE",
              "value": "773-935-5985"
            }
          ]
        },
        "onBehalfOf": {
          "id": "35ada243-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Premier Clinic"
        }
      },
      "referredTo": [
        {
          "performer": {
            "kind": "PERSONNEL",
            "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
            "name": "Jaimes, Harold, H",
            "address": {
              "use": "WORK",
              "text": "140 Smith dr, Jackson City, Maryland 17686",
              "lines": [
                "140 Smith dr"
              ],
              "city": "Jackson City",
              "state": "Maryland",
              "postalCode": "17686",
              "country": "USA"
            },
            "telecoms": [
              {
                "system": "PHONE",
                "value": "344-545-3435"
              }
            ],
            "npi": "45456454",
            "specialty": "Neurology"
          },
          "onBehalfOf": {
            "id": "89d62290-ffc2-11e7-a3d6-46705f8c9e77",
            "name": "Christ Medical Center"
          },
          "location": {
            "id": "a35e2820-ffc2-11e7-a3d6-46705f8c9e77",
            "name": "Oak Lawn Office"
          }
        },
        {
          "performer": {
            "kind": "ORGANIZATION",
            "id": "ff647cc13-5e41-1e8b-b469-f2d0284914c",
            "name": "Memorial 1st Hospital - Neurology",
            "address": {
              "use": "WORK",
              "text": "855 N Wolfe St, Silver Spring, MD 20902",
              "lines": [
                "855 N Wolfe St"
              ],
              "city": "Silver Spring",
              "state": "MD",
              "postalCode": "20902",
              "country": "USA"
            },
            "telecoms": [
              {
                "system": "PHONE",
                "value": "410-955-9441"
              }
            ],
            "npi": "1356346100",
            "specialty": "Neurology"
          },
          "location": {
            "id": "47f029a03-d8b1-1e8b-b469-f2d0284914c",
            "name": "Memorial 1st Hospital"
          }
        }
      ],
      "primaryCarePhysician": {
        "id": "47f02a9a-3d8b-11e8-bb46-9f2d0284914c",
        "name": "Robert Fewin",
        "address": {
          "use": "WORK",
          "text": "10770 Hickory Ridge Rd, Bel Air, MD 21014",
          "lines": [
            "10770 Hickory Ridge Rd"
          ],
          "city": "Bel Air",
          "state": "MD",
          "postalCode": "21014",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "345-123-3422"
          }
        ]
      },
      "benefitCoverage": {
        "planName": "CIGNA-HMO Bronze",
        "productName": "CIGNA-HMO",
        "subscriberName": "Smith, Howard",
        "effectiveStart": "2017-08-01",
        "effectiveEnd": "2018-08-01",
        "groupId": "10000",
        "memberId": "27933245",
        "planId": "c85c231affc211e7a3d646705f8c9e77",
        "medicalHomeId": "123423"
      },
      "payerAuthorizationNumber": "2321-A-343",
      "questionnaireResponse": {
        "id": "d4b8dbc2-ffc2-11e7-a3d6-46705f8c9e77"
      },
      "supportingInfo": "Patient has nausea and headache",
      "numberOfVisits": "1",
      "reason": "Central nervous system malformation in fetus affecting obstetrical care",
      "effectiveStart": "2017-08-21",
      "effectiveEnd": "2017-11-21",
      "encounterType": "OUTPATIENT",
      "lastMenstrualPeriodDate": "2017-02-15",
      "updatedBy": {
        "id": "0cfec0dc-ffbe-11e7-a3d6-46705f8c9e77",
        "name": "Klarquist, Thomas, Edwin"
      },
      "updatedAt": "2017-08-25T16:14:53.834Z",
      "createdBy": {
        "id": "1ccbda10-ffc1-11e7-a3d6-46705f8c9e77",
        "name": "FLORES, RAMON"
      },
      "createdAt": "2017-08-21T16:14:53.235Z"
    },
    {
      "id": "d81f8234ffbd11e7a3d6-46705f8c9e77",
      "referralNumber": "R000002",
      "status": "SUBMITTED",
      "activities": [
        "WAITING_FOR_AUTH"
      ],
      "intent": {
        "code": "Proposal",
        "system": "https://hl7.org/fhir/request-intent",
        "display": "Proposal"
      },
      "priority": {
        "code": "routine",
        "system": "https://hl7.org/fhir/request-priority",
        "display": "Routine"
      },
      "serviceRequested": {
        "id": "b97d42caffbf11e7a3d646705f8c9e96",
        "name": "Tympanostomy Tube Placement"
      },
      "serviceCategory": {
        "id": "2687ab2d0ffc011e7a3d646705f8c9e77",
        "name": "Pediatric Otolaryngology "
      },
      "patient": {
        "id": "eb35fabe-004a-11e8-a3d6-46705f8c9e77",
        "name": "John, Splilburg",
        "address": {
          "use": "WORK",
          "text": "100 Shoen Road, Chicago, Illinois 61739",
          "lines": [
            "100 Shoen Road"
          ],
          "city": "Chicago",
          "state": "Illinois",
          "postalCode": "61739",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "815-123-5115"
          }
        ]
      },
      "diagnoses": [
        {
          "text": "Abnormal findings on Diagnostic imaging of central nervous system",
          "codings": [
            {
              "code": "Z96.22",
              "system": "https://hl7.org/fhir/sid/icd-10",
              "display": "Abnormal findings on diagnostic imaging of central nervous system"
            }
          ]
        }
      ],
      "referredFrom": {
        "requester": {
          "id": "3ccba232-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Babbin, Lindsey",
          "address": {
            "use": "WORK",
            "text": "3000 N Halsted St, Suite 401, Chicago, IL 60657",
            "lines": [
              "3000 N Halsted St",
              "Suite 401"
            ],
            "city": "Chicago",
            "state": "IL",
            "postalCode": "60657",
            "country": "USA"
          },
          "telecoms": [
            {
              "system": "PHONE",
              "value": "773-935-5985"
            }
          ]
        },
        "onBehalfOf": {
          "id": "35ada243-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Premier Clinic"
        }
      },
      "referredTo": [
        {
          "performer": {
            "kind": "PERSONNEL",
            "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
            "name": "Jaimes, Harold, H",
            "address": {
              "use": "WORK",
              "text": "140 Smith dr, Jackson City, Maryland 17686",
              "lines": [
                "140 Smith dr"
              ],
              "city": "Jackson City",
              "state": "Maryland",
              "postalCode": "17686",
              "country": "USA"
            },
            "telecoms": [
              {
                "system": "PHONE",
                "value": "344-545-3435"
              }
            ],
            "npi": "45456454",
            "specialty": "Neurology"
          },
          "onBehalfOf": {
            "id": "89d62290-ffc2-11e7-a3d6-46705f8c9e77",
            "name": "Christ Medical Center"
          },
          "location": {
            "id": "a35e2820-ffc2-11e7-a3d6-46705f8c9e77",
            "name": "Oak Lawn Office"
          }
        },
        {
          "performer": {
            "kind": "ORGANIZATION",
            "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
            "name": "Memorial 1st Hospital - Neurology",
            "address": {
              "use": "WORK",
              "text": "855 N Wolfe St, Silver Spring, MD 20902",
              "lines": [
                "855 N Wolfe St"
              ],
              "city": "Silver Spring",
              "state": "MD",
              "postalCode": "20902",
              "country": "USA"
            },
            "telecoms": [
              {
                "system": "PHONE",
                "value": "410-955-9441"
              }
            ],
            "npi": "1356346100",
            "specialty": "Neurology"
          },
          "location": {
            "id": "47f029a0-3d8b-11e8-bb46-9f2d0284914c",
            "name": "Memorial 1st Hospital"
          }
        }
      ],
      "primaryCarePhysician": {
        "id": "47f029a0-3d8b-11e8-bb46-9f2d0284914c",
        "name": "Robert Fewin",
        "address": {
          "use": "WORK",
          "text": "10770 Hickory Ridge Rd, Bel Air, MD 21014",
          "lines": [
            "10770 Hickory Ridge Rd"
          ],
          "city": "Bel Air",
          "state": "MD",
          "postalCode": "21014",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "345-123-3422"
          }
        ]
      },
      "benefitCoverage": {
        "planName": "CIGNA-HMO Bronze",
        "productName": "CIGNA-HMO",
        "subscriberName": "John, Splilburg",
        "effectiveStart": "2017-08-01",
        "effectiveEnd": "2018-08-01",
        "groupId": "10000",
        "memberId": "27933245",
        "planId": "c85c231affc211e7a3d646705f8c9e77",
        "medicalHomeId": "123423"
      },
      "payerAuthorizationNumber": "2321-A-343",
      "supportingInfo": "Patient has accumulated wax on left ear",
      "numberOfVisits": "1",
      "reason": "Ear infection",
      "effectiveStart": "2017-08-01",
      "effectiveEnd": "2017-10-31",
      "encounterType": "OUTPATIENT",
      "lastMenstrualPeriodDate": "2017-02-15",
      "updatedBy": {
        "id": "0cfdcdd0dc-ffbe-11e7-a3d6-46705f8c9e77",
        "name": "Klarquist, Thomas, Edwin"
      },
      "updatedAt": "2017-08-25T16:14:53.221Z",
      "createdBy": {
        "id": "116ebcd4-004b-11e8-a3d6-46705f8c9e77",
        "name": "Kevin, Koo"
      },
      "createdAt": "2017-08-21T16:14:53.345Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles?offset=0&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/referral-requests

Retrieves a list of referral requests for the specified patient.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
patientId path string true N/A The ID of the patient. -
personnelId query string false N/A The ID of a personnel member who belongs to a referral system and has access to a subset of the referrals based on their membership (member or administrative) relationship to their organization. Specifying this parameter filters the list of referrals to those to which the organization account has access. As a member of the organization, only those referrals with the personnel ID as the submitter, requester, or recipient are retrieved by the API. As an administrator of an organization, all referrals sent to or from that organization are sent. -
organizationId query string false N/A The organization of which the specified personnelId is a member. If organizationId is specified, the personnelId parameter must also be specified. -
referredFromPersonnelId query string false N/A The ID of the personnel member who requested the referral. -
referredToPersonnelId query string false N/A The ID of the personnel member who is the recipient of the referral. -
referredToOrganizationId query string false N/A The ID of the organization or practice that is the recipient of the referral. -
referralNumber query string false N/A This is the human-readable ID that can be displayed when a referral is viewed or printed. -
status query array[string] false N/A The status of the referral request. One or more than one value can be selected. -
serviceTypeId query string false N/A The service type for which the referrals are created. -
serviceCategoryId query string false N/A The service category for which the referrals are created. -
statusRangeBeginAt query string false N/A Filters by referrals with a current status date that occurs on or after the provided date, in ISO 8601 format YYYY-MM-DD. -
statusRangeEndAt query string false N/A Filters by referrals with a current status date that occurs on or before the provided date, in ISO 8601 format YYYY-MM-DD. -
offset query integer(int32) false N/A The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false createdAt Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). createdAt, -createdAt, submittedAt, -submittedAt, patientName, -patientName, status, -status, requestedBy, -requestedBy, recipientBy, -recipientBy, serviceTypeName, -serviceTypeName, payerName, -payerName, priority, -priority

Response Statuses

Status Meaning Description Schema
200 OK Collection of referral request objects ReferralRequests
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a Referral Request

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/referral/v1/populations/005769fa-ffc0-11e7-a3d6-46705f8c9e77/patients/ae5769fa-ffc0-11e7-a3d6-46705f8c9e77/referral-requests', headers: headers, body: {"status":"ACCEPTED","activities":"NEED_MORE_INFO","numberOfVisits":"1","supportingInfo":"Patient has nausea and headache","treatment":"Chest X-Ray","payerAuthorizationNumber":"2321-A-343","reason":"Central nervous system malformation in fetus affecting obstetrical care","effectiveStart":"2017-08-21","effectiveEnd":"2017-11-21","serviceDate":"2017-11-21","estimatedDateOfBirth":"1988-11-21","lastMenstrualPeriodDate":"2018-11-21","assistantName":"John, Splilburg","encounterType":"INPATIENT"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/referral/v1/populations/005769fa-ffc0-11e7-a3d6-46705f8c9e77/patients/ae5769fa-ffc0-11e7-a3d6-46705f8c9e77/referral-requests \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"status":"ACCEPTED","activities":"NEED_MORE_INFO","numberOfVisits":"1","supportingInfo":"Patient has nausea and headache","treatment":"Chest X-Ray","payerAuthorizationNumber":"2321-A-343","reason":"Central nervous system malformation in fetus affecting obstetrical care","effectiveStart":"2017-08-21","effectiveEnd":"2017-11-21","serviceDate":"2017-11-21","estimatedDateOfBirth":"1988-11-21","lastMenstrualPeriodDate":"2018-11-21","assistantName":"John, Splilburg","encounterType":"INPATIENT"}

POST /populations/{populationId}/patients/{patientId}/referral-requests

Creates a referral request.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
patientId path string true N/A The ID of the patient. -
body body postPopulationsPopulationidPatientsPatientidReferralRequests true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content ReferralRequest
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created referral request.

Retrieve a List of Referral Requests

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "d81f8d60ffbd11e7a3d646705f8c9e77",
      "referralNumber": "R000001",
      "status": "DRAFT",
      "intent": {
        "code": "Proposal",
        "system": "https://hl7.org/fhir/request-intent",
        "display": "Proposal"
      },
      "priority": {
        "code": "urgent",
        "system": "https://hl7.org/fhir/request-priority",
        "display": "Emergent"
      },
      "serviceRequested": {
        "id": "f97d42caffbf11e7a3d646705f8c9e77",
        "name": "CT Scan - Spine"
      },
      "serviceCategory": {
        "id": "2687a170ffc011e7a3d646705f8c9e77",
        "name": "Radiology"
      },
      "patient": {
        "id": "ae5769fa-ffc0-11e7-a3d6-46705f8c9e77",
        "name": "Smith, Howard",
        "address": {
          "use": "WORK",
          "text": "200 East chestnut blvd, Fairbury, Illinois 61739",
          "lines": [
            "200 East chestnut blvd"
          ],
          "city": "Bel Air",
          "state": "Illinois",
          "postalCode": "61739",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "815-452-6754"
          }
        ]
      },
      "diagnoses": [
        {
          "text": "Abnormal findings on Diagnostic imaging of central nervous system",
          "codings": [
            {
              "code": "R90",
              "system": "https://hl7.org/fhir/sid/icd-10",
              "display": "Abnormal findings on Diagnostic imaging of central nervous system"
            }
          ]
        }
      ],
      "providerAuthorization": {
        "authorizedBy": {
          "id": "3ccba232-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Babbin, Lindsey"
        },
        "authorizedAt": "2017-08-21T23:14:53.924Z"
      },
      "basedOn": {
        "id": "af0ced42ffc111e7a3d646705f8c9e77"
      },
      "referredFrom": {
        "requester": {
          "id": "3ccba232-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Babbin, Lindsey",
          "address": {
            "use": "WORK",
            "text": "3000 N Halsted St, Suite 401, Chicago, IL 60657",
            "lines": [
              "3000 N Halsted St",
              "Suite 401"
            ],
            "city": "Chicago",
            "state": "IL",
            "postalCode": "60657",
            "country": "USA"
          },
          "telecoms": [
            {
              "system": "PHONE",
              "value": "773-935-5985"
            }
          ]
        },
        "onBehalfOf": {
          "id": "35ada243-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Premier Clinic"
        }
      },
      "referredTo": [
        {
          "performer": {
            "kind": "PERSONNEL",
            "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
            "name": "Jaimes, Harold, H",
            "address": {
              "use": "WORK",
              "text": "140 Smith dr, Jackson City, Maryland 17686",
              "lines": [
                "140 Smith dr"
              ],
              "city": "Jackson City",
              "state": "Maryland",
              "postalCode": "17686",
              "country": "USA"
            },
            "telecoms": [
              {
                "system": "PHONE",
                "value": "344-545-3435"
              }
            ],
            "npi": "45456454",
            "specialty": "Neurology"
          },
          "onBehalfOf": {
            "id": "89d62290-ffc2-11e7-a3d6-46705f8c9e77",
            "name": "Christ Medical Center"
          },
          "location": {
            "id": "a35e2820-ffc2-11e7-a3d6-46705f8c9e77",
            "name": "Oak Lawn Office"
          }
        },
        {
          "performer": {
            "kind": "ORGANIZATION",
            "id": "ff647cc13-5e41-1e8b-b469-f2d0284914c",
            "name": "Memorial 1st Hospital - Neurology",
            "address": {
              "use": "WORK",
              "text": "855 N Wolfe St, Silver Spring, MD 20902",
              "lines": [
                "855 N Wolfe St"
              ],
              "city": "Silver Spring",
              "state": "MD",
              "postalCode": "20902",
              "country": "USA"
            },
            "telecoms": [
              {
                "system": "PHONE",
                "value": "410-955-9441"
              }
            ],
            "npi": "1356346100",
            "specialty": "Neurology"
          },
          "location": {
            "id": "47f029a03-d8b1-1e8b-b469-f2d0284914c",
            "name": "Memorial 1st Hospital"
          }
        }
      ],
      "primaryCarePhysician": {
        "id": "47f02a9a-3d8b-11e8-bb46-9f2d0284914c",
        "name": "Robert Fewin",
        "address": {
          "use": "WORK",
          "text": "10770 Hickory Ridge Rd, Bel Air, MD 21014",
          "lines": [
            "10770 Hickory Ridge Rd"
          ],
          "city": "Bel Air",
          "state": "MD",
          "postalCode": "21014",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "345-123-3422"
          }
        ]
      },
      "benefitCoverage": {
        "planName": "CIGNA-HMO Bronze",
        "productName": "CIGNA-HMO",
        "subscriberName": "Smith, Howard",
        "effectiveStart": "2017-08-01",
        "effectiveEnd": "2018-08-01",
        "groupId": "10000",
        "memberId": "27933245",
        "planId": "c85c231affc211e7a3d646705f8c9e77",
        "medicalHomeId": "123423"
      },
      "payerAuthorizationNumber": "2321-A-343",
      "questionnaireResponse": {
        "id": "d4b8dbc2-ffc2-11e7-a3d6-46705f8c9e77"
      },
      "supportingInfo": "Patient has nausea and headache",
      "numberOfVisits": "1",
      "reason": "Central nervous system malformation in fetus affecting obstetrical care",
      "effectiveStart": "2017-08-21",
      "effectiveEnd": "2017-11-21",
      "encounterType": "OUTPATIENT",
      "lastMenstrualPeriodDate": "2017-02-15",
      "updatedBy": {
        "id": "0cfec0dc-ffbe-11e7-a3d6-46705f8c9e77",
        "name": "Klarquist, Thomas, Edwin"
      },
      "updatedAt": "2017-08-25T16:14:53.834Z",
      "createdBy": {
        "id": "1ccbda10-ffc1-11e7-a3d6-46705f8c9e77",
        "name": "FLORES, RAMON"
      },
      "createdAt": "2017-08-21T16:14:53.235Z"
    },
    {
      "id": "d81f8234ffbd11e7a3d6-46705f8c9e77",
      "referralNumber": "R000002",
      "status": "SUBMITTED",
      "activities": [
        "WAITING_FOR_AUTH"
      ],
      "intent": {
        "code": "Proposal",
        "system": "https://hl7.org/fhir/request-intent",
        "display": "Proposal"
      },
      "priority": {
        "code": "routine",
        "system": "https://hl7.org/fhir/request-priority",
        "display": "Routine"
      },
      "serviceRequested": {
        "id": "b97d42caffbf11e7a3d646705f8c9e96",
        "name": "Tympanostomy Tube Placement"
      },
      "serviceCategory": {
        "id": "2687ab2d0ffc011e7a3d646705f8c9e77",
        "name": "Pediatric Otolaryngology "
      },
      "patient": {
        "id": "eb35fabe-004a-11e8-a3d6-46705f8c9e77",
        "name": "John, Splilburg",
        "address": {
          "use": "WORK",
          "text": "100 Shoen Road, Chicago, Illinois 61739",
          "lines": [
            "100 Shoen Road"
          ],
          "city": "Chicago",
          "state": "Illinois",
          "postalCode": "61739",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "815-123-5115"
          }
        ]
      },
      "diagnoses": [
        {
          "text": "Abnormal findings on Diagnostic imaging of central nervous system",
          "codings": [
            {
              "code": "Z96.22",
              "system": "https://hl7.org/fhir/sid/icd-10",
              "display": "Abnormal findings on diagnostic imaging of central nervous system"
            }
          ]
        }
      ],
      "referredFrom": {
        "requester": {
          "id": "3ccba232-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Babbin, Lindsey",
          "address": {
            "use": "WORK",
            "text": "3000 N Halsted St, Suite 401, Chicago, IL 60657",
            "lines": [
              "3000 N Halsted St",
              "Suite 401"
            ],
            "city": "Chicago",
            "state": "IL",
            "postalCode": "60657",
            "country": "USA"
          },
          "telecoms": [
            {
              "system": "PHONE",
              "value": "773-935-5985"
            }
          ]
        },
        "onBehalfOf": {
          "id": "35ada243-ffc1-11e7-a3d6-46705f8c9e77",
          "name": "Premier Clinic"
        },
        "referredTo": [
          {
            "performer": {
              "kind": "PERSONNEL",
              "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
              "name": "Jaimes, Harold, H",
              "address": {
                "use": "WORK",
                "text": "140 Smith dr, Jackson City, Maryland 17686",
                "lines": [
                  "140 Smith dr"
                ],
                "city": "Jackson City",
                "state": "Maryland",
                "postalCode": "17686",
                "country": "USA"
              },
              "telecoms": [
                {
                  "system": "PHONE",
                  "value": "344-545-3435"
                }
              ],
              "npi": "45456454",
              "specialty": "Neurology"
            },
            "onBehalfOf": {
              "id": "89d62290-ffc2-11e7-a3d6-46705f8c9e77",
              "name": "Christ Medical Center"
            },
            "location": {
              "id": "a35e2820-ffc2-11e7-a3d6-46705f8c9e77",
              "name": "Oak Lawn Office"
            }
          },
          {
            "performer": {
              "kind": "ORGANIZATION",
              "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
              "name": "Memorial 1st Hospital - Neurology",
              "address": {
                "use": "WORK",
                "text": "855 N Wolfe St, Silver Spring, MD 20902",
                "lines": [
                  "855 N Wolfe St"
                ],
                "city": "Silver Spring",
                "state": "MD",
                "postalCode": "20902",
                "country": "USA"
              },
              "telecoms": [
                {
                  "system": "PHONE",
                  "value": "410-955-9441"
                }
              ],
              "npi": "1356346100",
              "specialty": "Neurology"
            },
            "location": {
              "id": "47f029a0-3d8b-11e8-bb46-9f2d0284914c",
              "name": "Memorial 1st Hospital"
            }
          }
        ]
      },
      "primaryCarePhysician": {
        "id": "47f029a0-3d8b-11e8-bb46-9f2d0284914c",
        "name": "Robert Fewin",
        "address": {
          "use": "WORK",
          "text": "10770 Hickory Ridge Rd, Bel Air, MD 21014",
          "lines": [
            "10770 Hickory Ridge Rd"
          ],
          "city": "Bel Air",
          "state": "MD",
          "postalCode": "21014",
          "country": "USA"
        },
        "telecoms": [
          {
            "system": "PHONE",
            "value": "345-123-3422"
          }
        ]
      },
      "benefitCoverage": {
        "planName": "CIGNA-HMO Bronze",
        "productName": "CIGNA-HMO",
        "subscriberName": "John, Splilburg",
        "effectiveStart": "2017-08-01",
        "effectiveEnd": "2018-08-01",
        "groupId": "10000",
        "memberId": "27933245",
        "planId": "c85c231affc211e7a3d646705f8c9e77",
        "medicalHomeId": "123423"
      },
      "payerAuthorizationNumber": "2321-A-343",
      "supportingInfo": "Patient has accumulated wax on left ear",
      "numberOfVisits": "1",
      "reason": "Ear infection",
      "effectiveStart": "2017-08-01",
      "effectiveEnd": "2017-10-31",
      "encounterType": "OUTPATIENT",
      "lastMenstrualPeriodDate": "2017-02-15",
      "updatedBy": {
        "id": "0cfdcdd0dc-ffbe-11e7-a3d6-46705f8c9e77",
        "name": "Klarquist, Thomas, Edwin"
      },
      "updatedAt": "2017-08-25T16:14:53.221Z",
      "createdBy": {
        "id": "116ebcd4-004b-11e8-a3d6-46705f8c9e77",
        "name": "Kevin, Koo"
      },
      "createdAt": "2017-08-21T16:14:53.345Z"
    }
  ],
  "totalResults": "2",
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests?offset=0&limit=5",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests?offset=0&limit=5"
}

GET /referral-requests

Retrieves a list of referral requests.

Parameters

Parameter In Type Required Default Description Accepted Values
personnelId query string false N/A The ID of a personnel member who belongs to a referral system and has access to a subset of the referrals based on their membership (member or administrative) relationship to their organization. Specifying this parameter filters the list of referrals to those to which the organization account has access. As a member of the organization, only those referrals with the personnel ID as the submitter, requester, or recipient are retrieved by the API. As an administrator of an organization, all referrals sent to or from that organization are sent. -
organizationId query string false N/A The organization of which the specified personnelId is a member. If organizationId is specified, the personnelId parameter must also be specified. -
referredFromPersonnelId query string false N/A The ID of the personnel member who requested the referral. -
referredToPersonnelId query string false N/A The ID of the personnel member who is the recipient of the referral. -
referredToOrganizationId query string false N/A The ID of the organization or practice that is the recipient of the referral. -
referralNumber query string false N/A This is the human-readable ID that can be displayed when a referral is viewed or printed. -
status query array[string] false N/A The status of the referral request. One or more than one value can be selected. -
serviceTypeId query string false N/A The service type for which the referrals are created. -
serviceCategoryId query string false N/A The service category for which the referrals are created. -
statusRangeBeginAt query string false N/A Filters by referrals with a current status date that occurs on or after the provided date, in ISO 8601 format YYYY-MM-DD. -
statusRangeEndAt query string false N/A Filters by referrals with a current status date that occurs on or before the provided date, in ISO 8601 format YYYY-MM-DD. -
offset query integer(int32) false N/A The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false createdAt Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). createdAt, -createdAt, submittedAt, -submittedAt, patientName, -patientName, status, -status, requestedBy, -requestedBy, recipientBy, -recipientBy, serviceTypeName, -serviceTypeName, payerName, -payerName, priority, -priority

Response Statuses

Status Meaning Description Schema
200 OK Collection of referral request objects ReferralRequests
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Referral Request

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "d81f8d60ffbd11e7a3d646705f8c9e77",
  "referralNumber": "R000001",
  "status": "ACTIVE",
  "statusReason": "The insurance company denied referral.",
  "activities": [
    "NEED_MORE_INFO"
  ],
  "intent": {},
  "priority": {},
  "serviceRequested": {
    "id": "f97d42caffbf11e7a3d646705f8c9e77",
    "name": "CT Scan - Spine"
  },
  "serviceCategory": {
    "id": "2687a170ffc011e7a3d646705f8c9e77",
    "name": "Radiology"
  },
  "patient": {
    "address": {
      "city": "Bel Air",
      "country": "USA",
      "lines": [
        "10236 Marion Park Dr"
      ],
      "postalCode": "61739",
      "state": "MO",
      "text": "10236 Marion Park Dr, Kansas City, MO 64137",
      "use": "HOME"
    },
    "id": "ae5769fa-ffc0-11e7-a3d6-46705f8c9e77",
    "name": "Smith, Howard",
    "telecoms": [
      {
        "system": "EMAIL",
        "value": "jane.smith@example.com"
      }
    ]
  },
  "diagnoses": [
    {
      "codings": [
        {}
      ],
      "sourceCodings": [
        {}
      ]
    }
  ],
  "procedures": [
    {
      "codings": [
        {}
      ],
      "sourceCodings": [
        {}
      ]
    }
  ],
  "providerAuthorization": {
    "authorizedAt": "2017-08-27T12:14:53.924Z",
    "authorizedBy": {
      "id": "3ccba232-ffc1-11e7-a3d6-46705f8c9e77",
      "name": "Babbin, Lindsey"
    }
  },
  "basedOn": {
    "id": "af0ced42ffc111e7a3d646705f8c9e77"
  },
  "referredFrom": {
    "requester": {
      "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
      "name": "Robert Fewin",
      "address": {
        "city": "Bel Air",
        "country": "USA",
        "lines": [
          "10236 Marion Park Dr"
        ],
        "postalCode": "61739",
        "state": "MO",
        "text": "10236 Marion Park Dr, Kansas City, MO 64137",
        "use": "HOME"
      },
      "telecoms": [
        {
          "system": "EMAIL",
          "value": "jane.smith@example.com"
        }
      ]
    },
    "onBehalfOf": {
      "id": "35ada243-ffc1-11e7-a3d6-46705f8c9e77",
      "name": "Premier Clinic"
    }
  },
  "referredTo": {
    "performer": {
      "kind": "PERSONNEL",
      "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
      "name": "Robert Fewin",
      "address": {
        "city": "Bel Air",
        "country": "USA",
        "lines": [
          "10236 Marion Park Dr"
        ],
        "postalCode": "61739",
        "state": "MO",
        "text": "10236 Marion Park Dr, Kansas City, MO 64137",
        "use": "HOME"
      },
      "telecoms": [
        {
          "system": "EMAIL",
          "value": "jane.smith@example.com"
        }
      ],
      "npi": "45456454",
      "comment": "Some comments.",
      "specialty": "Neurology"
    },
    "onBehalfOf": {
      "id": "35ada243-ffc1-11e7-a3d6-46705f8c9e77",
      "name": "Premier Clinic"
    },
    "location": {
      "id": "47f029a0-3d8b-11e8-bb46-9f2d0284914c",
      "name": "Memorial 1st Hospital"
    }
  },
  "primaryCarePhysician": {
    "id": "f8a9ccc2-ffc1-11e7-a3d6-46705f8c9e77",
    "name": "Robert Fewin",
    "address": {
      "city": "Bel Air",
      "country": "USA",
      "lines": [
        "10236 Marion Park Dr"
      ],
      "postalCode": "61739",
      "state": "MO",
      "text": "10236 Marion Park Dr, Kansas City, MO 64137",
      "use": "HOME"
    },
    "telecoms": [
      {
        "system": "EMAIL",
        "value": "jane.smith@example.com"
      }
    ]
  },
  "benefitCoverage": {
    "planId": "c85c231affc211e7a3d646705f8c9e77",
    "planName": "CIGNA-HMO Bronze",
    "medicalHomeId": "123423",
    "groupId": "10000",
    "memberId": "27933245",
    "productName": "CIGNA-HMO",
    "subscriberName": "John, Splilburg",
    "comment": "Some comment.",
    "effectiveStart": "2017-08-25T16:14:53.834Z",
    "effectiveEnd": "2017-08-25T16:14:53.834Z"
  },
  "payerAuthorizationNumber": "12345",
  "questionnaireResponse": {
    "id": "d4b8dbc2-ffc2-11e7-a3d6-46705f8c9e77"
  },
  "supportingInfo": "Patient has accumulated wax on left ear",
  "numberOfVisits": "1",
  "treatment": "Chest X-Ray",
  "reason": "Central nervous system malformation in fetus affecting obstetrical care.",
  "effectiveStart": "1999-02-15",
  "effectiveEnd": "2018-02-15",
  "serviceDate": "2017-02-15",
  "estimatedDateOfBirth": "1999-02-15",
  "encounterType": "INPATIENT",
  "lastMenstrualPeriodDate": "2017-02-15",
  "assistantName": "John Smith",
  "updatedBy": {
    "id": "0cfec0dc-ffbe-11e7-a3d6-46705f8c9e77",
    "name": "FLORES, RAMON"
  },
  "updatedAt": "2018-02-13T20:41:18.181Z",
  "createdBy": {
    "id": "47f029a0-3d8b-11e8-bb46-9f2d0284914c",
    "name": "Kevin, Koo"
  },
  "createdAt": "2018-02-13T20:41:18.181Z"
}

GET /referral-requests/{referralId}

Retrieves a single referral request.

Parameters

Parameter In Type Required Default Description Accepted Values
referralId path string true N/A The unique system-generated ID of the referral. -

Response Statuses

Status Meaning Description Schema
200 OK Single referral request object ReferralRequest
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Referral Request

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
}

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000', headers: headers, body: {"status":"ACCEPTED","statusReason":"The insurance company is denied to accept your referral","activities":["NEED_MORE_INFO"],"numberOfVisits":"1","supportingInfo":"Patient has nausea and headache","treatment":"Chest X-Ray","payerAuthorizationNumber":"2321-A-343","reason":"Central nervous system malformation in fetus affecting obstetrical care","effectiveStart":"2018-11-21","effectiveEnd":"2018-11-21","serviceDate":"2018-11-21","estimatedDateOfBirth":"2018-11-21","lastMenstrualPeriodDate":"2018-11-21","assistantName":"Babbin, Lindsey","encounterType":"INPATIENT"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"status":"ACCEPTED","statusReason":"The insurance company is denied to accept your referral","activities":["NEED_MORE_INFO"],"numberOfVisits":"1","supportingInfo":"Patient has nausea and headache","treatment":"Chest X-Ray","payerAuthorizationNumber":"2321-A-343","reason":"Central nervous system malformation in fetus affecting obstetrical care","effectiveStart":"2018-11-21","effectiveEnd":"2018-11-21","serviceDate":"2018-11-21","estimatedDateOfBirth":"2018-11-21","lastMenstrualPeriodDate":"2018-11-21","assistantName":"Babbin, Lindsey","encounterType":"INPATIENT"}

PUT /referral-requests/{referralId}

Updates a referral request.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A ETag for a specific version of a resource to match against. -
referralId path string true N/A The unique system-generated ID of the referral. -
body body putReferralRequests true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve the activity history of a referral request

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000/activity-history', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000/activity-history \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "status": "DENIED",
      "statusReason": "The insurance company is denied to accept your referral",
      "preAuthReasons": [
        {
          "code": "PREAUTH_SVC - Referral service requires pre-auth",
          "codeDisplay": "string"
        }
      ],
      "updatedAt": "2017-08-27T12:14:53.924Z",
      "updatedBy": {
        "id": "0cfec0dc-ffbe-11e7-a3d6-46705f8c9e77",
        "name": "Klarquist, Thomas, Edwin"
      }
    },
    {
      "status": "SUBMITTED",
      "activities": [
        "INFO_UPDATED",
        "WAITING_FOR_AUTH"
      ],
      "preAuthReasons": [
        {
          "code": "PREAUTH_SVC",
          "codeDisplay": "Referral service requires pre-auth"
        },
        {
          "code": "PREAUTH_OON_PROV",
          "codeDisplay": "Referral to an Out Of Network provider"
        }
      ],
      "updatedAt": "2017-08-25T12:14:53.835Z",
      "updatedBy": {
        "id": "21cf7afe-1000-11e8-bb469-f2d0284914c",
        "name": "Aaron Siegel"
      }
    },
    {
      "status": "SUBMITTED",
      "activities": [
        "NEED_MORE_INFO"
      ],
      "preAuthReasons": [
        {
          "code": "PREAUTH_SVC",
          "codeDisplay": "Referral service requires pre-auth"
        },
        {
          "code": "PREAUTH_OON_PROV",
          "codeDisplay": "Referral to an Out Of Network provider"
        }
      ],
      "updatedAt": "2017-08-24 16:14:53",
      "updatedBy": {
        "id": "31cf7afe-1000-11e8-bb469-f2d0284914b",
        "name": "Carlos F Smith"
      }
    },
    {
      "status": "SUBMITTED",
      "providerAuthorization": {
        "authorizedBy": {
          "id": "21cf7afe-1000-11e8-bb469-f2d0284914c",
          "name": "Aaron Siegel"
        },
        "authorizedAt": "2017-08-23T23:14:53.934Z"
      },
      "preAuthReasons": [
        {
          "code": "PREAUTH_SVC",
          "codeDisplay": "Referral service requires pre-auth"
        },
        {
          "code": "PREAUTH_OON_PROV",
          "codeDisplay": "Referral to an Out Of Network provider"
        }
      ],
      "updatedAt": "2017-08-23T16:14:53.834Z",
      "updatedBy": {
        "id": "21cf7afe-1000-11e8-bb469-f2d0284914c",
        "name": "Aaron Siegel"
      }
    },
    {
      "status": "E_SIG_REQUIRED",
      "updatedAt": "2017-08-22T16:14:53.934Z",
      "updatedBy": {
        "id": "6a3d7d6c-1678-11e8-bb46-9f2d0284914c",
        "name": "Annie john"
      }
    },
    {
      "status": "DRAFT",
      "isAuthorized": false,
      "updatedAt": "2017-08-21T16:14:53.834Z",
      "updatedBy": {
        "id": "6a3d7d6c-1678-11e8-bb46-9f2d0284914c",
        "name": "Annie john"
      }
    }
  ],
  "totalResults": 20,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e86f2f53c279098ee5c5473d3c80a3/activity-history?offset=0&limit=5",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e86f2f53c279098ee5c5473d3c80a3/activity-history?offset=0&limit=20"
}

GET /referral-requests/{referralId}/activity-history

Retrieves the activity history of a referral request.

Parameters

Parameter In Type Required Default Description Accepted Values
referralId path string true N/A The unique system-generated ID of the referral. -
offset query integer(int32) false N/A The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of referral activity objects ActivityHistoryDetails
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a Referral Note

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000/notes', headers: headers, body: {"date":"2017-08-27T12:14:53.924Z","text":"A test note on a patient.","author":{"id":"1ccbda10-ffc1-11e7-a3d6-46705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000/notes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"date":"2017-08-27T12:14:53.924Z","text":"A test note on a patient.","author":{"id":"1ccbda10-ffc1-11e7-a3d6-46705f8c9e77"}}

POST /referral-requests/{referralId}/notes

Creates a referral note.

Parameters

Parameter In Type Required Default Description Accepted Values
referralId path string true N/A The unique system-generated ID of the referral. -
body body postReferralRequestsReferralidNotes true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created referral note.

Retrieve Referral Notes

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000/notes', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e8a0b6e3d9e4b7bae9bd3b7d80000/notes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "text": "Need wheelchair assistance",
      "date": "2017-08-21T16:14:53.765Z",
      "author": {
        "id": "1021eaec-ffc3-11e7-a3d6-46705f8c9e77",
        "name": "James, B"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e86f2f53c279098ee5c5473d3c80a3/notes?offset=0&limit=5",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/referral/v1/referral-requests/11e86f2f53c279098ee5c5473d3c80a3/notes?offset=0&limit=20"
}

GET /referral-requests/{referralId}/notes

Retrieve referral notes.

Parameters

Parameter In Type Required Default Description Accepted Values
referralId path string true N/A Referral identifier for which to retrieve referral notes. -
offset query integer(int32) false N/A The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -date A comma-separated, ordered list of fields by which to sort. date, -date

Response Statuses

Status Meaning Description Schema
200 OK Collection of referral note objects Notes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

ReferralRequests

Name Type Required Description Accepted Values
items [ReferralRequest] true No description -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ReferralRequest

Name Type Required Description Accepted Values
id string true The system-generated ID that uniquely represents the referral in a referral system. -
referralNumber string true The display ID that uniquely represents the referral in a referral system. -
status string true The status of the referral request. ACCEPTED, ACTIVE, APPROVED, CANCELED, CANCELLATION_REQUESTED, COMPLETED, DENIED, DRAFT, E_SIG_REQUIRED, ENTERED_IN_ERROR, NO_SHOW, REJECTED, SCHEDULED, SPECIALIST_VISIT_COMP, SUBMITTED, SUSPENDED, UNKNOWN
statusReason string false The reason for the status if applicable, for example, the reason for denial. -
activities [string] false The activities requested in this referral request. -
intent Code false The controlled string value defined for a given code system. -
priority Code false The controlled string value defined for a given code system. -
serviceRequested ServiceRequested false The service type requested for this referral request. -
serviceCategory ServiceCategory false The service category of the service type requested for this referral request. -
patient Patient true The patient who is being referred. -
diagnoses [CodeableConcept] false One or more ICD-10 diagnosis codes associated with the referral request. -
procedures [CodeableConcept] false One or more CPT codes associated with the referral request. -
providerAuthorization ProviderAuthorization false The electronic signature given by the referring provider. -
basedOn BasedOn false The referral request upon which this referral request is based. -
referredFrom ReferredFrom false The personnel member who requested the referral. -
referredTo ReferredTo false The personnel member who is the recipient of the referral. -
primaryCarePhysician PCP false The primary care physician for this referral patient. -
benefitCoverage BenefitCoverage false The benefit coverage details of the patient. -
payerAuthorizationNumber string false The authorization number provided by the payer to indicate approval for the requested service. -
questionnaireResponse QuestionnaireResponse false The questionnaire response associated with this referral request. -
supportingInfo string false Any additional supporting information added to this referral request. This information can be viewed in a referral report. -
numberOfVisits string false The number of visits for which this referral is requested. -
treatment string false The history of treatment details to date that may be pertinent to the service requested through this referral. -
reason string false The reason text for this referral request. -
effectiveStart string false The effective start date of the referral request. in ISO 8601 format YYYY-MM-DD. -
effectiveEnd string false The effective end date of the referral request. in ISO 8601 format YYYY-MM-DD. -
serviceDate string false The expected date of service for this referral request. Mostly applicable for inpatient or surgery service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
estimatedDateOfBirth string false The estimated date of delivery if applicable for OB-GYN service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
encounterType string false The type or setting of the encounter for the referral request. INPATIENT, OUTPATIENT
lastMenstrualPeriodDate string false The last menstrual period date if applicable for OB-GYN service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
assistantName string false The optional name of the designated assistant for the patient. -
updatedBy UpdatedBy false The personnel member who is responsible for this referral update. -
updatedAt string true The date and time when the record was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ). The time in this field is set automatically every time the record is modified; therefore, the field does not need to be set explicitly. When the health concern is first created, the value in “updatedAt” is set by the service to match the value in the “createdAt” field. -
createdBy CreatedBy true The personnel who created the referral. -
createdAt string true The date and time when the record was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ). The time in this field is set automatically when the record is first created; therefore, the field does not need to be set explicitly. -

Code

Name Type Required Description Accepted Values
code string false The unique identifier of the code. -
display string false A human-readable representation of the code. -
system string false The identifier of the coding system that gives meaning to the code. -

ServiceRequested

Name Type Required Description Accepted Values
id string false The ID of the service requested. -
name string false The name of the service requested. -

ServiceCategory

Name Type Required Description Accepted Values
id string false The ID of the service category. -
name string false The name of the service category. -

Patient

Name Type Required Description Accepted Values
address Address false The address of the patient. -
id string true The unique ID of the patient in HealtheIntent. -
name string true The full name of the patient. -
telecoms [Telecom] false The form of communication for the primary care physician. This can be email, phone, or other. -

Address

Name Type Required Description Accepted Values
city string false The city of the address. -
country string false The country of the address. -
lines [string] false The street component of the address. -
postalCode string false The postal code of the address. -
state string false The state of the address. -
text string false The fully formatted address. -
use string false Purpose of the address such as HOME or WORK HOME, WORK

Telecom

Name Type Required Description Accepted Values
system string false The system for the telecom PHONE, EMAIL, OTHER
value string false The value for a telecom -

CodeableConcept

Name Type Required Description Accepted Values
codings [Code] false A list of codified values from standard code systems recognized by HealtheIntent. -
sourceCodings [Code] false The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. -
text string false This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

ProviderAuthorization

Name Type Required Description Accepted Values
authorizedAt string true The date and time of the authorization, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
authorizedBy AuthorizedBy true The ID of the personnel member who authorized this referral request. -

AuthorizedBy

Name Type Required Description Accepted Values
id string false The ID of the authorizing provider. -
name string false The name of the authorizing provider. -

BasedOn

Name Type Required Description Accepted Values
id string false The ID of the Based on object. -

ReferredFrom

Name Type Required Description Accepted Values
requester Requester true The personnel member who is the requester of this referral. -
onBehalfOf OnBehalfOf true The organization on whose behalf this referral is exchanged. -

Requester

Name Type Required Description Accepted Values
id string false The ID of provider. -
name string false The name of the provider. -
address Address false No description -
telecoms [Telecom] false No description -

OnBehalfOf

Name Type Required Description Accepted Values
id string false The ID of the on behalf of organization. -
name string false The name of the on behalf of organization. -

ReferredTo

Name Type Required Description Accepted Values
performer Performer true The personnel/organization providing services requested by the referral. -
onBehalfOf OnBehalfOf false The organization on whose behalf this referral is exchanged. -
location Location false The location where this referral service is offered. -

Performer

Name Type Required Description Accepted Values
kind string true Identifies whether the performer is a personnel member or an organization. PERSONNEL, ORGANIZATION
id string false The ID of provider. -
name string false The name of the provider. -
address Address false No description -
telecoms [Telecom] false No description -
npi string false The National Provider Identifier (NPI) of a given provider personnel member or organization. -
comment string false Additional comments and clarifications for the provider. -
specialty string false The provider’s specialty where this service is requested. -

Location

Name Type Required Description Accepted Values
id string false The ID of the location. -
name string false The name of the location. -

PCP

Name Type Required Description Accepted Values
id string false The ID of provider. -
name string false The name of the provider. -
address Address false No description -
telecoms [Telecom] false No description -

BenefitCoverage

Name Type Required Description Accepted Values
planId string false The unique plan ID. If this is populated, the returned plan and benefits coverage details are derived from a reference to a HealtheIntent payer plan definition. Otherwise, individual fields can be entered to support ad hoc benefit coverage details specific to the referral request. -
planName string false The name of the plan for this referral. -
medicalHomeId string false The unique medical home ID. If this is populated, it represents the medical home assigned to this patient. -
groupId string false The unique ID assigned to the employer that purchases this plan on behalf of covered employees. -
memberId string false The unique ID of the subscribed employee member of this plan. -
productName string false The product name of the plan for this referral. -
subscriberName string false The name of the subscriber who owns the plan. -
comment string false Any additional comments related to this plan. -
effectiveStart string false The effective start date of the insurance plan. This field can have precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ -
effectiveEnd string false The effective end date of the insurance plan. This field can have precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ -

QuestionnaireResponse

Name Type Required Description Accepted Values
id string false The ID of the questionnaire response. -

UpdatedBy

Name Type Required Description Accepted Values
id string false The ID of the updating personnel. -
name string false The name of the updating personnel. -

CreatedBy

Name Type Required Description Accepted Values
id string false The ID of the creating personnel. -
name string false The name of the creating personnel. -

Error

Name Type Required Description Accepted Values
code integer(int32) true Http response status code representing the error. -
message string true Human readable description of the error. -
errorDetails [ErrorDetail] false List of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false Codified value representing the specific error resulting in the current error status. -
message string false Human readable description of an error. -
locationType string false Location or type of the field that caused an error. query, header, path, formData, body
location string false Name of the field that caused an error. -

RequesterLite

Name Type Required Description Accepted Values
id string false The ID of the requester. -

OnBehalfOfLite

Name Type Required Description Accepted Values
id string false The ID of the on behalf of personnel. -

LocationLite

Name Type Required Description Accepted Values
id string false The ID of the location of the performer. -

AuthorizedByLite

Name Type Required Description Accepted Values
id string false The ID of the authorizing provider. -

postPopulationsPopulationidPatientsPatientidReferralRequests

Name Type Required Description Accepted Values
status string true The status of the referral request. ACCEPTED, ACTIVE, APPROVED, CANCELED, CANCELLATION_REQUESTED, COMPLETED, DENIED, DRAFT, E_SIG_REQUIRED, ENTERED_IN_ERROR, NO_SHOW, REJECTED, SCHEDULED, SPECIALIST_VISIT_COMP, SUBMITTED, SUSPENDED, UNKNOWN
statusReason string false The reason for the status if applicable, for example, the reason for denial. -
activities [string] false The activities requested in this referral request. -
numberOfVisits string false The number of visits for which this referral is requested. -
supportingInfo string false Any additional supporting information added to this referral request. This information can be viewed in a referral report. -
treatment string false The history of treatment details to date that may be pertinent to the service requested through this referral. -
referredFrom object false The personnel member who requested the referral. This field is required when referral is in SUBMITTED status. -
» requester RequesterLite true The personnel member who is the requester of this referral. -
» onBehalfOf OnBehalfOfLite true The organization on whose behalf this referral is exchanged. -
payerAuthorizationNumber string false The authorization number provided by the payer to indicate approval for the requested service. -
questionnaireResponse object false The questionnaire response associated with this referral request. -
» id string true The ID of the referencing object. -
priority object false The controlled string value defined for a given code system. This field is required when referral is in SUBMITTED status. -
» code string true The unique identifier of the code. -
» system string true The identifier of the coding system that gives meaning to the code. -
reason string false The reason text for this referral request. -
effectiveStart string false The effective start date of the referral request, in ISO 8601 format YYYY-MM-DD. -
effectiveEnd string false The effective end date of the referral request, in ISO 8601 format of YYYY-MM-DD. -
serviceDate string false The expected date of service for this referral request. Mostly applicable for inpatient or surgery service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
estimatedDateOfBirth string false The estimated date of delivery if applicable for OB-GYN service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
lastMenstrualPeriodDate string false The last menstrual period date if applicable for OB-GYN service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
assistantName string false The optional name of the designated assistant for the patient. -
encounterType string false The type or setting of the encounter for the referral request. INPATIENT, OUTPATIENT
createdBy object false No description -
» id string true The ID of the referencing object. -
serviceRequested object false No description -
» id string true The ID of the referencing object. -
serviceCategory object false No description -
» id string true The ID of the referencing object. -
basedOn object false No description -
» id string true The ID of the referencing object. -
diagnoses [object] false No description -
» codings object true A list of codified values from standard code systems recognized by HealtheIntent. -
» text string true This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -
procedures [object] false No description -
» codings object true A list of codified values from standard code systems recognized by HealtheIntent. -
» text string true This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -
referredTo [object] false No description -
» performer object true The personnel providing services requested by the referral. -
» onBehalfOf object false The organization on whose behalf this referral is exchanged. -
» location object false The location where this referral service is offered. -
primaryCarePhysician object false No description -
» id string true The ID of the referencing object. -
benefitCoverage object false No description -
» planId string true The unique plan ID. If this is populated, the returned plan and benefits coverage details are derived from a reference to a HealtheIntent payer plan definition. Otherwise, individual fields can be entered to support ad hoc benefit coverage details specific to the referral request. -
» planName string true The name of the plan for this referral. -
» medicalHomeId string true The unique medical home ID. If this is populated, it represents the medical home assigned to this patient. -
» groupId string true The unique ID assigned to the employer that purchases this plan on behalf of covered employees. -
» memberId string true The unique ID of the subscribed employee member of this plan. -
» productName string true The product name of the plan for this referral. -
» subscriberName string true The name of the subscriber who owns the plan. -
» comment string true Any additional comments related to this plan. -
» effectiveStart string true The effective start date of the insurance plan. This field can have precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ -
» effectiveEnd string true The effective end date of the insurance plan. This field can have precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ -
intent object false No description -
» code string true The unique identifier of the code. -
» system string true The identifier of the coding system that gives meaning to the code. -
providerAuthorization object false No description -
» authorizedBy AuthorizedByLite true The ID of the personnel member who authorized this referral request. -
» authorizedAt string true The date and time of the authorization, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
preAuthReasons [object] false No description -
» code string true A unique code identifying a given reason or supporting fact for this referral to qualify for automatic approval or for requiring preauthorization review. -

putReferralRequests

Name Type Required Description Accepted Values
status string true The status of the referral request. ACCEPTED, ACTIVE, APPROVED, CANCELED, CANCELLATION_REQUESTED, COMPLETED, DENIED, DRAFT, E_SIG_REQUIRED, ENTERED_IN_ERROR, NO_SHOW, REJECTED, SCHEDULED, SPECIALIST_VISIT_COMP, SUBMITTED, SUSPENDED, UNKNOWN
statusReason string false The reason for the status if applicable, for example, the reason for denial. -
activities [string] false The activities requested in this referral request. -
numberOfVisits string false The number of visits for which this referral is requested. -
supportingInfo string false Any additional supporting information added to this referral request. This information can be viewed in a referral report. -
treatment string false The history of treatment details to date that may be pertinent to the service requested through this referral. -
referredFrom object false The personnel member who requested the referral. This field is required when referral is in SUBMITTED status. -
» requester RequesterLite true The personnel member who is the requester of this referral. -
» onBehalfOf OnBehalfOfLite true The organization on whose behalf this referral is exchanged. -
payerAuthorizationNumber string false The authorization number provided by the payer to indicate approval for the requested service. -
questionnaireResponse object false The questionnaire response associated with this referral request. -
» id string true The ID of the referencing object. -
priority object false The controlled string value defined for a given code system. This field is required when referral is in SUBMITTED status. -
» code string true The unique identifier of the code. -
» system string true The identifier of the coding system that gives meaning to the code. -
reason string false The reason text for this referral request. -
effectiveStart string false The effective start date of the referral request,in ISO 8601 format YYYY-MM-DD. -
effectiveEnd string false The effective end date of the referral request,in ISO 8601 format YYYY-MM-DD -
serviceDate string false The expected date of service for this referral request. Mostly applicable for inpatient or surgery service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
estimatedDateOfBirth string false The estimated date of delivery if applicable for OB-GYN service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
lastMenstrualPeriodDate string false The last menstrual period date if applicable for OB-GYN service types. This field can have precision of YYYY-MM-DD in ISO 8601 format. -
assistantName string false The optional name of the designated assistant for the patient. -
encounterType string false The type or setting of the encounter for the referral request. INPATIENT, OUTPATIENT
updatedBy object false No description -
» id string true The ID of the referencing object. -
basedOn object false No description -
» id string true The ID of the referencing object. -
diagnoses [object] false No description -
» codings object true A list of codified values from standard code systems recognized by HealtheIntent. -
» text string true This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -
procedures [object] false No description -
» codings object true A list of codified values from standard code systems recognized by HealtheIntent. -
» text string true This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -
referredTo [object] false No description -
» performer object true The personnel providing services requested by the referral. -
» onBehalfOf object false The organization on whose behalf this referral is exchanged. -
» location object false The location where this referral service is offered. -
primaryCarePhysician object false No description -
» id string true The ID of the referencing object. -
benefitCoverage object false No description -
» planId string true The unique plan ID. If this is populated, the returned plan and benefits coverage details are derived from a reference to a HealtheIntent payer plan definition. Otherwise, individual fields can be entered to support ad hoc benefit coverage details specific to the referral request. -
» planName string true The name of the plan for this referral. -
» medicalHomeId string true The unique medical home ID. If this is populated, it represents the medical home assigned to this patient. -
» groupId string true The unique ID assigned to the employer that purchases this plan on behalf of covered employees. -
» memberId string true The unique ID of the subscribed employee member of this plan. -
» productName string true The product name of the plan for this referral. -
» subscriberName string true The name of the subscriber who owns the plan. -
» comment string true Any additional comments related to this plan. -
» effectiveStart string true The effective start date of the insurance plan. This field can have precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ -
» effectiveEnd string true The effective end date of the insurance plan. This field can have precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ -
intent object false No description -
» code string true The unique identifier of the code. -
» system string true The identifier of the coding system that gives meaning to the code. -
providerAuthorization object false No description -
» authorizedBy AuthorizedByLite true The ID of the personnel member who authorized this referral request. -
» authorizedAt string true The date and time of the authorization, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
preAuthReasons [object] false No description -
» code string true A unique code identifying a given reason or supporting fact for this referral to qualify for automatic approval or for requiring preauthorization review. -

ActivityHistoryDetails

Name Type Required Description Accepted Values
items [ActivityHistoryDetail] true No description -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ActivityHistoryDetail

Name Type Required Description Accepted Values
status string true The status of the referral request. ACCEPTED, ACTIVE, APPROVED, CANCELED, CANCELLATION_REQUESTED, COMPLETED, DENIED, DRAFT, E_SIG_REQUIRED, ENTERED_IN_ERROR, NO_SHOW, REJECTED, SCHEDULED, SPECIALIST_VISIT_COMP, SUBMITTED, SUSPENDED, UNKNOWN
statusReason string false If statusReason is present, it represents the reason provided for the status change, for example, the reason for denial, cancellation or rejection. -
activities [string] false The activities requested in this referral request. -
providerAuthorization ProviderAuthorization false The electronic signature given by the referring provider. -
preAuthReasons [PreAuthReason] false A list of preauthorization reasons for this referral request. -
updatedAt string false The date and time when the record was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, “2018-02-13T20:41:18.181Z”. The time in this field is set automatically every time the record is modified; therefore, the field does not need to be set explicitly. When the health concern is first created, the value in “updatedAt” is set by the service to match the value in the “createdAt” field. -
updatedBy UpdatedBy false The personnel member who updated the referral. -

PreAuthReason

Name Type Required Description Accepted Values
code string false A unique code identifying a given reason or supporting fact for this referral to qualify for automatic approval or for requiring preauthorization review. AUTO_APPROVED, PREAUTH_REFERFROM, PREAUTH_REFERTO, PREAUTH_REFERTO_SVC, PREAUTH_SVC, PREAUTH_OON_PROV, PREAUTH_OON_PROV_ORG, PREAUTH_OTHER_IND, PREAUTH_FREETEXT_INS, PREAUTH_INPATIENT, PREAUTH_NEED_MORE_INFO
codeDisplay string false The display value of the pre-authorization reason. -

postReferralRequestsReferralidNotes

Name Type Required Description Accepted Values
date string false The date when the note was recorded. This field can have precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
text string true The textual content of the note or comment. -
author object true The personnel member who requested the referral. This field is required when referral is in SUBMITTED status. -
» id string true The ID of the author. -

Notes

Name Type Required Description Accepted Values
items [Note] true No description -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

Note

Name Type Required Description Accepted Values
date string false The date when the note was recorded. This field can have precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
text string false The textual content of the note or comment. -
author Author false The unique ID of the personnel member who is creating this resource. -

Author

Name Type Required Description Accepted Values
id string false The ID of the author. -
name string false The name of the author. -

AuthorizationLite

Name Type Required Description Accepted Values
authorizedBy AuthorizedByLite false The ID of the personnel member who authorized this referral request. -
authorizedAt string false The date and time of the authorization, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

IdModel

Name Type Required Description Accepted Values
id string false The ID of the referencing object. -

PreAuthReasonsLite

Name Type Required Description Accepted Values
code string false A unique code identifying a given reason or supporting fact for this referral to qualify for automatic approval or for requiring preauthorization review. AUTO_APPROVED, PREAUTH_REFERFROM, PREAUTH_REFERTO, PREAUTH_REFERTO_SVC, PREAUTH_SVC, PREAUTH_OON_PROV, PREAUTH_OON_PROV_ORG, PREAUTH_OTHER_IND, PREAUTH_FREETEXT_INS, PREAUTH_INPATIENT, PREAUTH_NEED_MORE_INFO

ReferredFromLite

Name Type Required Description Accepted Values
requester RequesterLite false The personnel member who is the requester of this referral. -
onBehalfOf OnBehalfOfLite false The organization on whose behalf this referral is exchanged. -

ReferredToLite

Name Type Required Description Accepted Values
performer Performer false The personnel providing services requested by the referral. -
onBehalfOf OnBehalfOfLite false The organization on whose behalf this referral is exchanged. -
location LocationLite false The location where this referral service is offered. -

StatusLite

Name Type Required Description Accepted Values
values string false The status of the referral request. ACCEPTED, ACTIVE, APPROVED, CANCELED, CANCELLATION_REQUESTED, COMPLETED, DENIED, DRAFT, E_SIG_REQUIRED, ENTERED_IN_ERROR, NO_SHOW, REJECTED, SCHEDULED, SPECIALIST_VISIT_COMP, SUBMITTED, SUSPENDED, UNKNOWN