xCaliber healthCare Data Mesh

Referral Order

Source Object: Referral Order

Overview and Usage: The "Referral Order" source object is an essential component of the healthcare system that deals with the ordering of referrals for patients to see specialists or receive additional medical services. It contains a variety of information relevant to the referral process. Here's a detailed breakdown of the key components:

  • Clinical Provider ID: The unique identifier for the clinical provider who initiated the referral order.
  • Date Ordered: The date when the referral order was placed.
  • Department ID: The unique identifier for the department associated with the referral order.
  • Description: A description of the referral order.
  • Diagnosis List: Information about the diagnosis associated with the referral order. It includes details such as the diagnosis code, code set, and description.
  • Future Submit Date: The date when the referral order is intended to be submitted in the future.
  • High Priority: Indicates whether the referral order has a high priority.
  • Order ID: The unique identifier for the referral order.
  • Order Type: The type or category of the referral order.
  • Order Type ID: The unique identifier for the order type.
  • Priority: The priority level of the referral order.
  • Provider ID: The unique identifier for the referring provider.
  • Quantity Value: The quantity specified in the referral order.
  • Status: The current status of the referral order.
  • Assigned User: The user assigned to manage the referral order.
  • Class: The class of the referral order.
  • Class Description: A description of the class associated with the referral order.
  • Clinical Provider: Information about the clinical provider, including address, clinical number, fax number, name, phone number, and more.
  • Clinical Provider Name: The name of the clinical provider.
  • Contraindication Reason: Information related to contraindications, including the code, code set, and description.
  • Created User: The user who created the referral order.
  • Declined Reason: Information related to declined referrals, including the code, code set, and description.
  • Declined Reason Text: Additional text related to the reason for a declined referral.
  • Documentation Only: Indicates whether the referral is for documentation purposes only.
  • Earliest Fill Date: The earliest date when the referral order can be filled.
  • External Codes: External codes related to the referral order.
  • Facility Order Code: Information about the facility order code, including code and description.
  • Last Modified By: The user or entity that last modified the referral order.
  • Last Modified Date: The date when the referral order was last modified.
  • NDC: The National Drug Code (NDC) associated with the referral order.
  • Ordering Provider: Information about the provider who placed the referral order.
  • Refills: The number of refills allowed for the referral.
  • Specimen Collection Site: The site where specimens are collected for the referral order.
  • Insurances: Information about insurance related to the referral, including additional details like authorization number, effective dates, insurance package, member ID, and more.
  • Questions: Questions and answers related to the referral order.
  • Attachments: Details about attached documents, including document class, description, document ID, encounter ID, flowsheet ID, section name, and section name key.
  • Action Note: Additional notes or comments related to actions taken on the referral order.

The "Referral Order" source object is a fundamental part of the healthcare system, ensuring that patients are referred appropriately to receive specialized care and services.

Mapping Table

Data FieldExample ValueSource Data Field DescriptionSource Field Data TypeSource Data Field CardinalityMapped FHIR++ ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapping Context
diagnosissnomedcode-The SNOMED code for diagnosis this order is for.Integer1..1serviceRequestreasonCode.[*].codingsystem=http://snomed.info/sctSnomed-Top Level
facilityid-The athena ID of the facility you want to send the order to. Get a localized list using /chart/configuration/facilities.Integer0..1serviceRequestperformer.[0].reference.split("/")?.[1]---Top Level
facilitynote-A note to send to the facility.String0..1serviceRequestnote[*].textnote[*].authorString=facility--Top Level
futuresubmitdate-The date the order should be sent. Defaults to today.String0..1serviceRequestoccurrenceDateTime---Top Level
highpriority-If true, then the order should be sent STAT.Boolean0..1serviceRequestif (priority === "stat") then true , else false---Top Level
ordertypeid-The athena ID of the type to order.Integer1..1serviceRequestcode.coding[*].code---Top Level
providernote-An internal note for the provider or staff.String0..1serviceRequestnote[*].textnote[*].authorString=practitioner--Top Level
clinicalproviderid-ID of the clinical providerInteger0..1serviceRequestperformer[1].reference---Top Level
dateordered-The timestamp when the order was created.String0..1serviceRequestauthoredOn---Top Level
departmentid-Department ID of the provider.Integer0..1serviceRequestextensions[*].valueInteger--department-idTop Level
description-A human readable description for this orderString0..1serviceRequestcode.text---Top Level
diagnosislist-List of Diagnosis related to this order.Object0..*serviceRequestreasonCode---Top Level
diagnosislist.diagnosiscode-Object0..*serviceRequestreasonCode[1].coding---Top Level
diagnosislist.diagnosiscode.code-SNOMED Diagnosis CodeString0..1serviceRequestreasonCode[1].coding[*].code-Snomed-Top Level
diagnosislist.diagnosiscode.codeset-CodeSet the SNOMED code belongs to.String0..1serviceRequestreasonCode[1].coding[*].system---Top Level
diagnosislist.diagnosiscode.description-Description of the SNOMED CodeString0..1serviceRequestreasonCode[1].coding[*].display---Top Level
diagnosislist.snomedicdcodes-ICD equivalent Codes for the SNOMED CodeObject0..*serviceRequestreasonCode[1].coding---Top Level
diagnosislist.snomedicdcodes.code-ICD 10 CodeString0..1serviceRequestreasonCode[1].coding[*].code-ICD10,ICD9-Top Level
diagnosislist.snomedicdcodes.codeset-Code set the ICD10 code belongs toString0..1serviceRequestreasonCode[1].coding[*].system---Top Level
diagnosislist.snomedicdcodes.description-Brief description of the codeString0..1serviceRequestreasonCode[1].coding[*].display---Top Level
futuresubmitdate-The date this order will be submitted.String0..1serviceRequestoccurrenceDateTime---Top Level
orderid-The order (aka document) ID for this order.Integer0..1serviceRequestid---Top Level
ordertype-The type of this order (Lab, Vaccine, etc.)String0..1serviceRequestcode.coding[1].display---Top Level
ordertypeid-The athena ID for this type of order. Can be used to create another order of this type.Integer0..1serviceRequestcode.coding[1].code---Top Level
priority-Priority of an order. 1 is high; 2 is normal.Integer0..1serviceRequestpriority---Top Level
providerid-ID of the ordering provider.Integer0..1serviceRequestrequester.reference---Top Level
quantityvalue-The dosage quantity value.String0..1serviceRequestquantityQuantity.value---Top Level
status-The status the document is in (PEND, CLOSED, SUBMIT, SUBMITTED, etc).String0..1serviceRequeststatus---Top Level
assigneduser-The username of the user who this order task is currently assigned to for further processing as needed.String0..1serviceRequestperformer[].extension[].valueString--assigned-userTop Level
class-The primary class of this order -- PRESCRIPTION, VACCINE, LAB, IMAGING, PATIENTINFO, etc.String0..1serviceRequestcategory.coding[1].code---Top Level
classdescription-The human-readable description of this document class, including sub class (prescription - new vs. prescription - renewal).String0..1serviceRequestcategory.coding[1].display---Top Level
clinicalprovider-Details about the provider the order is sent to.Object0..*Practitioner----Contained
clinicalprovider.address1-First part of provider addressString0..1Practitioneraddress[*].line[1]---Contained
clinicalprovider.address2-Second part of provider addressString0..1Practitioneraddress[*].line[1]---Contained
clinicalprovider.city-City of the providerString0..1Practitioneraddress[*].city---Contained
clinicalprovider.clianumber-The CLIA number of the clinical provider on file.String0..1Practitioneridentifier[*].valuetype=clianumber-Contained
clinicalprovider.clinicalproviderid-ID for the providerString0..1Practitionerid---Contained
clinicalprovider.faxphonenumber-Fax number for the providerString0..1Practitionertelecom[*].valuesystem=fax--Contained
clinicalprovider.name-Name of the providerString0..1Practitionername[*].textuse = official--Contained
clinicalprovider.phonenumber-Phone number for the providerString0..1Practitionertelecom[*].valuesystem=phone--Contained
clinicalprovider.state-State the provider residesString0..1Practitioneraddress[*].state---Contained
clinicalprovider.zip-Zip code for the providerInteger0..1Practitioneraddress[*].postalCode---Contained
clinicalprovidername-Name of the clinical provider.String0..1Practitionername[*].textuse = usual--Contained
contraindicationreason-List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.Object0..*serviceRequest----Top Level
contraindicationreason.code-The code indicating why the order was contraindicated.String0..1serviceRequestextension[*].valueCodableConcept.coding[1].code--contraindication-reasonTop Level
contraindicationreason.codeset-The codeset that the code belongs to.String0..1serviceRequestextension[*].valueCodableConcept.coding[1].system--contraindication-reasonTop Level
contraindicationreason.description-The plaintext description of the contraindication reason.String0..1serviceRequestextension[*].valueCodableConcept.coding[1].display--contraindication-reasonTop Level
createduser-The username of the person who created the order.String0..1serviceRequestextension[*].valueString--created-userTop Level
declinedreason-List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.Object0..*serviceRequestorderDetail---Top Level
declinedreason.code-The code indicating why the order was not given.String0..1serviceRequestorderDetail.coding[1].code---Top Level
declinedreason.codeset-The codeset that the code belongs to.String0..1serviceRequestorderDetail.coding[1].system---Top Level
declinedreason.description-The plaintext description of the reason the order was not given.String0..1serviceRequestorderDetail.coding[1].display---Top Level
declinedreasontext-The user-facing description of the reason the order was not given.String0..1serviceRequestorderDetail.text---Top Level
documentationonly-If true, this order is here just as a record, and does not need to actually go out.Boolean0..1serviceRequestdoNotPerform---Top Level
earliestfilldate-The earliest date a prescription may be filled, in the format mm/dd/yyyy.String0..1serviceRequestextensions[*].valueString--earliest-fill-dateTop Level
externalcodes-When available, contains how this order maps to external vocabularies like LOINC, CVX, SNOMED, RXNORM, etc.Object0..*serviceRequest----Top Level
externalcodes.code-The code in the external vocabulary.String0..1serviceRequestorderDetail[].coding[].code---Top Level
externalcodes.codeset-Name of the external vocabulary. Currently LOINC (for labs and some imaging orders), CVX (for vaccines), RXNORM and NDC (for prescriptions and some DMEs).String0..1serviceRequestorderDetail[].coding[].system-LOINC,CVX,RxNorm,NDC-Top Level
externalcodes.description-When available, a description of the code from the external vocabulary.String0..1serviceRequestorderDetail[].coding[].display---Top Level
facilityordercode-Facility specific coding for the type of orderObject0..*serviceRequest----Top Level
facilityordercode.code-The code in the facility specific vocabulary.String0..1serviceRequestorderDetail[].coding[].code---Top Level
facilityordercode.description-When available, a description of the code from the facility specific vocabulary.String0..1serviceRequestorderDetail[].coding[].display---Top Level
lastmodifiedby-The username of the person who last modified the order.String0..1serviceRequestextension[*].valueString--last-modified-byTop Level
lastmodifieddatetime-The date this order was last modified.String0..1serviceRequestextension[*].valueString--modified-datetimeTop Level
ndc-The National Drug Code for the orderString0..1serviceRequestextensions[*].valueId-NDCndcTop Level
orderingprovider-The username of the ordering provider, which is different than the ordering user -- who may be an intake nurse for example.String0..1serviceRequestextension[*].valueString--ordering-providerTop Level
refills-The number of refills allowed.String0..1serviceRequestextension[*].valueString--refillsTop Level
specimencollectionsite-Gives the location of the clinical specimen collected if anyString0..1serviceRequestextension[*].valueString--specimen-collection-siteTop Level
insurances.additionalinformation-Additional information note.string0..1Coverageextension.valueStringadditional-informationContained
insurances.authorizationnumber-Authorization number.string0..1Coverageidentifier.valueContained
insurances.authorizationstatus-The authorization status for this insurance.string0..1Coverageextension.valueStringauthorization-statusContained
insurances.effectiveenddate-Effective end date.string0..1CoverageperiodContained
insurances.effectivestartdate-Effective start date.string0..1CoverageperiodContained
insurances.insurancepackageid-Insurance package id.string0..1Coverageidentifier.valueContained
insurances.memberid-Member id.string0..1Coverageextension.valueStringmember-idContained
insurances.name-Name of the insurance.string0..1Coverageclass.nameContained
insurances.patientinsuranceid-Patient insurance id.string0..1Coveragecontaned.idContained
insurances.sequence-Number indicating insurance sequence: 1 - Primary, 2 - Secondary, 3 - Tertiary, 4 - Quaternary.integer0..1Coverageextension.valueIntegersequenceContained
insurances.visitsapproved-The number of visits approved.integer0..1Coverageextension.valueStringvisits-approvedContained
questions.answer-BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice.string0..1QuestionnaireResponseitem.textContained
questions.question-BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice.string0..1QuestionnaireResponseitem.answer.valueStringContained
attachments.documentclass-Class of the attached document.string0..1DocumentReferencecontained.category.coding.codeContained
attachments.documentdescription-A description of the attached documentstring0..1DocumentReferencecontained.descriptionContained
attachments.documentid-ID of the attached document.integer0..1DocumentReferencecontained.idContained
attachments.encounterid-ID of the attached encounter or order groupinteger0..1DocumentReferencecontained.context.encounter.referenceContained
attachments.flowsheetid-ID of the attached flowsheetinteger0..1DocumentReferencecontained.extension.valueStringflow-sheet-idContained
attachments.sectionname-Section name for the attached document.string0..1DocumentReferencecontained.extension.valueStringsection-nameContained
attachments.sectionnamekey-Key name of the section of the attached document.string0..1DocumentReferencecontained.extension.valueStringsection-name-keyContained
actionnote-The action note to add to the order.string0..1serviceRequestextension.valueStringaction-noteTop Level