All scopes
scope | resource |
|---|---|
legal_entity:read | GET /api/legal_entities |
employee_request:read | GET /api/employee_requests |
employee_request:write | POST /api/employee_requests createEmployeeRequest mutation |
employee_request:approve | POST /api/employee_requests/:id/approve |
employee_request:reject | POST /api/employee_requests/:id/reject |
employee:read | GET /api/employees |
employee:write | PATCH /api/employees/:id |
employee:details | GET /api/employees/:id |
employee:deactivate | PATCH /api/employees/:id/actions/deactivate |
division:write | POST /api/divisions |
division:read | GET /api/divisions |
division:details | GET /api/divisions/:id |
division:activate | PATCH /api/divisions/:id/actions/activate |
division:deactivate | PATCH /api/divisions/:id/actions/deactivate |
declaration_request:write | POST /api/declaration_requests |
declaration_request:sign | POST /api/declaration_requests/:id/actions/sign |
declaration_request:approve | PATCH /api/declaration_requests/:id/approve |
declaration_request:reject | PATH /api/declaration_requests/id/actions/reject |
declaration_request:read | GET /api/declaration_requests/:id |
declaration:read | GET /api/declarations |
otp:read | GET /verifications |
otp:write | POST /verifications |
dictionary:read | GET /api/dictionaries |
address:read | GET /api/uaddresses |
legal_entity:read | GET /api/legal_entities |
legal_entity:write | PUT /api/legal_entities |
legal_entity:mis_verify | PATCH /api/legal_entities/{{legal_entity_id}}/actions/mis_verify |
employee_request:read | GET /api/employee_requests |
legal_entity:mis_verify | PATCH /api/legal_entities/{{legal_entity_id}}/actions/mis_verify |
employee_request:read | GET /api/employee_requests |
declaration_request_images:read | GET /api/declaration_requests/{id}/images |
innm:write | POST /innms |
innm:read | GET /innms |
innm_dosage:write | POST /innm_dosages |
innm_dosage:deactivate | PATCH /innm_dosages/{id}/actions/deactivate |
innm_dosage:read | GET /innm_dosages |
medication:write | POST /medications |
medication:read | GET /medications |
medication:deactivate | PATCH /medications/:id/actions/deactivate |
drugs:read | GET /api/drugs |
medication_request_request:write | POST /api/medication_request_requests |
medication_request_request:read | GET /api/medication_request_requests |
medication_request_request:sign | PATCH /api/medication_request_requests/{id}/actions/sign |
medication_request_request:reject | PATCH /api/medication_request_requests/{id}/actions/reject |
medication_request:read | GET /api/medication_requests |
medication_request:details | GET /api/medication_requests |
medication_request:reject | PATCH /api/medication_requests/{id}/actions/reject |
medication_request:resend | PATCH /api/medication_requests/{id}/actions/resend |
medication_dispense:write | POST /api/medication_dispenses POST /api/pharmacy/medication_dispenses |
medication_dispense:read | GET /api/medication_dispenses |
medication_dispense:process | PATCH /api/medication_dispenses/{{id}}/actions/process PATCH /api/pharmacy/medication_dispenses/{{id}}/actions/process |
medication_dispense:reject | PATCH /api/medication_dispenses/{{id}}/actions/reject PATCH /api/pharmacy/medication_dispenses/{{id}}/actions/reject |
person:reset_authentication_method | PATCH /api/persons/{id}/action/reset_authentication_method |
reimbursement_report:read | GET /api/reimbursement_report |
bl_user:write | POST /black_list_users |
bl_user:read | GET /black_list_users |
bl_user:deactivate | PATCH /black_list_users/{id}/actions/deactivate |
user:block | PATCH /api/users/{id}/actions/block |
user:unblock | PATCH /api/users/{id}/actions/unblock |
user:request_factor | PATCH /api/users/actions/request_factor |
user:approve_factor | PATCH /api/users/actions/approve_factor |
authentication_factor:write | PATCH /api/users/{user_id}/authentication_factors{2fa_id}/actions/reset PATCH mithril/api/users/{user_id}/authentication_factors{2fa_id}/actions/disable PATCH mithril/api/users/{user_id}/authentication_factors{2fa_id}/actions/enable POST api/mithril/users/{user_id}/authentication_factors |
authentication_factor:read | GET /api/users/{user_id}/authentication_factors |
contract_request:create | POST /api/contract_requests POST /api/contract_requests/{id} |
contract_request:read | GET /api/contract_requests GET /api/contract_requests/{id} GET /api/contract_requests/{id}/signed_content GET /api/contract_requests/{id}/printout_content |
contract_request:approve | PATCH /api/contract_requests/{id}/actions/approve_msp |
contract_request:update | PATCH /api/contract_requests/{id} PATCH /api/contract_requests/{id}/actions/approve PATCH /api/contract_requests/{id}/actions/decline |
contract_request:sign | PATCH /api/contract_requests/{id}/actions/sign_nhs PATCH /api/contract_requests/{id}/actions/sign_msp |
contract_request:terminate | PATCH /api/contract_requests/{id}/actions/terminate |
contract:read | GET /api/contracts GET /api/contracts/{id} GET /api/contracts/{id}/employees |
contract:update | GET /api/contracts/{id}/employees/actions/update |
contract:terminate | GET /api/contracts/{id}/actions/terminate |
capitation_report:read | GET /api/capitation_reports GET /api/capitation_report_details |
client:read | GET /api/clients GET /api/clients/{id} |
connection:read | GET /api/clients/{id}/connections GET /api/clients/{id}/connections/{id} |
connection:write | PATCH /api/clients/{id}/connections/{id} |
connection:refresh_secret | PATCH /api/clients/{id}/connections/{id}/actions/refresh_secret |
connection:delete | DELETE /api/clients/{id}/connections/{id} |
job:read | GET /api/jobs/{{job_id}} |
episode:write | POST /api/patients/{{patient_id}}/episodes |
episode:read | GET /api/patients/{{patient_id}}/episodes |
episode:read | GET /api/patients/{{patient_id}}/episodes/{{episode_id}} |
episode:write | PATCH /api/patients/{{patient_id}}/episodes/{{episode_id}} |
episode:write | PATCH api/patients/{{patient_id}}/episodes/{{episode_id}}/actions/close |
episode:write | PATCH /api/patients/{{patient_id}}/episodes/{{episode_id}}/actions/cancel |
encounter:write | POST /api/patients/{{patient_id}}/encounter_package |
encounter:cancel | PATCH /api/patients/{{patient_id}}/encounter_package |
condition:read | GET /api/patients/{{patient_id}}/conditions |
condition:read | GET /api/patients/{{patient_id}}/conditions/{{condition_id}} |
encounter:read | GET /api/patients/{{patient_id}}/encounters/{{encounter_id}} |
encounter:read | GET /api/patients/{{patient_id}}/encounters |
observation:read | GET /api/patients/{{patient_id}}/observations/{{observation_id}} |
observation:read | GET /api/patients/{{patient_id}}/observations |
immunization:read | GET /api/patients/{{patient_id}}/immunizations/{{immunization_id}} |
immunization:read | GET /api/patients/{{patient_id}}/immunizations |
allergy_intolerance:read | GET /api/patients/{{patient_id}}/allergy_intolerances/{{allergy_intolerance_id}} |
allergy_intolerance:read | GET /api/patients/{{patient_id}}/allergy_intolerances |
legal_entity:merge | mergeLegalEntities(input: MergeLegalEntitiesInput!): MergeLegalEntitiesPayload |
related_legal_entities:read | GET /legal_entities/{{id}}/related{?page,page_size} |
legal_entity_merge_job:read | query LegalEntitiesMergeJobsQuery($first: Int!, $filter: LegalEntityMergeJobFilter, $orderBy: LegalEntityMergeJobOrderBy) |
service_request:write | POST /api/patients/{{patient_id}}/service_requests |
service_request:read | GET /api/patients/{{patient_id}}/episodes/{{episode_id}}/service_requests GET /api/patients/{{patient_id}}/episodes/{{episode_id}}/service_requests/{{service_request_id}} |
service_request:use | PATCH /api/service_requests/{{service_request_id}}/actions/use PATCH /api/service_requests/{{service_request_id}}/actions/release |
patient_summary:read | GET /api/patients/{{patient_id}}/summary/episodes GET /api/patients/{{patient_id}}/summary/risk_assessments |
procedure:write | POST /api/patients/{{id}}/procedure |
procedure:cancel | PATCH /api/patients/{{id}}/procedure |
risk_assessment:read | GET /api/patients/{{patient_id}}/risk_assessments/{{id}} GET /api/patients/{{patient_id}}/risk_assessments |
device:read | GET /api/patients/{{patient_id}}/devices/{{id}} |
medication_statement:read | GET /api/patients/{{patient_id}}/medication_statements/{{id}} |
diagnostic_report:read | GET /api/patients/{{patient_id}}/diagnostic_reports/{{id}} |
diagnostic_report:write | POST /api/patients/{{patient_id}}/diagnostic_report_package |
diagnostic_report:cancel | PATCH /api/patients/{{patient_id}}/diagnostic_report_package |
care_plan:write | POST /api/patients/{{patient_id}}/care_plans POST /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities PATCH /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/actions/cancel PATCH /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/actions/complete PATCH /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities{{activity_id}}/actions/cancel PATCH /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities{{activity_id}}/actions/complete |
care_plan:read | GET /api/patients/{{patient_id}}/care_plans GET /api/patients/care_plans?requisition GET /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities GET /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities/{{activity_id}} |
approval:read | GET /api/patients/{{patient_id}}/approvals GET /api/patients/{{patient_id}}/approvals/{{approval_id}} |
approval:cancel | PATCH /api/patients/{{patient_id}}/approvals/{{approval_id}}/actions/cancel |
medical_program_provision:write | POST /api/medical_program_provision PATCH /api/medical_program_provision/{{id}}/actions/deactivate |
medical_program_provision:read | GET /api/medical_program_provision |
medication_request_admin:read | GET /api/admin/medication_requests |
medication_request_admin:details | GET /api/admin/medication_requests/{id} |
medication_dispense_admin:read | GET /api/admin/medication_dispenses |
license:write | POST /api/licenses |
license:read | GET /api/licenses |
license:details | GET /api/licenses/{id} |
medication_request:block | PATCH /api/medication_requests/{id}/actions/block |
medication_request:unblock | PATCH /api/medication_requests/{id}/actions/unblock |
medication_request:block_pharm | PATCH /api/pharmacy/medication_requests/{{id}}/actions/block |
medication_request:details_pharm | GET /api/pharmacy/medication_requests/{{id}} |
medication_dispense:read_pharm | GET /api/pharmacy/medication_dispenses/{{id}} |
clinical_impression:read | GET /api/patients/patient_id/clinical_impressions GET /api/patients/patient_id/clinical_impressions/{id} |
rule_engine_set:write | CreateRuleEngineSetMutation (GraphQL) DeactivateRuleEngineSetMutation (GraphQL) |
rule_engine_set:details | RuleEngineSetQuery (GraphQL) |
rule_engine_set:read | GET /api/rule_engine_sets GET /api/rule_engine_sets/{id} |
justification:write | CreateJustificationInput (GraphQL) |
justification:read | JustificationFilter (GraphQL) |
episode:practical_monitor | EpisodeFilter (GraphQL) EpisodeQuery (GraphQL) |
encounter:practical_monitor | EncounterFilter (GraphQL) EncounterQuery (GraphQL) |
observation:practical_monitor | ObservationFilter (GraphQL) ObservationQuery (GraphQL) |
condition:practical_monitor | ConditionFilter (GraphQL) ConditionQuery (GraphQL) |
procedure:practical_monitor | ProcedureFilter (GraphQL) ProcedureQuery (GraphQL) |
service_request:practical_monitor | ServiceRequestFilter (GraphQL) ServiceRequestQuery (GraphQL) |
immunization:practical_monitor | ImmunizationFilter (GraphQL) ImmunizationQuery (GraphQL) |
allergy_intolerance:practical_monitor | AllergyIntoleranceFilter (GraphQL) AllergyIntoleranceQuery (GraphQL) |
care_plan:practical_monitor | CarePlanFilter (GraphQL) ActivityFilter (GraphQL) CarePlanQuery (GraphQL) ActivityQuery (GraphQL) |
diagnostic_report:practical_monitor | DiagnosticReportFilter (GraphQL) DiagnosticReportQuery (GraphQL) |
medication_request:practical_monitor | MedicationRequestFilter (GraphQL) MedicationRequestQuery (GraphQL) |
medication_dispense:practical_monitor | MedicationDispenseFilter (GraphQL) MedicationDispenseQuery (GraphQL) |
episode:clinical_monitor | EpisodeQuery (GraphQL) |
encounter:clinical_monitor | EncounterQuery (GraphQL) |
observation:clinical_monitor | ObservationQuery (GraphQL) |
condition:clinical_monitor | ConditionQuery (GraphQL) |
procedure:clinical_monitor | ProcedureQuery (GraphQL) |
service_request:clinical_monitor | ServiceRequestFilter (GraphQL) |
immunization:clinical_monitor | ImmunizationFilter (GraphQL) |
allergy_intolerance:clinical_monitor | AllergyIntoleranceFilter (GraphQL) |
care_plan:clinical_monitor | CarePlanQuery (GraphQL) ActivityQuery (GraphQL) |
diagnostic_report:clinical_monitor | DiagnosticReportQuery (GraphQL) |
medication_request:clinical_monitor | MedicationRequestQuery (GraphQL) |
medication_dispense:clinical_monitor | MedicationDispenseQuery (GraphQL) |
conclusion:write | createConclusionInput (GraphQL) |
conclusion:read | ConclusionFilter (GraphQL) ConclusionQuery (GraphQL) |
Client scopes
This scopes is set for each client according to client type. And controlled by client API key (secret)
name | scope |
|---|---|
Auth_FE | app:authorize employee_request:approve employee_request:reject user:request_factor user:approve_factor user:change_password profile:read |
MIS | legal_entity:read legal_entity:write legal_entity:mis_verify role:read event:read user:request_factor user:approve_factor client:read connection:read connection:write connection:refresh_secret connection:delete job:read drugs:read medical_program:read program_service:read |
MSP | employee_role:write employee_role:read healthcare_service:write healthcare_service:read declaration:read declaration_request:approve declaration_request:read declaration_request:reject declaration_request:sign declaration_request:write division:activate division:deactivate division:details division:read division:write drugs:read employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write legal_entity:read medication_dispense:read medication_request:details medication_request:read medication_request:reject medication_request:resend medication_request_request:read medication_request_request:reject medication_request_request:sign medication_request_request:write otp:read otp:write person:read reimbursement_report:read secret:refresh capitation_report:read contract_request:create contract_request:read contract_request:terminate contract_request:approve contract_request:sign contract:read contract:write client:read connection:read connection:write connection:refresh_secret connection:delete patient_summary:read encounter:write encounter:read episode:write episode:read job:read condition:read condition:write observation:read observation:write immunization:read immunization:write allergy_intolerance:read allergy_intolerance:write encounter:cancel related_legal_entities:read service_request:write service_request:read service_request:use service_request:cancel service_request:complete service_request:makeinprogress service_request:recall medication_statement:read medication_statement:write device:read device:write risk_assessment:read risk_assessment:write approval:create diagnostic_report:cancel diagnostic_report:read diagnostic_report:write procedure:read procedure:write procedure:cancel program_service:read medication_administration:read medication_administration:write equipment:write equipment:read person_request:write person_request:read authentication_method_request:write care_plan:write care_plan:read approval:read approval:cancel license:details license:read license:write medication_request:block medication_request:unblock clinical_impression:read rule_engine_set:read |
MSP_LIMITED | capitation_report:read declaration:read declaration_request:read division:details division:read drugs:read employee:details employee:read employee_request:read legal_entity:read medication_dispense:read medication_request:details medication_request:read medication_request_request:read otp:read person:read reimbursement_report:read secret:refresh contract_request:read contract:read encounter:read episode:read job:read client:read connection:read condition:read observation:read immunization:read allergy_intolerance:read related_legal_entities:read license:details license:read |
MSP_PHARMACY | allergy_intolerance:read allergy_intolerance:write capitation_report:read client:read condition:read condition:write connection:delete connection:read connection:refresh_secret connection:write contract:read contract:write contract_request:approve contract_request:create contract_request:read contract_request:sign contract_request:terminate declaration:read declaration_request:approve declaration_request:read declaration_request:reject declaration_request:sign declaration_request:write division:activate division:deactivate division:details division:read division:write drugs:read employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write encounter:cancel encounter:read encounter:write episode:read episode:write immunization:read immunization:write job:read legal_entity:read medical_program:read medication_dispense:process medication_dispense:read medication_dispense:reject medication_dispense:write medication_request:details medication_request:read medication_request:reject medication_request:resend medication_request_request:read medication_request_request:reject medication_request_request:sign medication_request_request:write observation:read observation:write otp:read otp:write patient_summary:read person:read reimbursement_report:read related_legal_entities:read secret:refresh service_request:read service_request:use service_request:write device:read device:write risk_assessment:read risk_assessment:write medication_statement:read medication_statement:write approval:create diagnostic_report:cancel diagnostic_report:read diagnostic_report:write procedure:read procedure:write procedure:cancel service_request:cancel service_request:complete service_request:makeinprogress service_request:recall program_service:read healthcare_service:read healthcare_service:write employee_role:read employee_role:write care_plan:read license:details license:read license:write |
Mithril ADMIN | app:delete app:read app:write client:delete client:read client:write client_type:delete client_type:read client_type:write role:delete role:read role:write token:delete token:read token:write user:delete user:read user:write user:block user:unblock authentication_factor:write authentication_factor:read user:request_factor user:approve_factor |
NHS | bl_user:deactivate bl_user:read bl_user:write capitation_report:read contract:read contract:terminate contract:update contract_request:create contract_request:read contract_request:sign contract_request:terminate contract_request:update declaration:approve declaration:read declaration:reject declaration:terminate declaration:write declaration_documents:read declaration_request:read declaration_request:write dictionary:write division:details division:read employee:deactivate employee:read employee:write employee_request:read employee_request:write employee_request:create global_parameters:read global_parameters:write innm:read innm:write innm_dosage:deactivate innm_dosage:read innm_dosage:write legal_entity:deactivate legal_entity:merge legal_entity:nhs_verify legal_entity:read legal_entity_deactivation_job:read legal_entity_merge_job:read medical_program:deactivate medical_program:read medical_program:write medication:deactivate medication:read medication:write medication_dispense_admin:read medication_dispense:reject medication_request_admin:details medication_request_admin:read party_user:read person:read person:reset_authentication_method program_medication:read program_medication:write register:read register:write register_entry:read reimbursement_report:download reimbursement_report:read related_legal_entities:read user:approve_factor user:request_factor merge_candidate:assign dictionary:read medication_request:reject medication_request:resend declarations_termination_job:read legal_entity:update person:deactivate persons_deactivation_job:read program_service:read program_service:write service_catalog:read service_catalog:write persons_auth_reset_job:read person_merge:read person_merge:write private_contracts:read private_contracts:write declaration:prolongate declarations_prolongation_job:read forbidden_group:write forbidden_group:details person_request:write_nhs person_documents:read person_history:read authentication_method_request:write_nhs justification:write justification:read episode:practical_monitor encounter:practical_monitor observation:practical_monitor condition:practical_monitor procedure:practical_monitor service_request:practical_monitor immunization:practical_monitor allergy_intolerance:practical_monitor care_plan:practical_monitor diagnostic_report:practical_monitor medication_request:practical_monitor medication_dispense:practical_monitor merge_candidate:read approval:create approval:read approval:cancel person:verify episode:clinical_monitor encounter:clinical_monitor observation:clinical_monitor condition:clinical_monitor procedure:clinical_monitor service_request:clinical_monitor immunization:clinical_monitor allergy_intolerance:clinical_monitor care_plan:clinical_monitor diagnostic_report:clinical_monitor medication_request:clinical_monitor medication_dispense:clinical_monitor conclusion:write conclusion:read rule_engine_rule:write rule_engine_rule:details |
NHS ADMIN | bl_user:deactivate bl_user:read bl_user:write declaration:approve declaration:approve declaration:read declaration:reject declaration:write declaration_documents:read declaration_request:read declaration_request:write dictionary:write employee:deactivate employee:read employee:write employee_request:read employee_request:write global_parameters:read global_parameters:read global_parameters:write global_parameters:write innm:read innm:write innm_dosage:deactivate innm_dosage:read innm_dosage:write legal_entity:deactivate legal_entity:nhs_verify legal_entity:read medical_program:deactivate medical_program:read medical_program:write medication:deactivate medication:read medication:write medication_dispense_admin:read medication_dispense:reject medication_request_admin:details medication_request_admin:read merge_candidate:assign party_user:read person:reset_authentication_method program_medication:read program_medication:write user:approve_factor user:request_factor reimbursement_report:download declaration:terminate register:write register:read register_entry:read person:read legal_entity:merge related_legal_entities:read legal_entity_merge_job:read person_merge:read person_merge:write private_contracts:read private_contracts:write person_request:write_nhs person_documents:read person_history:read authentication_method_request:write_nhs person:verify |
PHARMACY | employee_role:write employee_role:read healthcare_service:write healthcare_service:read division:activate division:deactivate division:details division:read division:write employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write legal_entity:read medical_program:read medication_dispense:process medication_dispense:read medication_dispense:reject medication_dispense:write medication_request:details otp:read otp:write reimbursement_report:read secret:refresh client:read connection:read connection:write connection:refresh_secret connection:delete contract_request:create contract_request:read contract_request:terminate contract_request:approve contract_request:sign contract:read contract:write medical_program_provision:write medical_program_provision:read license:details license:read license:write medication_request:block_pharm medication_request:details_pharm medication_dispense:read_pharm |
UADDRESSES ADMIN | address:write address:read user:request_factor user:approve_factor |
PRIMARY_CARE | employee_role:write employee_role:read healthcare_service:write healthcare_service:read declaration:read declaration_request:approve declaration_request:read declaration_request:reject declaration_request:sign declaration_request:write division:activate division:deactivate division:details division:read division:write drugs:read employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write legal_entity:read medication_dispense:read medication_request:details medication_request:read medication_request:reject medication_request:resend medication_request_request:read medication_request_request:reject medication_request_request:sign medication_request_request:write otp:read otp:write person:read reimbursement_report:read secret:refresh capitation_report:read contract_request:create contract_request:read contract_request:terminate contract_request:approve contract_request:sign contract:read contract:write client:read connection:read connection:write connection:refresh_secret connection:delete patient_summary:read encounter:write encounter:read episode:write episode:read job:read condition:read condition:write observation:read observation:write immunization:read immunization:write allergy_intolerance:read allergy_intolerance:write encounter:cancel related_legal_entities:read service_request:write service_request:read service_request:use service_request:cancel service_request:complete service_request:makeinprogress service_request:recall medication_statement:read medication_statement:write device:read device:write risk_assessment:read risk_assessment:write approval:create diagnostic_report:cancel diagnostic_report:read diagnostic_report:write procedure:read procedure:write procedure:cancel program_service:read medication_administration:read medication_administration:write equipment:write equipment:read person_request:write person_request:read authentication_method_request:write care_plan:read approval:read approval:cancel care_plan:write composition:create composition:sign composition:cancel composition:read composition:search license:details license:read license:write medication_request:block medication_request:unblock clinical_impression:read rule_engine_set:read |
OUTPATIENT | employee_role:write employee_role:read healthcare_service:write healthcare_service:read capitation_report:read contract_request:sign declaration:read declaration_request:approve declaration_request:read declaration_request:reject declaration_request:sign declaration_request:write division:activate division:deactivate division:details division:read division:write drugs:read employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write legal_entity:read medication_dispense:read medication_request:details medication_request:read medication_request:reject medication_request:resend medication_request_request:read medication_request_request:reject medication_request_request:sign medication_request_request:write otp:read otp:write person:read reimbursement_report:read secret:refresh contract_request:create contract_request:read contract_request:terminate contract:read contract_request:approve contract:write contract:terminate client:read connection:read connection:write connection:refresh_secret connection:delete patient_summary:read related_legal_entities:read encounter:write encounter:read episode:write episode:read job:read condition:read condition:write observation:read observation:write immunization:read immunization:write allergy_intolerance:read allergy_intolerance:write encounter:cancel service_request:write service_request:read service_request:use approval:create merge_candidate:assign medication_statement:read medication_statement:write device:read device:write risk_assessment:read risk_assessment:write diagnostic_report:read diagnostic_report:write diagnostic_report:cancel service_request:cancel service_request:recall service_request:complete service_request:makeinprogress program_service:read medication_administration:read medication_administration:write procedure:read procedure:write procedure:cancel equipment:write equipment:read person_request:write person_request:read preperson:read preperson:write authentication_method_request:write merge_request:write merge_request:read merge_request:sign care_plan:write care_plan:read composition:create composition:search composition:read composition:sign composition:cancel approval:read approval:cancel license:details license:read license:write medication_request:block medication_request:unblock clinical_impression:read rule_engine_set:read |
EMERGENCY | capitation_report:read contract_request:sign division:activate division:deactivate division:details division:read division:write drugs:read employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write legal_entity:read medication_dispense:read medication_request:details medication_request:read medication_request:reject medication_request:resend medication_request_request:read medication_request_request:reject medication_request_request:sign medication_request_request:write otp:read otp:write person:read reimbursement_report:read secret:refresh contract_request:create contract_request:read contract_request:terminate contract:read contract_request:approve contract:write contract:terminate client:read connection:read connection:write connection:refresh_secret connection:delete patient_summary:read related_legal_entities:read encounter:write encounter:read episode:write episode:read job:read condition:read condition:write observation:read observation:write immunization:read immunization:write allergy_intolerance:read allergy_intolerance:write encounter:cancel service_request:write service_request:read service_request:use approval:create merge_candidate:assign medication_statement:read medication_statement:write device:read device:write risk_assessment:read risk_assessment:write diagnostic_report:read diagnostic_report:write diagnostic_report:cancel service_request:cancel service_request:recall service_request:complete service_request:makeinprogress program_service:read procedure:read procedure:write procedure:cancel employee_role:write employee_role:read healthcare_service:write healthcare_service:read medication_administration:read medication_administration:write equipment:write equipment:read person_request:write person_request:read preperson:read preperson:write merge_request:write merge_request:read merge_request:sign care_plan:read license:details license:read license:write medication_request:block medication_request:unblock clinical_impression:read rule_engine_set:read |
CABINET | medication_administration:read procedure:read diagnostic_report:read encounter:read service_request:read medication_statement:read device:read medication_dispense:read risk_assessment:read allergy_intolerance:read observation:read immunization:read condition:read episode:read medication_request:details medication_request:read cabinet:read employee_request:approve employee_request:reject user:request_factor user:approve_factor user:change_password app:authorize declaration_request:write declaration_request:read declaration_request:terminate declaration:read person:read person:write declaration:terminate app:read app:write app:delete authentication_factor:write authentication_factor:read profile:read justification:read |
Roles scopes
This scopes is set for each client according to client role. And controlled by client API key.
role | scopes |
|---|---|
ADMIN | declaration:read declaration_request:approve declaration_request:reject declaration_request:read declaration_request:sign declaration_request:write capitation_report:read division:details division:read employee:read employee_request:approve employee_request:reject employee_request:read legal_entity:read otp:read otp:write person:read service_request:read service_request:use contract_request:sign contract_request:create contract_request:read contract_request:terminate contract_request:approve contract:read contract:write healthcare_service:read healthcare_service:write employee_role:read employee_role:write equipment:write equipment:read employee_request:write license:read license:details |
CABINET | medication_administration:read procedure:read diagnostic_report:read encounter:read service_request:read medication_statement:read device:read medication_dispense:read risk_assessment:read allergy_intolerance:read observation:read immunization:read condition:read episode:read medication_request:details medication_request:read cabinet:read employee_request:approve employee_request:reject user:request_factor user:approve_factor user:change_password app:authorize declaration_request:write declaration_request:read declaration_request:terminate declaration:read person:read person:write declaration:terminate app:read app:write app:delete authentication_factor:write authentication_factor:read profile:read justification:read |
DOCTOR | declaration:read declaration_request:approve declaration_request:read declaration_request:sign declaration_request:write division:read employee:read employee_request:approve employee_request:reject employee_request:read legal_entity:read otp:read otp:write person:read patient_summary:read encounter:write encounter:read encounter:cancel episode:write episode:read job:read condition:read condition:write observation:read observation:write immunization:read immunization:write allergy_intolerance:read allergy_intolerance:write medication_statement:read medication_statement:write device:read device:write risk_assessment:read risk_assessment:write medication_dispense:read drugs:read medication_request:details medication_request:read medication_request:reject medication_request:resend medication_request_request:read medication_request_request:reject medication_request_request:sign medication_request_request:write diagnostic_report:read diagnostic_report:write diagnostic_report:cancel procedure:read procedure:write procedure:cancel service_request:makeinprogress service_request:complete service_request:recall service_request:cancel service_request:write service_request:read service_request:use approval:create program_service:read medication_administration:read medication_administration:write healthcare_service:read employee_role:read person_request:write person_request:read authentication_method_request:write care_plan:read approval:read approval:cancel care_plan:write composition:create composition:sign composition:cancel composition:read composition:search license:read medication_request:block medication_request:unblock clinical_impression:read rule_engine_rule:read |
HR | division:details division:write division:activate division:deactivate division:read employee:read employee:write employee:details employee:deactivate employee_request:approve employee_request:reject employee_request:write employee_request:read legal_entity:read healthcare_service:read healthcare_service:write employee_role:read employee_role:write equipment:write equipment:read license:read license:details |
MIS USER | legal_entity:read legal_entity:write legal_entity:mis_verify role:read user:request_factor user:approve_factor event:read client:read connection:read connection:write connection:refresh_secret connection:delete medical_program:read program_service:read |
MITHRIL ADMIN | app:read app:write app:delete token:read token:write token:delete user:read user:write user:delete role:read role:write role:delete client_type:read client_type:write client_type:delete client:read client:write client:delete user:block user:unblock user:request_factor user:approve_factor authentication_factor:write authentication_factor:read |
NHS ADMIN | bl_user:deactivate bl_user:read bl_user:write capitation_report:read declaration:approve declaration:read declaration:reject declaration:terminate declarations_termination_job:read declaration:write declaration_documents:read dictionary:read dictionary:write division:read employee:read employee:deactivate employee_request:read employee_request:write global_parameters:read global_parameters:write innm:read innm:write innm_dosage:deactivate innm_dosage:read innm_dosage:write legal_entity:update legal_entity:merge legal_entity:nhs_verify legal_entity:read legal_entity_deactivation_job:read legal_entity_merge_job:read medical_program:deactivate medical_program:read medical_program:write medication:deactivate medication:read medication:write medication_dispense_admin:read medication_dispense:reject medication_request_admin:details medication_request_admin:read party_user:read person:read person:deactivate persons_deactivation_job:read person:reset_authentication_method program_medication:read program_medication:write register:read register:write register_entry:read reimbursement_report:download related_legal_entities:read user:approve_factor user:request_factor program_service:write program_service:read service_catalog:read service_catalog:write persons_auth_reset_job:read private_contracts:read private_contracts:write declaration:prolongate declarations_prolongation_job:read person_request:write_nhs person_documents:read person_history:read authentication_method_request:write_nhs merge_candidate:read person:verify contract:update |
NHS ADMIN ADMIN | global_parameters:read global_parameters:write dictionary:write user:request_factor user:approve_factor |
NHS FORBIDDEN ADMIN | forbidden_group:write forbidden_group:details dictionary:read service_catalog:read |
NHS ADMIN MANAGER | legal_entity:read user:request_factor user:approve_factor medication_request_admin:read medication_request_admin:details medication_dispense_admin:read |
NHS ADMIN MONITORING | bl_user:read capitation_report:read contract:read contract_request:read declaration:read declaration_documents:read dictionary:read division:read employee:read innm:read innm_dosage:read legal_entity:read medical_program:read medication:read medication_dispense_admin:read medication_request_admin:details medication_request_admin:read party_user:read person:read program_medication:read register:read reimbursement_report:download related_legal_entities:read user:approve_factor user:request_factor |
NHS ADMIN SIGNER | capitation_report:read contract:read contract:terminate contract_request:create contract_request:read contract_request:sign contract_request:terminate contract_request:update division:details division:read employee:read legal_entity:nhs_verify legal_entity:read legal_entity:update private_contracts:read private_contracts:write contract:update |
NHS ADMIN SUPPORT | legal_entity:read employee:read user:request_factor user:approve_factor |
NHS ADMIN VERIFIER | bl_user:read bl_user:write capitation_report:read declaration:approve declaration:read declaration:reject declaration:terminate declaration:write declaration_documents:read declarations_termination_job:read dictionary:read dictionary:write innm:read innm_dosage:read legal_entity:read medical_program:read medication:read medication_dispense:reject medication_request:reject medication_request:resend person:deactivate persons_deactivation_job:read person:read person:reset_authentication_method register:write register_entry:read related_legal_entities:read user:approve_factor user:request_factor persons_auth_reset_job:read person_request:write_nhs person_history:read authentication_method_request:write_nhs merge_candidate:read person:verify person_merge:read person_documents:read |
NHS LE VERIFIER | division:details division:read employee:read legal_entity:merge legal_entity:nhs_verify legal_entity:read legal_entity_deactivation_job:read legal_entity_merge_job:read legal_entity:update related_legal_entities:read user:approve_factor user:request_factor |
NHS LE TERMINATOR | legal_entity:read legal_entity:deactivate |
NHS REVIEWER | person_merge:read merge_candidate:assign person_merge:write |
NHS ADMIN PROGRAM MEDICATION | division:read innm:read innm:write innm_dosage:deactivate innm_dosage:read innm_dosage:write legal_entity:read medical_program:deactivate medical_program:read medical_program:write medication:deactivate medication:read medication:write medication_dispense:reject program_medication:read program_medication:write reimbursement_report:download program_service:read program_service:write service_catalog:read service_catalog:write |
OWNER | employee_role:write employee_role:read healthcare_service:write healthcare_service:read declaration:read declaration_request:approve declaration_request:read declaration_request:reject declaration_request:write division:activate division:deactivate division:details division:read division:write employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write legal_entity:read otp:read otp:write person:read reimbursement_report:read secret:refresh capitation_report:read contract_request:create contract_request:read contract_request:terminate contract_request:approve contract_request:sign client:read connection:read connection:write connection:refresh_secret connection:delete related_legal_entities:read contract:read contract:write medication_request:details medication_dispense:read equipment:write equipment:read medical_program_provision:write medical_program_provision:read license:details license:read license:write rule_engine_rule:read |
PHARMACIST | division:read employee:read employee_request:approve employee_request:reject employee_request:read legal_entity:read medication_dispense:process medication_dispense:read medication_dispense:write medication_dispense:reject medication_request:details healthcare_service:read employee_role:read license:read medication_request:details_pharm medication_request:block_pharm medication_dispense:read_pharm |
PHARMACY_OWNER | employee_role:write employee_role:read healthcare_service:write healthcare_service:read division:activate division:deactivate division:details division:read division:write employee:deactivate employee:details employee:read employee:write employee_request:approve employee_request:read employee_request:reject employee_request:write legal_entity:read otp:read otp:write reimbursement_report:read secret:refresh medication_request:details client:read connection:read connection:write connection:refresh_secret connection:delete contract_request:create contract_request:read contract_request:terminate contract_request:approve contract_request:sign contract:read contract:write medication_dispense:read medical_program_provision:write medical_program_provision:read license:details license:read license:write medication_request:details_pharm medication dispense:read_pharm |
UADDRESSES ADMIN | address:read address:write user:request_factor user:approve_factor |
NHS ADMIN REIMBURSEMENT | division:details division:read employee:read legal_entity:read medication_dispense_admin:read medication_dispense:reject medication_request_admin:details medication_request_admin:read medication_request:reject medication_request:resend reimbursement_report:download |
ASSISTANT | division:read employee:read employee_request:approve employee_request:reject employee_request:read legal_entity:read otp:read otp:write person:read patient_summary:read diagnostic_report:read diagnostic_report:write diagnostic_report:cancel procedure:read procedure:write procedure:cancel service_request:makeinprogress service_request:complete service_request:read service_request:use approval:create healthcare_service:read employee_role:read person_request:write person_request:read preperson:read preperson:write job:read observation:read observation:write allergy_intolerance:write medication_statement:write device:write risk_assessment:write medication_administration:write authentication_method_request:write merge_request:write merge_request:read immunization:read care_plan:read approval:read approval:cancel episode:read episode:write encounter:write encounter:read encounter:cancel immunization:write condition:write condition:read license:read medication_request_request:read medication_request:read medication_request:details medication_dispense:read medication_request:resend clinical_impression:read rule_engine_rule:read |
SPECIALIST | division:read employee:read employee_request:approve employee_request:reject employee_request:read legal_entity:read otp:read otp:write person:read patient_summary:read encounter:write encounter:read encounter:cancel episode:write episode:read job:read condition:read condition:write observation:read observation:write immunization:read immunization:write allergy_intolerance:read allergy_intolerance:write medication_statement:read medication_statement:write device:read device:write risk_assessment:read risk_assessment:write medication_dispense:read drugs:read medication_request:details medication_request:read medication_request:reject medication_request:resend medication_request_request:read medication_request_request:reject medication_request_request:sign medication_request_request:write diagnostic_report:read diagnostic_report:write diagnostic_report:cancel procedure:read procedure:write procedure:cancel service_request:makeinprogress service_request:complete service_request:recall service_request:cancel service_request:write service_request:read service_request:use approval:create program_service:read medication_administration:read medication_administration:write healthcare_service:read employee_role:read person_request:write person_request:read preperson:read preperson:write authentication_method_request:write merge_request:write merge_request:sign merge_request:read composition:create composition:search composition:read composition:sign composition:cancel care_plan:write care_plan:read approval:read approval:cancel license:read medication_request:block medication_request:unblock clinical_impression:read rule_engine_set:read |
MED_ADMIN | diagnostic_report:read diagnostic_report:cancel encounter:read encounter:cancel episode:read procedure:read procedure:cancel person:read preperson:read patient_summary:read division:read employee:read legal_entity:read job:read condition:read observation:read allergy_intolerance:read risk_assessment:read immunization:read license:read reimbursement_report:read medication_request_request:read medication_request:read medication_request:details medication_request:resend medication_request:reject medication_dispense:read medication_request_request:reject medication_request:block medication_request:unblock clinical_impression:read |
RECEPTIONIST | declaration:read declaration_request:approve declaration_request:reject declaration_request:read declaration_request:sign declaration_request:write capitation_report:read division:details division:read employee:read employee_request:approve employee_request:reject legal_entity:read otp:read otp:write person:read service_request:read service_request:use approval:create healthcare_service:read employee_role:read person_request:write person_request:read preperson:read preperson:write authentication_method_request:write merge_request:write merge_request:read job:read observation:write allergy_intolerance:write medication_statement:write device:write risk_assessment:write medication_administration:write license:read license:details |
NHS ADMIN MONITORING | bl_user:read capitation_report:read contract:read contract_request:read declaration:read declaration_documents:read dictionary:read division:read employee:read innm:read innm_dosage:read legal_entity:read medical_program:read medication:read medication_dispense_admin:read medication_request_admin:details medication_request_admin:read party_user:read person:read program_medication:read register:read reimbursement_report:download related_legal_entities:read user:approve_factor user:request_factor program_service:read service_catalog:read private_contracts:read person_documents:read person_history:read |
NHS PRACTICAL MONITORING | justification:write justification:read episode:practical_monitor encounter:practical_monitor observation:practical_monitor condition:practical_monitor procedure:practical_monitor service_request:practical_monitor immunization:practical_monitor allergy_intolerance:practical_monitor care_plan:practical_monitor diagnostic_report:practical_monitor medication_request:practical_monitor medication_dispense:practical_monitor dictionary:read service_catalog:read person:read person_documents:read person_merge:read division:read employee:read innm_dosage:read innm:read legal_entity:read medical_program:read medication:read party_user:read program_medication:read program_service:read related_legal_entities:read declaration:read declaration_documents:read |
NHS PRACTICAL MONITORING EXTENDED | justification:write justification:read episode:practical_monitor encounter:practical_monitor observation:practical_monitor condition:practical_monitor procedure:practical_monitor service_request:practical_monitor immunization:practical_monitor allergy_intolerance:practical_monitor care_plan:practical_monitor diagnostic_report:practical_monitor medication_request:practical_monitor medication_dispense:practical_monitor dictionary:read service_catalog:read person:read person_documents:read person_merge:read division:read employee:read innm_dosage:read innm:read legal_entity:read medical_program:read medication:read party_user:read program_medication:read program_service:read related_legal_entities:read forbidden_group:details approval:cancel approval:create approval:read declaration:read declaration_documents:read |
NHS CLINICAL MONITORING | episode:clinical_monitor encounter:clinical_monitor observation:clinical_monitor condition:clinical_monitor procedure:clinical_monitor service_request:clinical_monitor immunization:clinical_monitor allergy_intolerance:clinical_monitor care_plan:clinical_monitor diagnostic_report:clinical_monitor medication_request:clinical_monitor medication_dispense:clinical_monitor dictionary:read service_catalog:read division:read employee:read innm_dosage:read innm:read legal_entity:read medical_program:read medication:read party_user:read program_medication:read program_service:read conclusion:write conclusion:read |
DOCTOR_LIMITED | declaration:read declaration_request:read division:read employee:read employee_request:read legal_entity:read otp:read person:read encounter:read episode:read job:read condition:read observation:read immunization:read allergy_intolerance:read medication_dispense:read drugs:read medication_request:details medication_request:read medication_request_request:read license:read clinical_impression:read |
NHS ADMIN CONTRACTOR | legal_entity:read employee:read contract_request:read contract_request:update contract_request:terminate contract:read |
NHS RULE ENGINE ADMIN | rule_engine_set:write rule_engine_set:details dictionary:read service_catalog:read |