API endpoints: EHR
The 67 EHR resources: their published and service-account paths, what may be done with each, and every field with its type.
Every EHR resource another product can reach, 67 in all. Each one is reached two ways: through the published API at /api/v1/<code> once an administrator has published it (its code is the resource name unless they chose another), or with a service account at /api/ehr/<resource>. The verbs, parameters, filters and answers are the same for every resource and are in API endpoint reference: how to call TRANXACT.
Fields: * means required when creating; (read-only) means it is returned but not accepted on a create or change. org_id, created_at, updated_at, created_by and updated_by are on most records and are set by TRANXACT. The id is a uuid unless the table says otherwise. Field names are the JSON keys.
Administração
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Clinical Departments (departments) | /api/v1/departments · /api/ehr/departments · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, code* text, name* text, department_type text, cost_center_id uuid, head_provider_id uuid, phone text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Compliance Reporting (compliance-reports) | /api/v1/compliance-reports · /api/ehr/compliance-reports · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), report_no text (read-only), report_type* text, name* text, period_start date, period_end date, measure_value numeric, target_value numeric, numerator integer, denominator integer, status text, submitted_at timestamp with time zone (read-only), submitted_to text, findings text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Providers (providers) | /api/v1/providers · /api/ehr/providers · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), provider_no text (read-only), employee_id uuid, user_id uuid, first_name* text, last_name* text, credentials text, role text, specialty text, npi text, license_no text, license_expires date, department_id uuid, can_prescribe boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), dea_no text, dea_expires date, dea_schedules text, practice_state text, spi text, practice_site_id uuid, epcs_status text (read-only) |
| Resources (resources) | /api/v1/resources · /api/ehr/resources · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, code* text, name* text, resource_type text, department_id uuid, capacity integer, is_bookable boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Scheduling (appointments) | /api/v1/appointments · /api/ehr/appointments · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, appointment_no text (read-only), patient_id* uuid, provider_id uuid, department_id uuid, resource_id uuid, appointment_type text, starts_at* timestamp with time zone, ends_at* timestamp with time zone, reason text, status text, is_telehealth boolean, meeting_url text, encounter_id uuid (read-only), cancel_reason text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), eligibility_check_id uuid (read-only), eligibility_status text (read-only), eligibility_note text (read-only) |
Saúde Comportamental
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Behavioral Assessments (behavioral-assessments) | /api/v1/behavioral-assessments · /api/ehr/behavioral-assessments · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), patient_id* uuid, encounter_id uuid, instrument* text, administered_at timestamp with time zone, administered_by uuid, raw_score* integer, severity text (read-only), interpretation text, risk_flag text (read-only), followed_up boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
EDI de reivindicações
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Claim Adjustments (claim-adjustments) | /api/v1/claim-adjustments · /api/ehr/claim-adjustments · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), claim_id uuid (read-only), era_id uuid (read-only), era_line_id uuid (read-only), service_code text (read-only), group_code text (read-only), reason_code text (read-only), remark_codes _text (read-only), amount numeric (read-only), quantity numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Clearinghouse Payers (clearinghouse-payers) | /api/v1/clearinghouse-payers · /api/ehr/clearinghouse-payers · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), connection_id* uuid, payer_code* text, payer_name* text, payer_id uuid, takes_837p boolean, takes_837i boolean, takes_270 boolean, sends_835 boolean, needs_payer_signup boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| EDI Files (edi-files) | /api/v1/edi-files · /api/ehr/edi-files · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), file_no text (read-only), connection_id uuid (read-only), direction text (read-only), transaction_set text (read-only), isa_control_no text (read-only), gs_control_no text (read-only), st_count integer (read-only), segment_count integer (read-only), claim_count integer (read-only), total_amount numeric (read-only), status text (read-only), status_detail text (read-only), related_file_id uuid (read-only), transport text (read-only), raw text (read-only), parsed jsonb (read-only), sent_at timestamp with time zone (read-only), processed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Eligibility Checks (eligibility-checks) | /api/v1/eligibility-checks · /api/ehr/eligibility-checks · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), check_no text (read-only), policy_id uuid (read-only), patient_id uuid (read-only), payer_id uuid (read-only), connection_id uuid (read-only), service_type text (read-only), trace_no text (read-only), request_file_id uuid (read-only), response_file_id uuid (read-only), status text (read-only), coverage_active boolean (read-only), plan_name text (read-only), copay numeric (read-only), coinsurance_pct numeric (read-only), deductible numeric (read-only), deductible_remaining numeric (read-only), out_of_pocket_max numeric (read-only), out_of_pocket_remaining numeric (read-only), rejection text (read-only), benefits jsonb (read-only), checked_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Practice Sites (practice-sites) | /api/v1/practice-sites · /api/ehr/practice-sites · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, group_npi text, tax_id text, taxonomy_code text, address_line text, city text, state_code text, postal_code text, phone text, fax text, contact_name text, is_default boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Remittances (era-remittances) | /api/v1/era-remittances · /api/ehr/era-remittances · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), era_no text (read-only), edi_file_id uuid (read-only), payer_name text (read-only), payer_ref text (read-only), payee_npi text (read-only), trace_no text (read-only), handling_code text (read-only), payment_method text (read-only), payment_amount numeric (read-only), payment_date date (read-only), claims_count integer (read-only), claims_paid numeric (read-only), provider_adjustments numeric (read-only), plb jsonb (read-only), posted_amount numeric (read-only), unmatched_amount numeric (read-only), balanced boolean (read-only), status text (read-only), posted_at timestamp with time zone (read-only), posted_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Clínico
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Care Planning (care-plans) | /api/v1/care-plans · /api/ehr/care-plans · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), plan_no text (read-only), patient_id* uuid, plan_type text, primary_diagnosis text, responsible_provider_id uuid, care_coordinator_id uuid, start_date date, review_date date, end_date date, status text, summary text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Clinical Documentation (notes) | /api/v1/notes · /api/ehr/notes · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), note_no text (read-only), patient_id* uuid, encounter_id uuid, department_id uuid, author_id uuid, template_id uuid, note_type text, subjective text, objective text, assessment text, plan text, content text, status text (read-only), signed_at timestamp with time zone (read-only), signed_by uuid (read-only), cosign_required boolean, cosigned_by uuid (read-only), cosigned_at timestamp with time zone (read-only), addends_note_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Decision Support Alerts (cds-alerts) | /api/v1/cds-alerts · /api/ehr/cds-alerts · /{id} | list, get | id uuid (read-only), patient_id uuid (read-only), encounter_id uuid (read-only), rule_id uuid (read-only), rule_type text (read-only), severity text (read-only), message text (read-only), context_type text (read-only), context_ref text (read-only), fired_at timestamp with time zone (read-only), fired_to uuid (read-only), action text (read-only), override_reason text (read-only), acted_at timestamp with time zone (read-only), acted_by uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Medication Reconciliation (med-reconciliations) | /api/v1/med-reconciliations · /api/ehr/med-reconciliations · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), rec_no text (read-only), patient_id uuid (read-only), encounter_id uuid (read-only), rec_type text (read-only), status text (read-only), sources_used _text (read-only), item_count integer (read-only), discrepancy_count integer (read-only), unresolved_count integer (read-only), performed_by uuid (read-only), signed_by uuid (read-only), signed_by_name text (read-only), signed_at timestamp with time zone (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Order Sets (order-sets) | /api/v1/order-sets · /api/ehr/order-sets · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, category text, description text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Patients (patients) | /api/v1/patients · /api/ehr/patients · /{id} | list, get, create, change, delete | id uuid (read-only), mrn* text, first_name* text, last_name* text, native_name text, date_of_birth* date, sex_at_birth text, gender_identity text, preferred_language text, interpreter_needed boolean, phone text, email text, address text, restricted_chart boolean, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), city text, state_code text, postal_code text, bad_address boolean, in_collections boolean, statement_hold text, reminders_opt_out boolean |
| Possible Duplicate Patients (patient-duplicates) | /api/v1/patient-duplicates · /api/ehr/patient-duplicates · /{id} | list, get | id uuid (read-only), mrn text (read-only), first_name text (read-only), last_name text (read-only), native_name text (read-only), date_of_birth date (read-only), sex_at_birth text (read-only), gender_identity text (read-only), preferred_language text (read-only), interpreter_needed boolean (read-only), phone text (read-only), email text (read-only), address text (read-only), restricted_chart boolean (read-only), is_active boolean (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), city text (read-only), state_code text (read-only), postal_code text (read-only), bad_address boolean (read-only), in_collections boolean (read-only), statement_hold text (read-only), reminders_opt_out boolean (read-only) |
Prescrição eletrônica
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| E-Prescribing Messages (erx-messages) | /api/v1/erx-messages · /api/ehr/erx-messages · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), message_id text (read-only), relates_to_message_id text (read-only), message_type text (read-only), direction text (read-only), prescription_id uuid (read-only), patient_id uuid (read-only), pharmacy_id uuid (read-only), prescriber_id uuid (read-only), connection_id uuid (read-only), transport text (read-only), status text (read-only), status_code text (read-only), status_detail text (read-only), is_controlled boolean (read-only), signed boolean (read-only), digest_sha256 text (read-only), signature text (read-only), signing_key_id text (read-only), raw_xml text (read-only), sent_at timestamp with time zone (read-only), received_at timestamp with time zone (read-only), processed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| EPCS Permissions (epcs-permissions) | /api/v1/epcs-permissions · /api/ehr/epcs-permissions · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), permit_no text (read-only), provider_id uuid (read-only), user_id uuid (read-only), schedules text (read-only), identity_proofing text (read-only), status text (read-only), requested_by uuid (read-only), requested_at timestamp with time zone (read-only), first_approver_id uuid (read-only), first_approved_at timestamp with time zone (read-only), first_approver_registrant boolean (read-only), second_approver_id uuid (read-only), second_approved_at timestamp with time zone (read-only), second_approver_registrant boolean (read-only), revoked_by uuid (read-only), revoked_at timestamp with time zone (read-only), revoke_reason text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| EPCS Signing Log (epcs-signing-log) | /api/v1/epcs-signing-log · /api/ehr/epcs-signing-log · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), prescription_id uuid (read-only), provider_id uuid (read-only), user_id uuid (read-only), rx_no text (read-only), drug text (read-only), dea_schedule text (read-only), outcome text (read-only), reason text (read-only), factors jsonb (read-only), message_id text (read-only), digest_sha256 text (read-only), ip_address text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Pharmacy Directory (pharmacies) | /api/v1/pharmacies · /api/ehr/pharmacies · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), ncpdp_id* text, npi text, store_name* text, address_line text, city text, state_code text, postal_code text, phone text, fax text, specialty text, accepts_epcs boolean, directory_source text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Prescriber Tasks (erx-tasks) | /api/v1/erx-tasks · /api/ehr/erx-tasks · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), task_no text (read-only), task_type text (read-only), prescriber_id uuid (read-only), patient_id uuid (read-only), prescription_id uuid (read-only), pharmacy_id uuid (read-only), message_id uuid (read-only), summary text (read-only), requested jsonb (read-only), status text (read-only), decision_note text (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), response_message_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Emergência
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Emergency Visits (ed-visits) | /api/v1/ed-visits · /api/ehr/ed-visits · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid (read-only), visit_no text (read-only), patient_id* uuid, encounter_id uuid, arrived_at timestamp with time zone (read-only), arrival_mode text, chief_complaint* text, acuity integer, triaged_at timestamp with time zone (read-only), triaged_by uuid (read-only), triage_notes text, vital_bp text, vital_pulse integer, vital_temp numeric, vital_resp integer, vital_spo2 integer, pain_score integer, bed text, attending_id uuid, roomed_at timestamp with time zone (read-only), seen_at timestamp with time zone (read-only), disposition text, disposition_at timestamp with time zone (read-only), departed_at timestamp with time zone (read-only), status text, discharge_instructions text, follow_up_with text, follow_up_days integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Registros existentes
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Allergies (allergies) | /api/v1/allergies · /api/ehr/allergies · /{id} | list, get, create, change, delete | id uuid (read-only), patient_id* uuid, substance* text, reaction text, severity text, status text, recorded_at timestamp with time zone, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Clinical Orders (clinical-orders) | /api/v1/clinical-orders · /api/ehr/clinical-orders · /{id} | list, get, create, change, delete | id uuid (read-only), order_no text (read-only), patient_id* uuid, encounter_id uuid, order_type text, description* text, priority text, status text, ordered_by uuid, ordered_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Encounters (encounters) | /api/v1/encounters · /api/ehr/encounters · /{id} | list, get, create, change, delete | id uuid (read-only), encounter_no text (read-only), patient_id* uuid, encounter_type text, provider_employee_id uuid, started_at timestamp with time zone (read-only), ended_at timestamp with time zone (read-only), chief_complaint text, status text, ar_invoice_id uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), external_visit_no text (read-only) |
| Medications (medications) | /api/v1/medications · /api/ehr/medications · /{id} | list, get, create, change, delete | id uuid (read-only), patient_id uuid (read-only), encounter_id uuid (read-only), drug_name text (read-only), dose text (read-only), route text (read-only), frequency text (read-only), status text, origin text (read-only), prescribed_by uuid (read-only), started_at date (read-only), safety_check jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Problem List (problems) | /api/v1/problems · /api/ehr/problems · /{id} | list, get, create, change, delete | id uuid (read-only), patient_id* uuid, code text, description* text, onset_date date, status text, recorded_by uuid (read-only), recorded_at timestamp with time zone, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Results / Observations (observations) | /api/v1/observations · /api/ehr/observations · /{id} | list, get, create, change, delete | id uuid (read-only), patient_id* uuid, clinical_order_id uuid, code* text, name* text, value_num numeric, value_text text, unit text, reference_range text, abnormal_flag text, result_state text, observed_at timestamp with time zone, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Informações sobre saúde
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| PHI Access Log (phi-access) | /api/v1/phi-access · /api/ehr/phi-access · /{id} | list, get | id uuid (read-only), patient_id uuid (read-only), user_id uuid (read-only), provider_id uuid (read-only), accessed_at timestamp with time zone (read-only), access_type text (read-only), resource text (read-only), reason text (read-only), is_break_glass boolean (read-only), ip_address text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Release of Information (record-requests) | /api/v1/record-requests · /api/ehr/record-requests · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), request_no text (read-only), patient_id* uuid, requester_name* text, requester_type text, purpose* text, scope text, date_from date, date_to date, authorization_on_file boolean, authorization_expires date, status text, requested_at timestamp with time zone, released_at timestamp with time zone (read-only), released_by uuid (read-only), delivery_method text, fee_amount numeric, denial_reason text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Interoperabilidade
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| FHIR Clients (fhir-clients) | /api/v1/fhir-clients · /api/ehr/fhir-clients · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), client_id text (read-only), name text (read-only), description text (read-only), secret_hash text (read-only), allowed_scopes _text (read-only), patient_id uuid (read-only), user_id uuid (read-only), status text (read-only), token_minutes integer (read-only), last_token_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| HL7 Interfaces (hl7-interfaces) | /api/v1/hl7-interfaces · /api/ehr/hl7-interfaces · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, direction text, transport text, mllp_host text, mllp_port integer, file_dir text, enabled boolean, sending_app text, sending_facility text, receiving_app text, receiving_facility text, hl7_version text, message_types _text, create_patients boolean, is_default boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| HL7 Messages (hl7-messages) | /api/v1/hl7-messages · /api/ehr/hl7-messages · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), message_no text (read-only), interface_id uuid (read-only), direction text (read-only), message_type text (read-only), control_id text (read-only), sending_app text (read-only), sending_facility text (read-only), status text (read-only), ack_code text (read-only), ack_text text (read-only), ack_raw text (read-only), raw text (read-only), patient_id uuid (read-only), encounter_id uuid (read-only), source_ref text (read-only), outcome jsonb (read-only), error text (read-only), received_via text (read-only), processed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Network Connections (interop-connections) | /api/v1/interop-connections · /api/ehr/interop-connections · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, kind* text, transport text, endpoint_url text, host text, port integer, username text, secret_sealed text (read-only), client_cert_pem text (read-only), client_key_sealed text (read-only), ca_cert_pem text (read-only), submitter_id text, submitter_name text, receiver_id text, receiver_name text, usage_indicator text, isa_control_seq bigint (read-only), gs_control_seq bigint (read-only), account_id text, portal_id text, settings jsonb (read-only), is_default boolean, is_active boolean, last_used_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Outside Medications (external-medications) | /api/v1/external-medications · /api/ehr/external-medications · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), patient_id* uuid, source text, source_system text, source_ref text (read-only), drug_name* text, rxnorm_code text, dose text, route text, frequency text, status text, reported_at timestamp with time zone, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Laboratório
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Laboratory Catalog (lab-tests) | /api/v1/lab-tests · /api/ehr/lab-tests · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, loinc_code text, category text, specimen_type text, uom text, ref_low numeric, ref_high numeric, critical_low numeric, critical_high numeric, turnaround_hours integer, price numeric, cpt_code text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Laboratory Orders (lab-orders) | /api/v1/lab-orders · /api/ehr/lab-orders · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), order_no text (read-only), patient_id* uuid, encounter_id uuid, ordering_provider_id uuid, priority text, clinical_notes text, ordered_at timestamp with time zone (read-only), collected_at timestamp with time zone, received_at timestamp with time zone (read-only), resulted_at timestamp with time zone (read-only), status text, specimen_no text, specimen_condition text, cost_center_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Laboratory Quality Control (lab-qc) | /api/v1/lab-qc · /api/ehr/lab-qc · /{id} | list, get, create, change, delete | id uuid (read-only), lab_test_id* uuid, run_at timestamp with time zone (read-only), instrument text, control_level text, expected_value numeric, expected_sd numeric, measured_value* numeric, z_score numeric (read-only), result text (read-only), performed_by uuid, corrective_action text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Sala de Operações
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Surgical Cases (surgical-cases) | /api/v1/surgical-cases · /api/ehr/surgical-cases · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, case_no text (read-only), patient_id* uuid, encounter_id uuid, procedure_name* text, cpt_code text, laterality text, primary_surgeon_id uuid, anesthesiologist_id uuid, theatre_id uuid, scheduled_start timestamp with time zone, scheduled_minutes integer, anesthesia_type text, asa_class integer, urgency text, status text, pre_op_at timestamp with time zone (read-only), in_room_at timestamp with time zone (read-only), incision_at timestamp with time zone (read-only), closure_at timestamp with time zone (read-only), out_room_at timestamp with time zone (read-only), pacu_at timestamp with time zone (read-only), consent_signed boolean, site_marked boolean, timeout_completed boolean, count_correct boolean, estimated_blood_loss_ml integer, specimens text, complications text, cancel_reason text, cost_center_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Outros recursos
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Cds rules (cds-rules) | /api/v1/cds-rules · /api/ehr/cds-rules · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, rule_type text, severity text, trigger_on text, criteria jsonb, message* text, recommendation text, can_override boolean, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Note templates (note-templates) | /api/v1/note-templates · /api/ehr/note-templates · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, note_type text, specialty text, body* text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Acesso do paciente
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Appointment Reminders (reminders) | /api/v1/reminders · /api/ehr/reminders · /{id} | list, get, create, change, delete | id uuid (read-only), patient_id* uuid, appointment_id uuid, reminder_type text, channel text, scheduled_for* timestamp with time zone, message text, status text, sent_at timestamp with time zone (read-only), response text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), send_note text (read-only), sent_via text (read-only), send_attempts integer (read-only) |
| Patient Education (education-materials) | /api/v1/education-materials · /api/ehr/education-materials · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, title* text, category text, format text, language text, reading_level text, url text, body text, conditions _text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Patient Portal (portal-accounts) | /api/v1/portal-accounts · /api/ehr/portal-accounts · /{id} | list, get, create, change, delete | id uuid (read-only), patient_id* uuid, user_id uuid, email text, phone text, status text, invited_at timestamp with time zone (read-only), activated_at timestamp with time zone (read-only), last_login_at timestamp with time zone (read-only), login_count integer (read-only), proxy_for_patient_id uuid, proxy_relationship text, sms_reminders boolean, email_reminders boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Recalls (recalls) | /api/v1/recalls · /api/ehr/recalls · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), recall_no text (read-only), patient_id* uuid, provider_id uuid, recall_type text, reason* text, due_date* date, interval_months integer, channel text, status text, reminded_at timestamp with time zone (read-only), reminder_id uuid (read-only), appointment_id uuid, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Telehealth (telehealth) | /api/v1/telehealth · /api/ehr/telehealth · /{id} | list, get, create, change, delete | id uuid (read-only), appointment_id uuid, patient_id* uuid, provider_id uuid, platform text, meeting_url text, join_code text, scheduled_at timestamp with time zone, started_at timestamp with time zone, ended_at timestamp with time zone, duration_minutes integer (read-only), status text, connection_quality text, consent_obtained boolean, patient_location text, technical_issues text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Faturamento de pacientes
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Dunning Messages (dunning-rules) | /api/v1/dunning-rules · /api/ehr/dunning-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, min_days* integer, dunning_level integer, message* text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Patient Payments (patient-payments) | /api/v1/patient-payments · /api/ehr/patient-payments · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), payment_no text (read-only), patient_id* uuid, claim_id uuid, encounter_id uuid, statement_id uuid, kind text, amount* numeric, method text, reference text, received_on date, note text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Patient Statements (patient-statements) | /api/v1/patient-statements · /api/ehr/patient-statements · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), statement_no text (read-only), run_id uuid (read-only), patient_id uuid (read-only), statement_date date (read-only), due_date date (read-only), previous_statement_id uuid (read-only), previous_balance numeric (read-only), new_charges numeric (read-only), payments numeric (read-only), adjustments numeric (read-only), amount_due numeric (read-only), insurance_pending numeric (read-only), aged_current numeric (read-only), aged_31_60 numeric (read-only), aged_61_90 numeric (read-only), aged_91_120 numeric (read-only), aged_over_120 numeric (read-only), oldest_days integer (read-only), dunning_level integer (read-only), dunning_message text (read-only), status text (read-only), hold_reason text (read-only), portal_visible boolean (read-only), payment_url text (read-only), address_block text (read-only), sent_at timestamp with time zone (read-only), viewed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Statement Runs (statement-runs) | /api/v1/statement-runs · /api/ehr/statement-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), cycle_label text, statement_date date, due_days integer, min_balance numeric, payment_url_template text, remit_to text, status text (read-only), statements integer (read-only), held integer (read-only), suppressed integer (read-only), total_due numeric (read-only), generated_at timestamp with time zone (read-only), sent_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Farmácia
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Drug Interactions (drug-interactions) | /api/v1/drug-interactions · /api/ehr/drug-interactions · /{id} | list, get, create, change, delete | id uuid (read-only), drug_a_id* uuid, drug_b_id* uuid, severity text, mechanism text, effect* text, management text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Formulary (formulary) | /api/v1/formulary · /api/ehr/formulary · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, drug_name* text, generic_name text, drug_class text, rxnorm_code text, form text, strength text, route text, is_controlled boolean, controlled_schedule text, is_high_alert boolean, requires_pa boolean, item_id uuid, unit_price numeric, min_age_years integer, max_dose_per_day numeric, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), ndc_code text (read-only), quantity_unit_code text (read-only) |
| Prescribing (prescriptions) | /api/v1/prescriptions · /api/ehr/prescriptions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), rx_no text (read-only), patient_id* uuid, encounter_id uuid, formulary_id* uuid, prescriber_id uuid, dose* text, route text, frequency* text, duration_days integer, quantity numeric, refills integer, refills_used integer (read-only), indication text, instructions text, is_prn boolean, written_at timestamp with time zone (read-only), start_date date, end_date date, status text (read-only), transmitted_at timestamp with time zone (read-only), transmit_method text (read-only), pharmacy_name text, discontinued_reason text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), pharmacy_id uuid, drug_ndc text, sig_text text, sig_dose_quantity numeric, sig_dose_unit_code text, sig_frequency_per_day numeric, quantity_unit_code text, days_supply integer, substitutions text, note_to_pharmacist text, erx_status text (read-only), erx_message_id text (read-only), erx_status_note text (read-only), epcs_signed_at timestamp with time zone (read-only), epcs_signed_by uuid (read-only), renewal_of_id uuid (read-only) |
Saúde pública
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Disease Surveillance (surveillance) | /api/v1/surveillance · /api/ehr/surveillance · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, case_no text (read-only), patient_id uuid, condition* text, icd_code text, category text, onset_date date, diagnosed_date date, case_status text, is_reportable boolean, reported_at timestamp with time zone (read-only), reported_to text, outbreak_ref text, contacts_traced integer, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Immunizations (immunizations) | /api/v1/immunizations · /api/ehr/immunizations · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), patient_id* uuid, vaccine_id* uuid, dose_number integer, administered_at timestamp with time zone, administered_by uuid, lot_no text, expiry_date date, manufacturer text, site text, route text, status text, refusal_reason text, reaction text, registry_submitted boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Vaccine Catalog (vaccines) | /api/v1/vaccines · /api/ehr/vaccines · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, cvx_code text, disease text, doses_in_series integer, interval_days integer, min_age_months integer, max_age_months integer, booster_interval_months integer, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Radiologia e Exames de Imagem
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Imaging Catalog (imaging-procedures) | /api/v1/imaging-procedures · /api/ehr/imaging-procedures · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, modality text, body_part text, contrast boolean, duration_minutes integer, price numeric, cpt_code text, prep_instructions text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Imaging Worklist (imaging-studies) | /api/v1/imaging-studies · /api/ehr/imaging-studies · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), accession_no text (read-only), patient_id* uuid, encounter_id uuid, procedure_id* uuid, ordering_provider_id uuid, performing_tech_id uuid, radiologist_id uuid, priority text, clinical_indication text, ordered_at timestamp with time zone (read-only), scheduled_at timestamp with time zone, performed_at timestamp with time zone, reported_at timestamp with time zone (read-only), status text, study_uid text, image_count integer (read-only), storage_url text, location_id uuid, room text, radiation_dose numeric, cost_center_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Reabilitação
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Rehabilitation Therapy (therapy-episodes) | /api/v1/therapy-episodes · /api/ehr/therapy-episodes · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), episode_no text (read-only), patient_id* uuid, therapy_type text, referring_provider_id uuid, therapist_id uuid, diagnosis text, referral_date date, start_date date, end_date date, authorized_visits integer, visits_used integer (read-only), frequency text, status text, discharge_reason text, care_plan_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Ciclo de Receita
| Recurso | Endpoints | Operações | Campos |
|---|---|---|---|
| Charge Capture (charges) | /api/v1/charges · /api/ehr/charges · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), charge_no text (read-only), patient_id* uuid, encounter_id uuid, department_id uuid, provider_id uuid, service_date date, cpt_code* text, description* text, modifiers text, icd_codes _text, units numeric, unit_price numeric, amount numeric (read-only), source_type text (read-only), source_ref text (read-only), claim_id uuid (read-only), status text, cost_center_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), revenue_code text, ndc_code text |
| Claims (claims) | /api/v1/claims · /api/ehr/claims · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), claim_no text (read-only), patient_id* uuid, encounter_id uuid, payer_id uuid, policy_id uuid, claim_type text, service_from date, service_to date, billed_amount numeric (read-only), allowed_amount numeric (read-only), paid_amount numeric (read-only), patient_responsibility numeric (read-only), adjustment_amount numeric (read-only), status text, submitted_at timestamp with time zone (read-only), adjudicated_at timestamp with time zone (read-only), denial_code text, denial_reason text, ar_invoice_id uuid (read-only), scrub_errors _text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), bill_type text, place_of_service text, frequency_code text, billing_site_id uuid, rendering_provider_id uuid, edi_status text (read-only), edi_status_detail text (read-only), last_edi_file_id uuid (read-only), payer_claim_no text (read-only) |
| Denial Work Queue (denial-work-items) | /api/v1/denial-work-items · /api/ehr/denial-work-items · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), item_no text (read-only), claim_id uuid (read-only), claim_status text (read-only), denial_code text (read-only), denial_reason text (read-only), category text, suggested_action text, amount_at_risk numeric (read-only), assigned_to uuid, due_date date, status text, resolution text, resubmitted_at timestamp with time zone (read-only), resubmissions integer (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Insurance Verification (insurance-policies) | /api/v1/insurance-policies · /api/ehr/insurance-policies · /{id} | list, get, create, change, delete | id uuid (read-only), patient_id* uuid, payer_id* uuid, policy_no* text, group_no text, coverage_rank text, subscriber_name text, relationship text, effective_from date, effective_to date, copay_amount numeric, deductible numeric, deductible_met numeric, coinsurance_pct numeric, out_of_pocket_max numeric, verification_status text (read-only), verified_at timestamp with time zone (read-only), verified_by uuid (read-only), verification_note text (read-only), is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), eligibility_status text (read-only), eligibility_checked_at timestamp with time zone (read-only), plan_name text (read-only), out_of_pocket_met numeric (read-only) |
| Payers (payers) | /api/v1/payers · /api/ehr/payers · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, payer_type text, claims_address text, phone text, electronic_payer_id text, avg_days_to_pay integer, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |