The FHIR R4 ElectronicFax resource is used to represent fax transmission details for sending healthcare-related documents via fax. It supports the transmission of clinical records, prescriptions, referrals, and other important medical documents, ensuring secure and efficient sharing of information between providers.
Use Cases
- Send clinical documents via fax to external providers
- Receive incoming faxes and link them to patient records
- Track fax transmission statuses and errors
- Archive faxed documents for patient record keeping
- Integrate faxed documents into EHR workflows
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/ElectronicFax
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/ElectronicFax
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.
Required scopes:
electronicfax.readfor GETelectronicfax.writefor POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
| Method | Operation | Description |
|---|---|---|
GET | Search Faxes | Retrieves a list of faxes sent or received by the authenticated user |
GET | Read Fax | Retrieves metadata and status of a specific fax |
POST | Send Fax | Sends a new fax by submitting a DocumentReference resource |
Frequently Used Search Parameters
| Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
patient | Filters by patient ID | Patient/{id} | Reference | Yes |
status | Filters by fax transmission status | ElectronicFaxStatus (sent) | token | No |
dateSent | Filters by the date the fax was sent | ge2024-01-01, le2024-12-31 | date | No |
recipient | Filters by the recipient of the fax transmission | Practitioner/{id}, Organization/{id} | Reference | No |
Commonly Returned Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
patient | Reference to the patient associated with the fax transmission | Patient/{id} | Reference(Patient) | Yes |
status | Current status of the fax transmission | sent | CodeableConcept | Yes |
dateSent | The date the fax was sent | 2024-02-12T12:34:56Z | dateTime | Yes |
recipient | Reference to the recipient of the fax | Practitioner/{id}, Organization/{id} | Reference | Yes |
documentReference | Reference to the document being transmitted | DocumentReference/{id} | Reference | Yes |
Webhooks
Clients can subscribe to receive notifications when a fax is successfully sent or when an error occurs during transmission. For more information, go to: Webhooks & Polling.
Error Handling
All ElectronicFax operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses. For more information, go to: Error Handling.