api-docs v5.116.0

API Docs

Table of contents

Organization_Member

Member - Delete

Back to top

Delete an organization-member's details

DELETE /organization-members/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of organization-member

Examples

Example usage:

curl "https://yourdomain.com/organization-members/<organization-member-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string

membership id for a particular organization/facility
uid string

account's uid
externalId string
specializations Object[]
specializations.code string
specializations.name string
specializations.description string
roles string[]

Roles

  • admin
  • admin_analyst
  • proofreader
  • releasing
  • frontdesk_head
  • frontdesk
  • frontdesk_encoder
  • nurse_head
  • nurse
  • therapist
  • doctor
  • doctor_pathologist
  • doctor_radiologist
  • doctor_sonologist
  • doctor_pme
  • lab_tech
  • lab_qc
  • lab_head
  • imaging_tech
  • imaging_qc
  • imaging_head
  • billing
  • billing_encoder
  • billing_head
  • warehouse
  • warehouse_manager
  • warehouse_head
  • pme_head
  • pme_staff
tags string[]

Preset tags

  • per-patient-consult
  • per-hour-consult
organization string

facility id
superadmin boolean

superadmin privilege
members boolean

can manage membership within the facility
membersCreate boolean

can only create membership whithin the facility
membersRead boolean

can only view membership whithin the facility
membersUpdate boolean

can only update membership details whithin the facility
membersDelete boolean

can only delete membership whithin the facility
org_configs boolean

can manage organization configurations
aptmnt_items boolean

can manage appointments
aptmnt_itemsCreate boolean
aptmnt_itemsRead boolean
aptmnt_itemsUpdate boolean
aptmnt_itemsDelete boolean
frm_templates boolean

can manage form templates
frm_templatesCreate boolean
frm_templatesRead boolean
frm_templatesUpdate boolean
frm_templatesDelete boolean
queue_create boolean

can create queues
queue_remove boolean

can remove queues
queue_items boolean

can queue subjects (patients)
queue_ops boolean

can manage queued subjects
bl_invoices boolean

can manage invoices
bl_invoicesCreate boolean
bl_invoicesRead boolean
bl_invoicesUpdate boolean
bl_invoicesDelete boolean
bl_invoiceItems boolean

can manage invoice items
bl_invoiceItemsCreate boolean
bl_invoiceItemsRead boolean
bl_invoiceItemsUpdate boolean
bl_invoiceItemsDelete boolean
bl_payments boolean

can manage payments
bl_paymentsCreate boolean
bl_paymentsRead boolean
bl_paymentsUpdate boolean
bl_paymentsDelete boolean
bl_expenses boolean

can manage expenses
bl_expensesCreate boolean
bl_expensesRead boolean
bl_expensesUpdate boolean
bl_expensesDelete boolean
bl_printInvoice boolean

can print invoices
bl_soas boolean

can manage SOAs
insurance_contracts boolean

can manage insurance contracts (HMO, company, and government partnership/plans)
insurance_contractsCreate boolean
insurance_contractsRead boolean
insurance_contractsUpdate boolean
insurance_contractsDelete boolean
mf_analytics boolean

can manage analytics
mf_registrationKiosk boolean

can spawn registratin kiosk
mf_patientCreate boolean
mf_patientRead boolean
mf_patientUpdate boolean
mf_services boolean

can manage facility services
mf_servicesCreate boolean
mf_servicesRead boolean
mf_servicesUpdate boolean
mf_servicesDelete boolean
mf_reports boolean

can manage facility reports
mf_reportsCreate boolean
mf_reportsRead boolean
mf_reportsUpdate boolean
mf_reportsDelete boolean
mf_printReports boolean
mf_encounters boolean

can manage patient encounters/visits
mf_encountersCreate boolean
mf_encountersRead boolean
mf_encountersUpdate boolean
mf_encountersDelete boolean
med_records boolean

can manage medical records
med_recordsCreate boolean
med_recordsRead boolean
med_recordsUpdate boolean
med_recordsDelete boolean
med_recordsApeReport boolean
med_recordsApeReportCreate boolean
med_recordsApeReportRead boolean
med_recordsApeReportUpdate boolean
med_recordsApeReportDelete boolean
pharmacy_medicationOrders boolean

can manage pharmacy prescriptions
lis_results boolean

can manage diagnostic (lab) results
lis_resultsCreate boolean
lis_resultsRead boolean
lis_resultsUpdate boolean
lis_resultsDelete boolean
lis_tests boolean

can manage diagnostic (lab) tests
lis_testsCreate boolean
lis_testsRead boolean
lis_testsUpdate boolean
lis_testsDelete boolean
lis_orders boolean

can manage diagnostic (lab) orders
lis_ordersCreate boolean
lis_ordersRead boolean
lis_ordersUpdate boolean
lis_ordersDelete boolean
lis_analyzers boolean

can manage diagnostic (lab) analyzers
lis_analyzersCreate boolean
lis_analyzersRead boolean
lis_analyzersUpdate boolean
lis_analyzersDelete boolean
lis_printClaimStub boolean

can print diagnostic (lab) claim stubs
lis_printResults boolean

can print diagnostic (lab) test results
ris_results boolean

can manage diagnostic (imaging) results
ris_resultsCreate boolean
ris_resultsRead boolean
ris_resultsUpdate boolean
ris_resultsDelete boolean
ris_tests boolean

can manage diagnostic (imaging) tests
ris_testsCreate boolean
ris_testsRead boolean
ris_testsUpdate boolean
ris_testsDelete boolean
ris_orders boolean

can manage diagnostic (imaging) orders
ris_ordersCreate boolean
ris_ordersRead boolean
ris_ordersUpdate boolean
ris_ordersDelete boolean
ris_analyzers boolean

can manage diagnostic (imaging) analyzers
ris_analyzersCreate boolean
ris_analyzersRead boolean
ris_analyzersUpdate boolean
ris_analyzersDelete boolean
ris_printClaimStub boolean

can print diagnostic (imaging) claim stubs
ris_printResults boolean

can print diagnostic (imaging) test results
wh_products boolean

can manage inventory products
wh_productsCreate boolean
wh_productsRead boolean
wh_productsUpdate boolean
wh_productsDelete boolean
wh_suppliers boolean

can manage inventory suppliers
wh_suppliersCreate boolean
wh_suppliersRead boolean
wh_suppliersUpdate boolean
wh_suppliersDelete boolean
wh_sales boolean

can manage sales transactions
wh_salesCreate boolean
wh_salesRead boolean
wh_salesUpdate boolean
wh_salesDelete boolean
wh_adjustments boolean

can manage adjustment transactions
wh_adjustmentsCreate boolean
wh_adjustmentsRead boolean
wh_adjustmentsUpdate boolean
wh_adjustmentsDelete boolean
wh_purchases boolean

can manage purchase transactions
wh_purchasesCreate boolean
wh_purchasesRead boolean
wh_purchasesUpdate boolean
wh_purchasesDelete boolean
wh_transfers boolean

can manage traansfer transactions
wh_transfersCreate boolean
wh_transfersRead boolean
wh_transfersUpdate boolean
wh_transfersDelete boolean
wh_receiving boolean

can manage receiving transactions
wh_receivingCreate boolean
wh_receivingRead boolean
wh_receivingUpdate boolean
wh_receivingDelete boolean
wh_returns boolean

can manage return transactions
wh_returnsCreate boolean
wh_returnsRead boolean
wh_returnsUpdate boolean
wh_returnsDelete boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "membership-id",
  "organization": "facility-id",
  "externalId": "medicard-staff-code",
  "uid": "account-uid",
  "roles": ["admin"],
  "superadmin": true
}

Member - Get

Back to top

Find an organization-member's details

GET /organization-members/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of organization-member

Examples

Example usage:

curl "https://yourdomain.com/organization-members/<organization-member-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string

membership id for a particular organization/facility
uid string

account's uid
externalId string
specializations Object[]
specializations.code string
specializations.name string
specializations.description string
roles string[]

Roles

  • admin
  • admin_analyst
  • proofreader
  • releasing
  • frontdesk_head
  • frontdesk
  • frontdesk_encoder
  • nurse_head
  • nurse
  • therapist
  • doctor
  • doctor_pathologist
  • doctor_radiologist
  • doctor_sonologist
  • doctor_pme
  • lab_tech
  • lab_qc
  • lab_head
  • imaging_tech
  • imaging_qc
  • imaging_head
  • billing
  • billing_encoder
  • billing_head
  • warehouse
  • warehouse_manager
  • warehouse_head
  • pme_head
  • pme_staff
tags string[]

Preset tags

  • per-patient-consult
  • per-hour-consult
organization string

facility id
superadmin boolean

superadmin privilege
members boolean

can manage membership within the facility
membersCreate boolean

can only create membership whithin the facility
membersRead boolean

can only view membership whithin the facility
membersUpdate boolean

can only update membership details whithin the facility
membersDelete boolean

can only delete membership whithin the facility
org_configs boolean

can manage organization configurations
aptmnt_items boolean

can manage appointments
aptmnt_itemsCreate boolean
aptmnt_itemsRead boolean
aptmnt_itemsUpdate boolean
aptmnt_itemsDelete boolean
frm_templates boolean

can manage form templates
frm_templatesCreate boolean
frm_templatesRead boolean
frm_templatesUpdate boolean
frm_templatesDelete boolean
queue_create boolean

can create queues
queue_remove boolean

can remove queues
queue_items boolean

can queue subjects (patients)
queue_ops boolean

can manage queued subjects
bl_invoices boolean

can manage invoices
bl_invoicesCreate boolean
bl_invoicesRead boolean
bl_invoicesUpdate boolean
bl_invoicesDelete boolean
bl_invoiceItems boolean

can manage invoice items
bl_invoiceItemsCreate boolean
bl_invoiceItemsRead boolean
bl_invoiceItemsUpdate boolean
bl_invoiceItemsDelete boolean
bl_payments boolean

can manage payments
bl_paymentsCreate boolean
bl_paymentsRead boolean
bl_paymentsUpdate boolean
bl_paymentsDelete boolean
bl_expenses boolean

can manage expenses
bl_expensesCreate boolean
bl_expensesRead boolean
bl_expensesUpdate boolean
bl_expensesDelete boolean
bl_printInvoice boolean

can print invoices
bl_soas boolean

can manage SOAs
insurance_contracts boolean

can manage insurance contracts (HMO, company, and government partnership/plans)
insurance_contractsCreate boolean
insurance_contractsRead boolean
insurance_contractsUpdate boolean
insurance_contractsDelete boolean
mf_analytics boolean

can manage analytics
mf_registrationKiosk boolean

can spawn registratin kiosk
mf_patientCreate boolean
mf_patientRead boolean
mf_patientUpdate boolean
mf_services boolean

can manage facility services
mf_servicesCreate boolean
mf_servicesRead boolean
mf_servicesUpdate boolean
mf_servicesDelete boolean
mf_reports boolean

can manage facility reports
mf_reportsCreate boolean
mf_reportsRead boolean
mf_reportsUpdate boolean
mf_reportsDelete boolean
mf_printReports boolean
mf_encounters boolean

can manage patient encounters/visits
mf_encountersCreate boolean
mf_encountersRead boolean
mf_encountersUpdate boolean
mf_encountersDelete boolean
med_records boolean

can manage medical records
med_recordsCreate boolean
med_recordsRead boolean
med_recordsUpdate boolean
med_recordsDelete boolean
med_recordsApeReport boolean
med_recordsApeReportCreate boolean
med_recordsApeReportRead boolean
med_recordsApeReportUpdate boolean
med_recordsApeReportDelete boolean
pharmacy_medicationOrders boolean

can manage pharmacy prescriptions
lis_results boolean

can manage diagnostic (lab) results
lis_resultsCreate boolean
lis_resultsRead boolean
lis_resultsUpdate boolean
lis_resultsDelete boolean
lis_tests boolean

can manage diagnostic (lab) tests
lis_testsCreate boolean
lis_testsRead boolean
lis_testsUpdate boolean
lis_testsDelete boolean
lis_orders boolean

can manage diagnostic (lab) orders
lis_ordersCreate boolean
lis_ordersRead boolean
lis_ordersUpdate boolean
lis_ordersDelete boolean
lis_analyzers boolean

can manage diagnostic (lab) analyzers
lis_analyzersCreate boolean
lis_analyzersRead boolean
lis_analyzersUpdate boolean
lis_analyzersDelete boolean
lis_printClaimStub boolean

can print diagnostic (lab) claim stubs
lis_printResults boolean

can print diagnostic (lab) test results
ris_results boolean

can manage diagnostic (imaging) results
ris_resultsCreate boolean
ris_resultsRead boolean
ris_resultsUpdate boolean
ris_resultsDelete boolean
ris_tests boolean

can manage diagnostic (imaging) tests
ris_testsCreate boolean
ris_testsRead boolean
ris_testsUpdate boolean
ris_testsDelete boolean
ris_orders boolean

can manage diagnostic (imaging) orders
ris_ordersCreate boolean
ris_ordersRead boolean
ris_ordersUpdate boolean
ris_ordersDelete boolean
ris_analyzers boolean

can manage diagnostic (imaging) analyzers
ris_analyzersCreate boolean
ris_analyzersRead boolean
ris_analyzersUpdate boolean
ris_analyzersDelete boolean
ris_printClaimStub boolean

can print diagnostic (imaging) claim stubs
ris_printResults boolean

can print diagnostic (imaging) test results
wh_products boolean

can manage inventory products
wh_productsCreate boolean
wh_productsRead boolean
wh_productsUpdate boolean
wh_productsDelete boolean
wh_suppliers boolean

can manage inventory suppliers
wh_suppliersCreate boolean
wh_suppliersRead boolean
wh_suppliersUpdate boolean
wh_suppliersDelete boolean
wh_sales boolean

can manage sales transactions
wh_salesCreate boolean
wh_salesRead boolean
wh_salesUpdate boolean
wh_salesDelete boolean
wh_adjustments boolean

can manage adjustment transactions
wh_adjustmentsCreate boolean
wh_adjustmentsRead boolean
wh_adjustmentsUpdate boolean
wh_adjustmentsDelete boolean
wh_purchases boolean

can manage purchase transactions
wh_purchasesCreate boolean
wh_purchasesRead boolean
wh_purchasesUpdate boolean
wh_purchasesDelete boolean
wh_transfers boolean

can manage traansfer transactions
wh_transfersCreate boolean
wh_transfersRead boolean
wh_transfersUpdate boolean
wh_transfersDelete boolean
wh_receiving boolean

can manage receiving transactions
wh_receivingCreate boolean
wh_receivingRead boolean
wh_receivingUpdate boolean
wh_receivingDelete boolean
wh_returns boolean

can manage return transactions
wh_returnsCreate boolean
wh_returnsRead boolean
wh_returnsUpdate boolean
wh_returnsDelete boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "membership-id",
  "organization": "facility-id",
  "externalId": "medicard-staff-code",
  "uid": "account-uid",
  "roles": ["admin"],
  "superadmin": true
}

Member - Patch

Back to top

Update a organization-member

PATCH /organization-members/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of organization-member
externalId string
specializations Object[]
specializations.code string
specializations.name string
specializations.description string
roles string[]

Roles

  • admin
  • admin_analyst
  • proofreader
  • releasing
  • frontdesk_head
  • frontdesk
  • frontdesk_encoder
  • nurse_head
  • nurse
  • therapist
  • doctor
  • doctor_pathologist
  • doctor_radiologist
  • doctor_sonologist
  • doctor_pme
  • lab_tech
  • lab_qc
  • lab_head
  • imaging_tech
  • imaging_qc
  • imaging_head
  • billing
  • billing_encoder
  • billing_head
  • warehouse
  • warehouse_manager
  • warehouse_head
  • pme_head
  • pme_staff
tags string[]

Preset tags

  • per-patient-consult
  • per-hour-consult
superadmin boolean

superadmin privilege
members boolean

can manage membership within the facility
membersCreate boolean

can only create membership whithin the facility
membersRead boolean

can only view membership whithin the facility
membersUpdate boolean

can only update membership details whithin the facility
membersDelete boolean

can only delete membership whithin the facility
org_configs boolean

can manage organization configurations
aptmnt_items boolean

can manage appointments
aptmnt_itemsCreate boolean
aptmnt_itemsRead boolean
aptmnt_itemsUpdate boolean
aptmnt_itemsDelete boolean
frm_templates boolean

can manage form templates
frm_templatesCreate boolean
frm_templatesRead boolean
frm_templatesUpdate boolean
frm_templatesDelete boolean
queue_create boolean

can create queues
queue_remove boolean

can remove queues
queue_items boolean

can queue subjects (patients)
queue_ops boolean

can manage queued subjects
bl_invoices boolean

can manage invoices
bl_invoicesCreate boolean
bl_invoicesRead boolean
bl_invoicesUpdate boolean
bl_invoicesDelete boolean
bl_invoiceItems boolean

can manage invoice items
bl_invoiceItemsCreate boolean
bl_invoiceItemsRead boolean
bl_invoiceItemsUpdate boolean
bl_invoiceItemsDelete boolean
bl_payments boolean

can manage payments
bl_paymentsCreate boolean
bl_paymentsRead boolean
bl_paymentsUpdate boolean
bl_paymentsDelete boolean
bl_expenses boolean

can manage expenses
bl_expensesCreate boolean
bl_expensesRead boolean
bl_expensesUpdate boolean
bl_expensesDelete boolean
bl_printInvoice boolean

can print invoices
bl_soas boolean

can manage SOAs
insurance_contracts boolean

can manage insurance contracts (HMO, company, and government partnership/plans)
insurance_contractsCreate boolean
insurance_contractsRead boolean
insurance_contractsUpdate boolean
insurance_contractsDelete boolean
mf_analytics boolean

can manage analytics
mf_registrationKiosk boolean

can spawn registratin kiosk
mf_patientCreate boolean
mf_patientRead boolean
mf_patientUpdate boolean
mf_services boolean

can manage facility services
mf_servicesCreate boolean
mf_servicesRead boolean
mf_servicesUpdate boolean
mf_servicesDelete boolean
mf_reports boolean

can manage facility reports
mf_reportsCreate boolean
mf_reportsRead boolean
mf_reportsUpdate boolean
mf_reportsDelete boolean
mf_printReports boolean
mf_encounters boolean

can manage patient encounters/visits
mf_encountersCreate boolean
mf_encountersRead boolean
mf_encountersUpdate boolean
mf_encountersDelete boolean
med_records boolean

can manage medical records
med_recordsCreate boolean
med_recordsRead boolean
med_recordsUpdate boolean
med_recordsDelete boolean
med_recordsApeReport boolean
med_recordsApeReportCreate boolean
med_recordsApeReportRead boolean
med_recordsApeReportUpdate boolean
med_recordsApeReportDelete boolean
pharmacy_medicationOrders boolean

can manage pharmacy prescriptions
lis_results boolean

can manage diagnostic (lab) results
lis_resultsCreate boolean
lis_resultsRead boolean
lis_resultsUpdate boolean
lis_resultsDelete boolean
lis_tests boolean

can manage diagnostic (lab) tests
lis_testsCreate boolean
lis_testsRead boolean
lis_testsUpdate boolean
lis_testsDelete boolean
lis_orders boolean

can manage diagnostic (lab) orders
lis_ordersCreate boolean
lis_ordersRead boolean
lis_ordersUpdate boolean
lis_ordersDelete boolean
lis_analyzers boolean

can manage diagnostic (lab) analyzers
lis_analyzersCreate boolean
lis_analyzersRead boolean
lis_analyzersUpdate boolean
lis_analyzersDelete boolean
lis_printClaimStub boolean

can print diagnostic (lab) claim stubs
lis_printResults boolean

can print diagnostic (lab) test results
ris_results boolean

can manage diagnostic (imaging) results
ris_resultsCreate boolean
ris_resultsRead boolean
ris_resultsUpdate boolean
ris_resultsDelete boolean
ris_tests boolean

can manage diagnostic (imaging) tests
ris_testsCreate boolean
ris_testsRead boolean
ris_testsUpdate boolean
ris_testsDelete boolean
ris_orders boolean

can manage diagnostic (imaging) orders
ris_ordersCreate boolean
ris_ordersRead boolean
ris_ordersUpdate boolean
ris_ordersDelete boolean
ris_analyzers boolean

can manage diagnostic (imaging) analyzers
ris_analyzersCreate boolean
ris_analyzersRead boolean
ris_analyzersUpdate boolean
ris_analyzersDelete boolean
ris_printClaimStub boolean

can print diagnostic (imaging) claim stubs
ris_printResults boolean

can print diagnostic (imaging) test results
wh_products boolean

can manage inventory products
wh_productsCreate boolean
wh_productsRead boolean
wh_productsUpdate boolean
wh_productsDelete boolean
wh_suppliers boolean

can manage inventory suppliers
wh_suppliersCreate boolean
wh_suppliersRead boolean
wh_suppliersUpdate boolean
wh_suppliersDelete boolean
wh_sales boolean

can manage sales transactions
wh_salesCreate boolean
wh_salesRead boolean
wh_salesUpdate boolean
wh_salesDelete boolean
wh_adjustments boolean

can manage adjustment transactions
wh_adjustmentsCreate boolean
wh_adjustmentsRead boolean
wh_adjustmentsUpdate boolean
wh_adjustmentsDelete boolean
wh_purchases boolean

can manage purchase transactions
wh_purchasesCreate boolean
wh_purchasesRead boolean
wh_purchasesUpdate boolean
wh_purchasesDelete boolean
wh_transfers boolean

can manage traansfer transactions
wh_transfersCreate boolean
wh_transfersRead boolean
wh_transfersUpdate boolean
wh_transfersDelete boolean
wh_receiving boolean

can manage receiving transactions
wh_receivingCreate boolean
wh_receivingRead boolean
wh_receivingUpdate boolean
wh_receivingDelete boolean
wh_returns boolean

can manage return transactions
wh_returnsCreate boolean
wh_returnsRead boolean
wh_returnsUpdate boolean
wh_returnsDelete boolean

Examples

Example usage:

curl "https://yourdomain.com/organization-members/<organization-member-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "roles": ["admin"],
    "superadmin": true
  }'

Parameters examples

json - Request-Example

{
  "name": "Tooth Extraction",
  "priceCurrency": "PHP",
  "price": 100
}

Success response

Success response - Success 200

Name Type Description
id string

membership id for a particular organization/facility
uid string

account's uid
externalId string
specializations Object[]
specializations.code string
specializations.name string
specializations.description string
roles string[]

Roles

  • admin
  • admin_analyst
  • proofreader
  • releasing
  • frontdesk_head
  • frontdesk
  • frontdesk_encoder
  • nurse_head
  • nurse
  • therapist
  • doctor
  • doctor_pathologist
  • doctor_radiologist
  • doctor_sonologist
  • doctor_pme
  • lab_tech
  • lab_qc
  • lab_head
  • imaging_tech
  • imaging_qc
  • imaging_head
  • billing
  • billing_encoder
  • billing_head
  • warehouse
  • warehouse_manager
  • warehouse_head
  • pme_head
  • pme_staff
tags string[]

Preset tags

  • per-patient-consult
  • per-hour-consult
organization string

facility id
superadmin boolean

superadmin privilege
members boolean

can manage membership within the facility
membersCreate boolean

can only create membership whithin the facility
membersRead boolean

can only view membership whithin the facility
membersUpdate boolean

can only update membership details whithin the facility
membersDelete boolean

can only delete membership whithin the facility
org_configs boolean

can manage organization configurations
aptmnt_items boolean

can manage appointments
aptmnt_itemsCreate boolean
aptmnt_itemsRead boolean
aptmnt_itemsUpdate boolean
aptmnt_itemsDelete boolean
frm_templates boolean

can manage form templates
frm_templatesCreate boolean
frm_templatesRead boolean
frm_templatesUpdate boolean
frm_templatesDelete boolean
queue_create boolean

can create queues
queue_remove boolean

can remove queues
queue_items boolean

can queue subjects (patients)
queue_ops boolean

can manage queued subjects
bl_invoices boolean

can manage invoices
bl_invoicesCreate boolean
bl_invoicesRead boolean
bl_invoicesUpdate boolean
bl_invoicesDelete boolean
bl_invoiceItems boolean

can manage invoice items
bl_invoiceItemsCreate boolean
bl_invoiceItemsRead boolean
bl_invoiceItemsUpdate boolean
bl_invoiceItemsDelete boolean
bl_payments boolean

can manage payments
bl_paymentsCreate boolean
bl_paymentsRead boolean
bl_paymentsUpdate boolean
bl_paymentsDelete boolean
bl_expenses boolean

can manage expenses
bl_expensesCreate boolean
bl_expensesRead boolean
bl_expensesUpdate boolean
bl_expensesDelete boolean
bl_printInvoice boolean

can print invoices
bl_soas boolean

can manage SOAs
insurance_contracts boolean

can manage insurance contracts (HMO, company, and government partnership/plans)
insurance_contractsCreate boolean
insurance_contractsRead boolean
insurance_contractsUpdate boolean
insurance_contractsDelete boolean
mf_analytics boolean

can manage analytics
mf_registrationKiosk boolean

can spawn registratin kiosk
mf_patientCreate boolean
mf_patientRead boolean
mf_patientUpdate boolean
mf_services boolean

can manage facility services
mf_servicesCreate boolean
mf_servicesRead boolean
mf_servicesUpdate boolean
mf_servicesDelete boolean
mf_reports boolean

can manage facility reports
mf_reportsCreate boolean
mf_reportsRead boolean
mf_reportsUpdate boolean
mf_reportsDelete boolean
mf_printReports boolean
mf_encounters boolean

can manage patient encounters/visits
mf_encountersCreate boolean
mf_encountersRead boolean
mf_encountersUpdate boolean
mf_encountersDelete boolean
med_records boolean

can manage medical records
med_recordsCreate boolean
med_recordsRead boolean
med_recordsUpdate boolean
med_recordsDelete boolean
med_recordsApeReport boolean
med_recordsApeReportCreate boolean
med_recordsApeReportRead boolean
med_recordsApeReportUpdate boolean
med_recordsApeReportDelete boolean
pharmacy_medicationOrders boolean

can manage pharmacy prescriptions
lis_results boolean

can manage diagnostic (lab) results
lis_resultsCreate boolean
lis_resultsRead boolean
lis_resultsUpdate boolean
lis_resultsDelete boolean
lis_tests boolean

can manage diagnostic (lab) tests
lis_testsCreate boolean
lis_testsRead boolean
lis_testsUpdate boolean
lis_testsDelete boolean
lis_orders boolean

can manage diagnostic (lab) orders
lis_ordersCreate boolean
lis_ordersRead boolean
lis_ordersUpdate boolean
lis_ordersDelete boolean
lis_analyzers boolean

can manage diagnostic (lab) analyzers
lis_analyzersCreate boolean
lis_analyzersRead boolean
lis_analyzersUpdate boolean
lis_analyzersDelete boolean
lis_printClaimStub boolean

can print diagnostic (lab) claim stubs
lis_printResults boolean

can print diagnostic (lab) test results
ris_results boolean

can manage diagnostic (imaging) results
ris_resultsCreate boolean
ris_resultsRead boolean
ris_resultsUpdate boolean
ris_resultsDelete boolean
ris_tests boolean

can manage diagnostic (imaging) tests
ris_testsCreate boolean
ris_testsRead boolean
ris_testsUpdate boolean
ris_testsDelete boolean
ris_orders boolean

can manage diagnostic (imaging) orders
ris_ordersCreate boolean
ris_ordersRead boolean
ris_ordersUpdate boolean
ris_ordersDelete boolean
ris_analyzers boolean

can manage diagnostic (imaging) analyzers
ris_analyzersCreate boolean
ris_analyzersRead boolean
ris_analyzersUpdate boolean
ris_analyzersDelete boolean
ris_printClaimStub boolean

can print diagnostic (imaging) claim stubs
ris_printResults boolean

can print diagnostic (imaging) test results
wh_products boolean

can manage inventory products
wh_productsCreate boolean
wh_productsRead boolean
wh_productsUpdate boolean
wh_productsDelete boolean
wh_suppliers boolean

can manage inventory suppliers
wh_suppliersCreate boolean
wh_suppliersRead boolean
wh_suppliersUpdate boolean
wh_suppliersDelete boolean
wh_sales boolean

can manage sales transactions
wh_salesCreate boolean
wh_salesRead boolean
wh_salesUpdate boolean
wh_salesDelete boolean
wh_adjustments boolean

can manage adjustment transactions
wh_adjustmentsCreate boolean
wh_adjustmentsRead boolean
wh_adjustmentsUpdate boolean
wh_adjustmentsDelete boolean
wh_purchases boolean

can manage purchase transactions
wh_purchasesCreate boolean
wh_purchasesRead boolean
wh_purchasesUpdate boolean
wh_purchasesDelete boolean
wh_transfers boolean

can manage traansfer transactions
wh_transfersCreate boolean
wh_transfersRead boolean
wh_transfersUpdate boolean
wh_transfersDelete boolean
wh_receiving boolean

can manage receiving transactions
wh_receivingCreate boolean
wh_receivingRead boolean
wh_receivingUpdate boolean
wh_receivingDelete boolean
wh_returns boolean

can manage return transactions
wh_returnsCreate boolean
wh_returnsRead boolean
wh_returnsUpdate boolean
wh_returnsDelete boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "membership-id",
  "organization": "facility-id",
  "externalId": "medicard-staff-code",
  "uid": "account-uid",
  "roles": ["admin"],
  "superadmin": true
}

Member - Post

Back to top

Create a organization-member

POST /organization-members

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
organization string
uid string
externalId string
specializations Object[]
specializations.code string
specializations.name string
specializations.description string
roles string[]

Roles

  • admin
  • admin_analyst
  • proofreader
  • releasing
  • frontdesk_head
  • frontdesk
  • frontdesk_encoder
  • nurse_head
  • nurse
  • therapist
  • doctor
  • doctor_pathologist
  • doctor_radiologist
  • doctor_sonologist
  • doctor_pme
  • lab_tech
  • lab_qc
  • lab_head
  • imaging_tech
  • imaging_qc
  • imaging_head
  • billing
  • billing_encoder
  • billing_head
  • warehouse
  • warehouse_manager
  • warehouse_head
  • pme_head
  • pme_staff
tags string[]

Preset tags

  • per-patient-consult
  • per-hour-consult
superadmin boolean

superadmin privilege
members boolean

can manage membership within the facility
membersCreate boolean

can only create membership whithin the facility
membersRead boolean

can only view membership whithin the facility
membersUpdate boolean

can only update membership details whithin the facility
membersDelete boolean

can only delete membership whithin the facility
org_configs boolean

can manage organization configurations
aptmnt_items boolean

can manage appointments
aptmnt_itemsCreate boolean
aptmnt_itemsRead boolean
aptmnt_itemsUpdate boolean
aptmnt_itemsDelete boolean
frm_templates boolean

can manage form templates
frm_templatesCreate boolean
frm_templatesRead boolean
frm_templatesUpdate boolean
frm_templatesDelete boolean
queue_create boolean

can create queues
queue_remove boolean

can remove queues
queue_items boolean

can queue subjects (patients)
queue_ops boolean

can manage queued subjects
bl_invoices boolean

can manage invoices
bl_invoicesCreate boolean
bl_invoicesRead boolean
bl_invoicesUpdate boolean
bl_invoicesDelete boolean
bl_invoiceItems boolean

can manage invoice items
bl_invoiceItemsCreate boolean
bl_invoiceItemsRead boolean
bl_invoiceItemsUpdate boolean
bl_invoiceItemsDelete boolean
bl_payments boolean

can manage payments
bl_paymentsCreate boolean
bl_paymentsRead boolean
bl_paymentsUpdate boolean
bl_paymentsDelete boolean
bl_expenses boolean

can manage expenses
bl_expensesCreate boolean
bl_expensesRead boolean
bl_expensesUpdate boolean
bl_expensesDelete boolean
bl_printInvoice boolean

can print invoices
bl_soas boolean

can manage SOAs
insurance_contracts boolean

can manage insurance contracts (HMO, company, and government partnership/plans)
insurance_contractsCreate boolean
insurance_contractsRead boolean
insurance_contractsUpdate boolean
insurance_contractsDelete boolean
mf_analytics boolean

can manage analytics
mf_registrationKiosk boolean

can spawn registratin kiosk
mf_patientCreate boolean
mf_patientRead boolean
mf_patientUpdate boolean
mf_services boolean

can manage facility services
mf_servicesCreate boolean
mf_servicesRead boolean
mf_servicesUpdate boolean
mf_servicesDelete boolean
mf_reports boolean

can manage facility reports
mf_reportsCreate boolean
mf_reportsRead boolean
mf_reportsUpdate boolean
mf_reportsDelete boolean
mf_printReports boolean
mf_encounters boolean

can manage patient encounters/visits
mf_encountersCreate boolean
mf_encountersRead boolean
mf_encountersUpdate boolean
mf_encountersDelete boolean
med_records boolean

can manage medical records
med_recordsCreate boolean
med_recordsRead boolean
med_recordsUpdate boolean
med_recordsDelete boolean
med_recordsApeReport boolean
med_recordsApeReportCreate boolean
med_recordsApeReportRead boolean
med_recordsApeReportUpdate boolean
med_recordsApeReportDelete boolean
pharmacy_medicationOrders boolean

can manage pharmacy prescriptions
lis_results boolean

can manage diagnostic (lab) results
lis_resultsCreate boolean
lis_resultsRead boolean
lis_resultsUpdate boolean
lis_resultsDelete boolean
lis_tests boolean

can manage diagnostic (lab) tests
lis_testsCreate boolean
lis_testsRead boolean
lis_testsUpdate boolean
lis_testsDelete boolean
lis_orders boolean

can manage diagnostic (lab) orders
lis_ordersCreate boolean
lis_ordersRead boolean
lis_ordersUpdate boolean
lis_ordersDelete boolean
lis_analyzers boolean

can manage diagnostic (lab) analyzers
lis_analyzersCreate boolean
lis_analyzersRead boolean
lis_analyzersUpdate boolean
lis_analyzersDelete boolean
lis_printClaimStub boolean

can print diagnostic (lab) claim stubs
lis_printResults boolean

can print diagnostic (lab) test results
ris_results boolean

can manage diagnostic (imaging) results
ris_resultsCreate boolean
ris_resultsRead boolean
ris_resultsUpdate boolean
ris_resultsDelete boolean
ris_tests boolean

can manage diagnostic (imaging) tests
ris_testsCreate boolean
ris_testsRead boolean
ris_testsUpdate boolean
ris_testsDelete boolean
ris_orders boolean

can manage diagnostic (imaging) orders
ris_ordersCreate boolean
ris_ordersRead boolean
ris_ordersUpdate boolean
ris_ordersDelete boolean
ris_analyzers boolean

can manage diagnostic (imaging) analyzers
ris_analyzersCreate boolean
ris_analyzersRead boolean
ris_analyzersUpdate boolean
ris_analyzersDelete boolean
ris_printClaimStub boolean

can print diagnostic (imaging) claim stubs
ris_printResults boolean

can print diagnostic (imaging) test results
wh_products boolean

can manage inventory products
wh_productsCreate boolean
wh_productsRead boolean
wh_productsUpdate boolean
wh_productsDelete boolean
wh_suppliers boolean

can manage inventory suppliers
wh_suppliersCreate boolean
wh_suppliersRead boolean
wh_suppliersUpdate boolean
wh_suppliersDelete boolean
wh_sales boolean

can manage sales transactions
wh_salesCreate boolean
wh_salesRead boolean
wh_salesUpdate boolean
wh_salesDelete boolean
wh_adjustments boolean

can manage adjustment transactions
wh_adjustmentsCreate boolean
wh_adjustmentsRead boolean
wh_adjustmentsUpdate boolean
wh_adjustmentsDelete boolean
wh_purchases boolean

can manage purchase transactions
wh_purchasesCreate boolean
wh_purchasesRead boolean
wh_purchasesUpdate boolean
wh_purchasesDelete boolean
wh_transfers boolean

can manage traansfer transactions
wh_transfersCreate boolean
wh_transfersRead boolean
wh_transfersUpdate boolean
wh_transfersDelete boolean
wh_receiving boolean

can manage receiving transactions
wh_receivingCreate boolean
wh_receivingRead boolean
wh_receivingUpdate boolean
wh_receivingDelete boolean
wh_returns boolean

can manage return transactions
wh_returnsCreate boolean
wh_returnsRead boolean
wh_returnsUpdate boolean
wh_returnsDelete boolean

Examples

Example usage:

curl "https://yourdomain.com/organization-members" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "organization": "facility-id",
    "externalId": "medicard-staff-code",
    "uid": "account-uid",
    "roles": ["admin"],
    "superadmin": true
  }'

Parameters examples

json - Request-Example

{
  "organization": "facility-id",
  "externalId": "medicard-staff-code",
  "uid": "account-uid",
  "roles": ["admin"],
  "superadmin": true
}

Success response

Success response - Success 200

Name Type Description
id string

membership id for a particular organization/facility
uid string

account's uid
externalId string
specializations Object[]
specializations.code string
specializations.name string
specializations.description string
roles string[]

Roles

  • admin
  • admin_analyst
  • proofreader
  • releasing
  • frontdesk_head
  • frontdesk
  • frontdesk_encoder
  • nurse_head
  • nurse
  • therapist
  • doctor
  • doctor_pathologist
  • doctor_radiologist
  • doctor_sonologist
  • doctor_pme
  • lab_tech
  • lab_qc
  • lab_head
  • imaging_tech
  • imaging_qc
  • imaging_head
  • billing
  • billing_encoder
  • billing_head
  • warehouse
  • warehouse_manager
  • warehouse_head
  • pme_head
  • pme_staff
tags string[]

Preset tags

  • per-patient-consult
  • per-hour-consult
organization string

facility id
superadmin boolean

superadmin privilege
members boolean

can manage membership within the facility
membersCreate boolean

can only create membership whithin the facility
membersRead boolean

can only view membership whithin the facility
membersUpdate boolean

can only update membership details whithin the facility
membersDelete boolean

can only delete membership whithin the facility
org_configs boolean

can manage organization configurations
aptmnt_items boolean

can manage appointments
aptmnt_itemsCreate boolean
aptmnt_itemsRead boolean
aptmnt_itemsUpdate boolean
aptmnt_itemsDelete boolean
frm_templates boolean

can manage form templates
frm_templatesCreate boolean
frm_templatesRead boolean
frm_templatesUpdate boolean
frm_templatesDelete boolean
queue_create boolean

can create queues
queue_remove boolean

can remove queues
queue_items boolean

can queue subjects (patients)
queue_ops boolean

can manage queued subjects
bl_invoices boolean

can manage invoices
bl_invoicesCreate boolean
bl_invoicesRead boolean
bl_invoicesUpdate boolean
bl_invoicesDelete boolean
bl_invoiceItems boolean

can manage invoice items
bl_invoiceItemsCreate boolean
bl_invoiceItemsRead boolean
bl_invoiceItemsUpdate boolean
bl_invoiceItemsDelete boolean
bl_payments boolean

can manage payments
bl_paymentsCreate boolean
bl_paymentsRead boolean
bl_paymentsUpdate boolean
bl_paymentsDelete boolean
bl_expenses boolean

can manage expenses
bl_expensesCreate boolean
bl_expensesRead boolean
bl_expensesUpdate boolean
bl_expensesDelete boolean
bl_printInvoice boolean

can print invoices
bl_soas boolean

can manage SOAs
insurance_contracts boolean

can manage insurance contracts (HMO, company, and government partnership/plans)
insurance_contractsCreate boolean
insurance_contractsRead boolean
insurance_contractsUpdate boolean
insurance_contractsDelete boolean
mf_analytics boolean

can manage analytics
mf_registrationKiosk boolean

can spawn registratin kiosk
mf_patientCreate boolean
mf_patientRead boolean
mf_patientUpdate boolean
mf_services boolean

can manage facility services
mf_servicesCreate boolean
mf_servicesRead boolean
mf_servicesUpdate boolean
mf_servicesDelete boolean
mf_reports boolean

can manage facility reports
mf_reportsCreate boolean
mf_reportsRead boolean
mf_reportsUpdate boolean
mf_reportsDelete boolean
mf_printReports boolean
mf_encounters boolean

can manage patient encounters/visits
mf_encountersCreate boolean
mf_encountersRead boolean
mf_encountersUpdate boolean
mf_encountersDelete boolean
med_records boolean

can manage medical records
med_recordsCreate boolean
med_recordsRead boolean
med_recordsUpdate boolean
med_recordsDelete boolean
med_recordsApeReport boolean
med_recordsApeReportCreate boolean
med_recordsApeReportRead boolean
med_recordsApeReportUpdate boolean
med_recordsApeReportDelete boolean
pharmacy_medicationOrders boolean

can manage pharmacy prescriptions
lis_results boolean

can manage diagnostic (lab) results
lis_resultsCreate boolean
lis_resultsRead boolean
lis_resultsUpdate boolean
lis_resultsDelete boolean
lis_tests boolean

can manage diagnostic (lab) tests
lis_testsCreate boolean
lis_testsRead boolean
lis_testsUpdate boolean
lis_testsDelete boolean
lis_orders boolean

can manage diagnostic (lab) orders
lis_ordersCreate boolean
lis_ordersRead boolean
lis_ordersUpdate boolean
lis_ordersDelete boolean
lis_analyzers boolean

can manage diagnostic (lab) analyzers
lis_analyzersCreate boolean
lis_analyzersRead boolean
lis_analyzersUpdate boolean
lis_analyzersDelete boolean
lis_printClaimStub boolean

can print diagnostic (lab) claim stubs
lis_printResults boolean

can print diagnostic (lab) test results
ris_results boolean

can manage diagnostic (imaging) results
ris_resultsCreate boolean
ris_resultsRead boolean
ris_resultsUpdate boolean
ris_resultsDelete boolean
ris_tests boolean

can manage diagnostic (imaging) tests
ris_testsCreate boolean
ris_testsRead boolean
ris_testsUpdate boolean
ris_testsDelete boolean
ris_orders boolean

can manage diagnostic (imaging) orders
ris_ordersCreate boolean
ris_ordersRead boolean
ris_ordersUpdate boolean
ris_ordersDelete boolean
ris_analyzers boolean

can manage diagnostic (imaging) analyzers
ris_analyzersCreate boolean
ris_analyzersRead boolean
ris_analyzersUpdate boolean
ris_analyzersDelete boolean
ris_printClaimStub boolean

can print diagnostic (imaging) claim stubs
ris_printResults boolean

can print diagnostic (imaging) test results
wh_products boolean

can manage inventory products
wh_productsCreate boolean
wh_productsRead boolean
wh_productsUpdate boolean
wh_productsDelete boolean
wh_suppliers boolean

can manage inventory suppliers
wh_suppliersCreate boolean
wh_suppliersRead boolean
wh_suppliersUpdate boolean
wh_suppliersDelete boolean
wh_sales boolean

can manage sales transactions
wh_salesCreate boolean
wh_salesRead boolean
wh_salesUpdate boolean
wh_salesDelete boolean
wh_adjustments boolean

can manage adjustment transactions
wh_adjustmentsCreate boolean
wh_adjustmentsRead boolean
wh_adjustmentsUpdate boolean
wh_adjustmentsDelete boolean
wh_purchases boolean

can manage purchase transactions
wh_purchasesCreate boolean
wh_purchasesRead boolean
wh_purchasesUpdate boolean
wh_purchasesDelete boolean
wh_transfers boolean

can manage traansfer transactions
wh_transfersCreate boolean
wh_transfersRead boolean
wh_transfersUpdate boolean
wh_transfersDelete boolean
wh_receiving boolean

can manage receiving transactions
wh_receivingCreate boolean
wh_receivingRead boolean
wh_receivingUpdate boolean
wh_receivingDelete boolean
wh_returns boolean

can manage return transactions
wh_returnsCreate boolean
wh_returnsRead boolean
wh_returnsUpdate boolean
wh_returnsDelete boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "membership-id",
  "organization": "facility-id",
  "externalId": "medicard-staff-code",
  "uid": "account-uid",
  "roles": ["admin"],
  "superadmin": true
}

results matching ""

    No results matching ""