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 Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
---|---|---|---|---|---|---|---|---|---|---|
diagnosissnomedcode | - | The SNOMED code for diagnosis this order is for. | Integer | 1..1 | serviceRequest | reasonCode.[*].coding | system=http://snomed.info/sct | Snomed | - | Top Level |
facilityid | - | The athena ID of the facility you want to send the order to. Get a localized list using /chart/configuration/facilities. | Integer | 0..1 | serviceRequest | performer.[0].reference.split("/")?.[1] | - | - | - | Top Level |
facilitynote | - | A note to send to the facility. | String | 0..1 | serviceRequest | note[*].text | note[*].authorString=facility | - | - | Top Level |
futuresubmitdate | - | The date the order should be sent. Defaults to today. | String | 0..1 | serviceRequest | occurrenceDateTime | - | - | - | Top Level |
highpriority | - | If true, then the order should be sent STAT. | Boolean | 0..1 | serviceRequest | if (priority === "stat") then true , else false | - | - | - | Top Level |
ordertypeid | - | The athena ID of the type to order. | Integer | 1..1 | serviceRequest | code.coding[*].code | - | - | - | Top Level |
providernote | - | An internal note for the provider or staff. | String | 0..1 | serviceRequest | note[*].text | note[*].authorString=practitioner | - | - | Top Level |
clinicalproviderid | - | ID of the clinical provider | Integer | 0..1 | serviceRequest | performer[1].reference | - | - | - | Top Level |
dateordered | - | The timestamp when the order was created. | String | 0..1 | serviceRequest | authoredOn | - | - | - | Top Level |
departmentid | - | Department ID of the provider. | Integer | 0..1 | serviceRequest | extensions[*].valueInteger | - | - | department-id | Top Level |
description | - | A human readable description for this order | String | 0..1 | serviceRequest | code.text | - | - | - | Top Level |
diagnosislist | - | List of Diagnosis related to this order. | Object | 0..* | serviceRequest | reasonCode | - | - | - | Top Level |
diagnosislist.diagnosiscode | - | Object | 0..* | serviceRequest | reasonCode[1].coding | - | - | - | Top Level | |
diagnosislist.diagnosiscode.code | - | SNOMED Diagnosis Code | String | 0..1 | serviceRequest | reasonCode[1].coding[*].code | - | Snomed | - | Top Level |
diagnosislist.diagnosiscode.codeset | - | CodeSet the SNOMED code belongs to. | String | 0..1 | serviceRequest | reasonCode[1].coding[*].system | - | - | - | Top Level |
diagnosislist.diagnosiscode.description | - | Description of the SNOMED Code | String | 0..1 | serviceRequest | reasonCode[1].coding[*].display | - | - | - | Top Level |
diagnosislist.snomedicdcodes | - | ICD equivalent Codes for the SNOMED Code | Object | 0..* | serviceRequest | reasonCode[1].coding | - | - | - | Top Level |
diagnosislist.snomedicdcodes.code | - | ICD 10 Code | String | 0..1 | serviceRequest | reasonCode[1].coding[*].code | - | ICD10,ICD9 | - | Top Level |
diagnosislist.snomedicdcodes.codeset | - | Code set the ICD10 code belongs to | String | 0..1 | serviceRequest | reasonCode[1].coding[*].system | - | - | - | Top Level |
diagnosislist.snomedicdcodes.description | - | Brief description of the code | String | 0..1 | serviceRequest | reasonCode[1].coding[*].display | - | - | - | Top Level |
futuresubmitdate | - | The date this order will be submitted. | String | 0..1 | serviceRequest | occurrenceDateTime | - | - | - | Top Level |
orderid | - | The order (aka document) ID for this order. | Integer | 0..1 | serviceRequest | id | - | - | - | Top Level |
ordertype | - | The type of this order (Lab, Vaccine, etc.) | String | 0..1 | serviceRequest | code.coding[1].display | - | - | - | Top Level |
ordertypeid | - | The athena ID for this type of order. Can be used to create another order of this type. | Integer | 0..1 | serviceRequest | code.coding[1].code | - | - | - | Top Level |
priority | - | Priority of an order. 1 is high; 2 is normal. | Integer | 0..1 | serviceRequest | priority | - | - | - | Top Level |
providerid | - | ID of the ordering provider. | Integer | 0..1 | serviceRequest | requester.reference | - | - | - | Top Level |
quantityvalue | - | The dosage quantity value. | String | 0..1 | serviceRequest | quantityQuantity.value | - | - | - | Top Level |
status | - | The status the document is in (PEND, CLOSED, SUBMIT, SUBMITTED, etc). | String | 0..1 | serviceRequest | status | - | - | - | Top Level |
assigneduser | - | The username of the user who this order task is currently assigned to for further processing as needed. | String | 0..1 | serviceRequest | performer[].extension[].valueString | - | - | assigned-user | Top Level |
class | - | The primary class of this order -- PRESCRIPTION, VACCINE, LAB, IMAGING, PATIENTINFO, etc. | String | 0..1 | serviceRequest | category.coding[1].code | - | - | - | Top Level |
classdescription | - | The human-readable description of this document class, including sub class (prescription - new vs. prescription - renewal). | String | 0..1 | serviceRequest | category.coding[1].display | - | - | - | Top Level |
clinicalprovider | - | Details about the provider the order is sent to. | Object | 0..* | Practitioner | - | - | - | - | Contained |
clinicalprovider.address1 | - | First part of provider address | String | 0..1 | Practitioner | address[*].line[1] | - | - | - | Contained |
clinicalprovider.address2 | - | Second part of provider address | String | 0..1 | Practitioner | address[*].line[1] | - | - | - | Contained |
clinicalprovider.city | - | City of the provider | String | 0..1 | Practitioner | address[*].city | - | - | - | Contained |
clinicalprovider.clianumber | - | The CLIA number of the clinical provider on file. | String | 0..1 | Practitioner | identifier[*].value | type=clianumber | - | Contained | |
clinicalprovider.clinicalproviderid | - | ID for the provider | String | 0..1 | Practitioner | id | - | - | - | Contained |
clinicalprovider.faxphonenumber | - | Fax number for the provider | String | 0..1 | Practitioner | telecom[*].value | system=fax | - | - | Contained |
clinicalprovider.name | - | Name of the provider | String | 0..1 | Practitioner | name[*].text | use = official | - | - | Contained |
clinicalprovider.phonenumber | - | Phone number for the provider | String | 0..1 | Practitioner | telecom[*].value | system=phone | - | - | Contained |
clinicalprovider.state | - | State the provider resides | String | 0..1 | Practitioner | address[*].state | - | - | - | Contained |
clinicalprovider.zip | - | Zip code for the provider | Integer | 0..1 | Practitioner | address[*].postalCode | - | - | - | Contained |
clinicalprovidername | - | Name of the clinical provider. | String | 0..1 | Practitioner | name[*].text | use = 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. | Object | 0..* | serviceRequest | - | - | - | - | Top Level |
contraindicationreason.code | - | The code indicating why the order was contraindicated. | String | 0..1 | serviceRequest | extension[*].valueCodableConcept.coding[1].code | - | - | contraindication-reason | Top Level |
contraindicationreason.codeset | - | The codeset that the code belongs to. | String | 0..1 | serviceRequest | extension[*].valueCodableConcept.coding[1].system | - | - | contraindication-reason | Top Level |
contraindicationreason.description | - | The plaintext description of the contraindication reason. | String | 0..1 | serviceRequest | extension[*].valueCodableConcept.coding[1].display | - | - | contraindication-reason | Top Level |
createduser | - | The username of the person who created the order. | String | 0..1 | serviceRequest | extension[*].valueString | - | - | created-user | Top 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. | Object | 0..* | serviceRequest | orderDetail | - | - | - | Top Level |
declinedreason.code | - | The code indicating why the order was not given. | String | 0..1 | serviceRequest | orderDetail.coding[1].code | - | - | - | Top Level |
declinedreason.codeset | - | The codeset that the code belongs to. | String | 0..1 | serviceRequest | orderDetail.coding[1].system | - | - | - | Top Level |
declinedreason.description | - | The plaintext description of the reason the order was not given. | String | 0..1 | serviceRequest | orderDetail.coding[1].display | - | - | - | Top Level |
declinedreasontext | - | The user-facing description of the reason the order was not given. | String | 0..1 | serviceRequest | orderDetail.text | - | - | - | Top Level |
documentationonly | - | If true, this order is here just as a record, and does not need to actually go out. | Boolean | 0..1 | serviceRequest | doNotPerform | - | - | - | Top Level |
earliestfilldate | - | The earliest date a prescription may be filled, in the format mm/dd/yyyy. | String | 0..1 | serviceRequest | extensions[*].valueString | - | - | earliest-fill-date | Top Level |
externalcodes | - | When available, contains how this order maps to external vocabularies like LOINC, CVX, SNOMED, RXNORM, etc. | Object | 0..* | serviceRequest | - | - | - | - | Top Level |
externalcodes.code | - | The code in the external vocabulary. | String | 0..1 | serviceRequest | orderDetail[].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). | String | 0..1 | serviceRequest | orderDetail[].coding[].system | - | LOINC,CVX,RxNorm,NDC | - | Top Level |
externalcodes.description | - | When available, a description of the code from the external vocabulary. | String | 0..1 | serviceRequest | orderDetail[].coding[].display | - | - | - | Top Level |
facilityordercode | - | Facility specific coding for the type of order | Object | 0..* | serviceRequest | - | - | - | - | Top Level |
facilityordercode.code | - | The code in the facility specific vocabulary. | String | 0..1 | serviceRequest | orderDetail[].coding[].code | - | - | - | Top Level |
facilityordercode.description | - | When available, a description of the code from the facility specific vocabulary. | String | 0..1 | serviceRequest | orderDetail[].coding[].display | - | - | - | Top Level |
lastmodifiedby | - | The username of the person who last modified the order. | String | 0..1 | serviceRequest | extension[*].valueString | - | - | last-modified-by | Top Level |
lastmodifieddatetime | - | The date this order was last modified. | String | 0..1 | serviceRequest | extension[*].valueString | - | - | modified-datetime | Top Level |
ndc | - | The National Drug Code for the order | String | 0..1 | serviceRequest | extensions[*].valueId | - | NDC | ndc | Top Level |
orderingprovider | - | The username of the ordering provider, which is different than the ordering user -- who may be an intake nurse for example. | String | 0..1 | serviceRequest | extension[*].valueString | - | - | ordering-provider | Top Level |
refills | - | The number of refills allowed. | String | 0..1 | serviceRequest | extension[*].valueString | - | - | refills | Top Level |
specimencollectionsite | - | Gives the location of the clinical specimen collected if any | String | 0..1 | serviceRequest | extension[*].valueString | - | - | specimen-collection-site | Top Level |
insurances.additionalinformation | - | Additional information note. | string | 0..1 | Coverage | extension.valueString | additional-information | Contained | ||
insurances.authorizationnumber | - | Authorization number. | string | 0..1 | Coverage | identifier.value | Contained | |||
insurances.authorizationstatus | - | The authorization status for this insurance. | string | 0..1 | Coverage | extension.valueString | authorization-status | Contained | ||
insurances.effectiveenddate | - | Effective end date. | string | 0..1 | Coverage | period | Contained | |||
insurances.effectivestartdate | - | Effective start date. | string | 0..1 | Coverage | period | Contained | |||
insurances.insurancepackageid | - | Insurance package id. | string | 0..1 | Coverage | identifier.value | Contained | |||
insurances.memberid | - | Member id. | string | 0..1 | Coverage | extension.valueString | member-id | Contained | ||
insurances.name | - | Name of the insurance. | string | 0..1 | Coverage | class.name | Contained | |||
insurances.patientinsuranceid | - | Patient insurance id. | string | 0..1 | Coverage | contaned.id | Contained | |||
insurances.sequence | - | Number indicating insurance sequence: 1 - Primary, 2 - Secondary, 3 - Tertiary, 4 - Quaternary. | integer | 0..1 | Coverage | extension.valueInteger | sequence | Contained | ||
insurances.visitsapproved | - | The number of visits approved. | integer | 0..1 | Coverage | extension.valueString | visits-approved | Contained | ||
questions.answer | - | BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice. | string | 0..1 | QuestionnaireResponse | item.text | Contained | |||
questions.question | - | BETA FIELD: The custom list of questions and answers associated with this order.This list will vary by practice. | string | 0..1 | QuestionnaireResponse | item.answer.valueString | Contained | |||
attachments.documentclass | - | Class of the attached document. | string | 0..1 | DocumentReference | contained.category.coding.code | Contained | |||
attachments.documentdescription | - | A description of the attached document | string | 0..1 | DocumentReference | contained.description | Contained | |||
attachments.documentid | - | ID of the attached document. | integer | 0..1 | DocumentReference | contained.id | Contained | |||
attachments.encounterid | - | ID of the attached encounter or order group | integer | 0..1 | DocumentReference | contained.context.encounter.reference | Contained | |||
attachments.flowsheetid | - | ID of the attached flowsheet | integer | 0..1 | DocumentReference | contained.extension.valueString | flow-sheet-id | Contained | ||
attachments.sectionname | - | Section name for the attached document. | string | 0..1 | DocumentReference | contained.extension.valueString | section-name | Contained | ||
attachments.sectionnamekey | - | Key name of the section of the attached document. | string | 0..1 | DocumentReference | contained.extension.valueString | section-name-key | Contained | ||
actionnote | - | The action note to add to the order. | string | 0..1 | serviceRequest | extension.valueString | action-note | Top Level |