API Reference

Send a fax

post
https://fax-api.zapehr.com/v1/send

Send a fax. Oystehr's fax sending feature makes it easy to send a fax to a chosen recipient with a single API call. You can use this feature to send referrals, medical records, prescriptions, and other documents that require fax transmission e.g. for HIPAA compliance.

Access Policy Requirements:
Action: Fax:Send
Access Policy Resource: Fax:Fax

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A Z3 URL of the document you want to send. Your user must have access to this document.

string

The patient who is the subject of the fax. This must be a valid FHIR Patient relative reference in the format: Patient/some-valid-uuid. This reference must be a valid resource.

string
enum
required

The quality of the document you want sent.

Allowed:
string

The recipient of the fax. This must be a valid FHIR CareTeam, HealthcareService, Organization, Patient, Practitioner, PractitionerRole, or RelatedPerson relative reference in the format: the-resource-type/some-valid-uuid. This reference must be a valid resource and have a number in the telecom field with a system of fax.

Note: One of recipient or recipientNumber must be provided, but not both.

string

The fax number of the recipient. This must be a valid E.164 format fax number.

Note: One of recipient or recipientNumber must be provided, but not both.

string
required

The sender of the fax. This must be a valid FHIR HealthcareService, Organization, Patient, Practitioner, PractitionerRole, or RelatedPerson relative reference in the format: the-resource-type/some-valid-uuid. This reference must be a valid resource and have your onboarded fax number in the telecom field with a system of fax.

Responses

Updated about 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago