Skip to content

Commit a38fc7d

Browse files
Update the readme file
1 parent 5ee7dbf commit a38fc7d

File tree

1 file changed

+57
-13
lines changed

1 file changed

+57
-13
lines changed

README.md

Lines changed: 57 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,63 @@ As a leader in the development of Electronic Health Record (EHR) systems, **Blue
1818

1919
## Documentation
2020

21-
For detailed information on how to install, configure, and use the `ABDM-ruby` gem, please refer to the documentation in the `docs` directory:
22-
23-
- [Installation Guide](docs/1_installation.md)
24-
- [Configuration Guide](docs/2_configuration.md)
25-
26-
- **Usage**
27-
28-
- [ABHA (Ayushman Bharat Health Account) Number](#abha-ayushman-bharat-health-account-number)
29-
30-
31-
- [HFR (Health Facility Registry)](#hfr-health-facility-registry)
32-
33-
- [HPR (Health Professional Registry)](#hpr-health-professional-registry)
21+
For detailed information on how to install, configure, and use the `ABDM-ruby` gem, please refer to the documentation in the `docs` directory. Below is a breakdown of the available documentation:
22+
23+
### 1. **Installation and Configuration**
24+
- [Installation Guide](/docs/1_installation.md)
25+
- [Configuration Guide](/docs/2_configuration.md)
26+
- [Response and Exception Handling](/docs/3_response_and_exception_handling.md)
27+
- [Contributing Guidelines](/docs/4_contributing.md)
28+
29+
### 2. **ABHA (Ayushman Bharat Health Account)**
30+
- [Creation via Aadhaar](/docs/abha/1_creation_via_aadhaar.md)
31+
- [Creation via Driving License](/docs/abha/2_creation_via_driving_license.md)
32+
33+
### 3. **HFR (Health Facility Registry)**
34+
- **Onboarding Process**:
35+
- [Basic Facility Information](/docs/hfr/on-boarding-hfr/1_basic_facility_info.md)
36+
- [Additional Information](/docs/hfr/on-boarding-hfr/2_additional_info.md)
37+
- [Detailed Information](/docs/hfr/on-boarding-hfr/3_detailed_info.md)
38+
- [Submit Facility Details](/docs/hfr/on-boarding-hfr/4_submit_facility_details.md)
39+
40+
### 4. **HPR (Health Professional Registry)**
41+
- **Registration Process**:
42+
- [Generate Aadhaar OTP](/docs/hpr/registration/1_generate_aadhaar_otp.md)
43+
- [Verify Aadhaar OTP](/docs/hpr/registration/2_verify_aadhaar_otp.md)
44+
- [Check HPI ID Existence](/docs/hpr/registration/3_check_hpi_id_existence.md)
45+
- [Verify Mobile Number Matches Aadhaar](/docs/hpr/registration/4_verify_mobile_number_matches_aadhaar.md)
46+
- [Generate Mobile OTP](/docs/hpr/registration/5_1_generate_mobile_otp.md)
47+
- [Verify Mobile OTP](/docs/hpr/registration/5_2_verify_mobile_otp.md)
48+
- [Suggest Username](/docs/hpr/registration/6_suggest_username.md)
49+
- [Create HPRID](/docs/hpr/registration/7_create_hprid.md)
50+
- [Search Facility](/docs/hpr/registration/8_search_facility.md)
51+
- [Register Professional](/docs/hpr/registration/9_register_professional.md)
52+
- [Retrieve Document List](/docs/hpr/registration/10_retrieve_document_list.md)
53+
- [Upload Documents](/docs/hpr/registration/11_upload_documents.md)
54+
55+
### 5. **Master/Utility APIs**
56+
- **HFR Master Data**:
57+
- [Master Types](/docs/master_or_utility_apis/hfr/1_master_types.md)
58+
- [Master Data](/docs/master_or_utility_apis/hfr/2_master_data.md)
59+
- [LGD States](/docs/master_or_utility_apis/hfr/3_lgd_states.md)
60+
- [Facility Types](/docs/master_or_utility_apis/hfr/4_facility_types.md)
61+
- [Owner Subtypes](/docs/master_or_utility_apis/hfr/5_owner_subtypes.md)
62+
- [Specialities](/docs/master_or_utility_apis/hfr/6_specialities.md)
63+
- [Facility Subtypes](/docs/master_or_utility_apis/hfr/7_facility_subtypes.md)
64+
- [ABDM Complaint Software](/docs/master_or_utility_apis/hfr/8_abdm_complaint_software.md)
65+
66+
- **HPR Master Data**:
67+
- [System of Medicine](/docs/master_or_utility_apis/hpr/1_system_of_medicine.md)
68+
- [Medical Councils](/docs/master_or_utility_apis/hpr/2_medical_council.md)
69+
- [Languages](/docs/master_or_utility_apis/hpr/3_languages.md)
70+
- [Universities](/docs/master_or_utility_apis/hpr/4_universities.md)
71+
- [Colleges](/docs/master_or_utility_apis/hpr/5_colleges.md)
72+
- [Courses](/docs/master_or_utility_apis/hpr/6_courses.md)
73+
- [Countries](/docs/master_or_utility_apis/hpr/7_countries.md)
74+
- [States](/docs/master_or_utility_apis/hpr/8_states.md)
75+
- [Districts](/docs/master_or_utility_apis/hpr/9_districts.md)
76+
- [Sub-districts](/docs/master_or_utility_apis/hpr/10_sub_districts.md)
77+
- [Nurse Affiliated Boards](/docs/master_or_utility_apis/hpr/11_nurse_affiliated_boards.md)
3478

3579

3680
## Quick Start

0 commit comments

Comments
 (0)