Referralrequest Profile
This ReferralRequest profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.
Overview
This resource captures details about a referral request, including the requester, the patient the request is for, and the status of the request. Requests can either be for referral services or for transfer of care events.
Scope and Usage
This profile is used to define the content that will be returned by the API Server in response to requests to access ReferralRequest resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Source
The ReferralRequest resource is derived from the ORDERS tables in athenaPractice and athenaFlow, and includes only those orders that are for procedures. Specific detail can be found in the Mappings section in the profile detail page.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a ReferralRequest, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/ReferralRequest/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the ReferralRequest resource to retrieve |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Search Operation
Search operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for ReferralRequest resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/ReferralRequest?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results ReferralRequest resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the AthenaHealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
| _id (token ) | The ID of the resource |
| _lastUpdated (date ) | |
| _lastUpdated-fromnow (quantity ) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time , e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| _security (token ) | |
| _tag (token ) | |
| date (date ) | Creation or activation date |
| date-fromnow (quantity ) | Like date except expressed as a positive or negative offset from the current time in units of time , e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| encounter (reference ) | |
| encounter-or-historical (reference ) | |
| patient (reference ) | Who the referral is about |
| priority (token ) | The priority assigned to the referral |
| requester (reference ) | Requester of referral / transfer of care |
| status (token ) | The status of the referral |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Other Operations
This Implementation guide defines 1 operation:
| $generate | Generate Document |
For more information about operations, including how they are invoked, see Operations .
Generate Document
Generate a CDA or other standards based document from resource data associated with the patient referenced by patient parameter below.
GET [base]/$generate?{operation-parameters}| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| patient | 0..1 | reference | A reference to the patient for whom the document will be generated. The document will include data from this patient's record. Patient can be omitted when the patient for whom the document is being generated can be inferred from other parameters. | ||
| type | 0..1 | token | The type of document to be generated. | ||
| class | 0..1 | token | The document class to be generated. | ||
| format | 0..* | token | The format to be used when generating the document. | ||
| contentType | 0..1 | token | MimeType (Required ) | The contentType of the document to be generated. | |
| author | 0..* | reference | The author of the document. Must be a legal reference to a Patient or Practitioner known to the current system. | ||
| authenticator | 0..1 | reference | The legal authenticator of the document. Must be a legal reference to a Patient or Practitioner known to the current system. | ||
| encounter | 0..1 | reference | The encounter associated with the document. Must be a legal reference to an Encounter known to the current system. | ||
| fromDate | 0..1 | date | Start date of the time period associated with the data elements. | ||
| toDate | 0..1 | date | End date of the time period associated with the data elements. | ||
| description | 0..1 | string | A description to include within the DocumentReference returned by this operation. | ||
| exclusions | 0..* | uri | URIs identifing resources to exclude from the document. | ||
| persist | 0..1 | boolean | If true, the generated document will be persisted. The default if not specified is false. | ||
| securityLabel | 0..* | token | Security tags to be associated with this docment. | ||
| excludedSections | 0..* | string | URIs identifing sections to exclude from the document. | ||
| excludedResources | 0..* | string | URIs identifing resources to exclude from the document. | ||
| raw | 0..1 | boolean | true | false | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| return | 1..1 | DocumentReference | Binary | A populated DocumentReference or Binary resource containing metadata about the document and the body of the document in the content attachment (when raw=false or is omitted), or just the body of the document (when raw=true). | ||
The $generate operation constructs a document from resource data available for the specified subject.
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/referralrequest-profile
A request for referral or transfer of care
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  ReferralRequest | 0..* | ReferralRequest | A request for referral or transfer of care | ||
 meta | ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| status | ?! ∑ | 1..1 | code | draft | requested | active | cancelled | accepted | rejected | completed Binding: ReferralStatus (required ) | |
 identifier | 0..* | Identifier | Business identifier | ||
| date | ∑ | 0..1 | dateTime | Date of creation/activation | |
| type | ∑ | 0..1 | CodeableConcept | Referral/Transition of care request type Binding: (unbound) (example ) | |
| specialty | 0..1 | CodeableConcept | The clinical specialty (discipline) that the referral is requested for Binding: PractitionerSpecialty (example ) | ||
| priority | ∑ | 0..1 | CodeableConcept | Urgency of referral / transfer of care request Binding: DiagnosticOrderPriority (example ) | |
 patient | ∑ | 0..1 | Reference (Patient ) | Patient referred to care or transfer | |
| requester | ∑ | 0..1 | Reference (Practitioner | Organization | Patient ) | Requester of referral / transfer of care | |
| recipient | ∑ | 0..* | Reference (Practitioner | Organization ) | Receiver of referral / transfer of care request | |
| encounter | 0..1 | Reference (Encounter ) | Originating encounter | ||
| dateSent | ∑ | 0..1 | dateTime | Date referral/transfer of care request is sent | |
| reason | ∑ | 0..1 | CodeableConcept | Reason for referral / transfer of care request Binding: (unbound) (example ) | |
| description | 0..1 | string | A textual description of the referral | ||
| serviceRequested | ∑ | 0..* | CodeableConcept | Actions requested as part of the referral Binding: Practice Setting Code Value Set (example ) | |
| supportingInformation | ∑ | 0..* | Reference (Resource ) | /* This is a subquery that returns references to Conditions */ | |
 fulfillmentTime | ∑ | 0..1 | Period | Requested service(s) fulfillment time | |
athenaPractice Mapping
The mappings in this section represent the how data stored within athenaPractice is served through the product's APIs.
athenaPractice and athenaFlow share a common schema for patient clinical data and only one is shown when these are
the same. Use of this information is subject to the API Server
Terms and Conditions .
| Referralrequest Profile | ||
| ReferralRequest | ReferralRequest-Profile | FHIR_REFERRALREQUESTVIEW |
| ├ id | %ORDGROUPID% | |
| ├ status | MapCode(%STATUS%,"REFERRALREQUESTSTATUS") | |
| ├ identifier | MakeIdentifier("U",getSiteSystem("ORDERNUM"),%ORDERNUM%) | |
| ├ date | %DB_CREATE_DATE% | |
| ├ priority | MapConcept(%PRIORITY%,"REFERRALREQUESTPRIORITY") | |
| ├ patient | MakeReference("PERSON",%PID%,"Patient") | |
| ├ requester | MakeReference("USR",%ORDERER%,"Practitioner") | |
| ├ recipient | MakeReference("SERVPROV",%SERVPROVID%,"Practitioner") | |
| ├ encounter | MakeReference("DOCUMENT",%SDID%,"Encounter") | |
| ├ reason | MakeTextConcept(%REFERRALREASON%) | |
| ├ description | %COMMENTS% | |
| ├ serviceRequested | MakeOrderCodeConcept(%CODE%, %DESCRIPTION%,%SYSTEM%) | |
| ├ supportingInformation | MakeReferenceList("PROBLEM",%SPRID%,"Condition") | |
| └ fulfillmentTime | MakePeriod(%ORDERDATE%,%ENDDATE%) | |
athenaFlow Mapping
The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs.
Use of this information is subject to the API Server
Terms and Conditions .
| Referralrequest Profile | ||
| ReferralRequest | ReferralRequest-Profile | FHIR_REFERRALREQUESTVIEW |
| ├ id | %ORDGROUPID% | |
| ├ status | MapCode(%STATUS%,"REFERRALREQUESTSTATUS") | |
| ├ identifier | MakeIdentifier("U",getSiteSystem("ORDERNUM"),%ORDERNUM%) | |
| ├ date | %DB_CREATE_DATE% | |
| ├ priority | MapConcept(%PRIORITY%,"REFERRALREQUESTPRIORITY") | |
| ├ patient | MakeReference("PERSON",%PID%,"Patient") | |
| ├ requester | MakeReference("USR",%ORDERER%,"Practitioner") | |
| ├ recipient | MakeReference("SERVPROV",%SERVPROVID%,"Practitioner") | |
| ├ encounter | MakeReference("DOCUMENT",%SDID%,"Encounter") | |
| ├ reason | MakeTextConcept(%REFERRALREASON%) | |
| ├ description | %COMMENTS% | |
| ├ serviceRequested | MakeOrderCodeConcept(%CODE%, %DESCRIPTION%,%SYSTEM%) | |
| ├ supportingInformation | MakeReferenceList("PROBLEM",%SPRID%,"Condition") | |
| └ fulfillmentTime | MakePeriod(%ORDERDATE%,%ENDDATE%) | |