Skip to content

Commit 2aea3a1

Browse files
Bikash-bluebashBikash-bluebash
committed
Added docs for HPR utility apis
1 parent fb36c03 commit 2aea3a1

File tree

11 files changed

+1403
-0
lines changed

11 files changed

+1403
-0
lines changed

‎docs/master_or_utility_apis/hpr/10_sub_districts.md‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# Sub-Districts API
2+
3+
The Sub-Districts API fetches a list of all sub-districts. You can filter the sub-districts based on parameters provided in the payload.
4+
5+
6+
## Parameters
7+
8+
- `state_name` (String, optional) - The name of the state to filter sub-districts by.
9+
10+
11+
## Method
12+
```ruby
13+
fetch_sub_districts(state_name: )
14+
```
15+
16+
17+
## Request Body 1
18+
19+
To fetch sub-districts in a specific state:
20+
21+
```ruby
22+
@client.fetch_sub_districts(state_name: 'LAKSHADWEEP')
23+
```
24+
25+
26+
#### Response
27+
28+
```json
29+
{
30+
"subDistrictsList": [
31+
{
32+
"identifier": 4599,
33+
"name": "'N' Thingdawl",
34+
"subDistrictISO": "1899",
35+
"district": "KOLASIB"
36+
},
37+
{
38+
"identifier": 71,
39+
"name": "A.Konduru",
40+
"subDistrictISO": "4998",
41+
"district": "KRISHNA"
42+
},
43+
{
44+
"identifier": 1,
45+
"name": "Aali",
46+
"subDistrictISO": "2925",
47+
"district": "KENDRAPARA"
48+
},
49+
{
50+
"identifier": 2,
51+
"name": "Aalo HQ",
52+
"subDistrictISO": "6087",
53+
"district": "WEST SIANG"
54+
},
55+
{
56+
"identifier": 3,
57+
"name": "Abapura",
58+
"subDistrictISO": "6612",
59+
"district": "BANSWARA"
60+
},
61+
{
62+
"identifier": 4,
63+
"name": "Abdasa",
64+
"subDistrictISO": "3728",
65+
"district": "KACHCHH"
66+
},
67+
{
68+
"identifier": 6857,
69+
"name": "Zunheboto Sadar",
70+
"subDistrictISO": "1772",
71+
"district": "ZUNHEBOTO"
72+
}
73+
],
74+
"Message": null
75+
}
76+
```
77+
78+
79+
## request Body 2
80+
81+
To fetch a list of all sub-districts:
82+
83+
```ruby
84+
@client.fetch_sub_districts
85+
```
86+
87+
88+
## Response Body
89+
```json
90+
{
91+
"subDistrictsList": [
92+
{
93+
"identifier": 4599,
94+
"name": "'N' Thingdawl",
95+
"subDistrictISO": "1899",
96+
"district": "KOLASIB"
97+
},
98+
{
99+
"identifier": 71,
100+
"name": "A.Konduru",
101+
"subDistrictISO": "4998",
102+
"district": "KRISHNA"
103+
},
104+
{
105+
"identifier": 1,
106+
"name": "Aali",
107+
"subDistrictISO": "2925",
108+
"district": "KENDRAPARA"
109+
},
110+
{
111+
"identifier": 2,
112+
"name": "Aalo HQ",
113+
"subDistrictISO": "6087",
114+
"district": "WEST SIANG"
115+
},
116+
{
117+
"identifier": 3,
118+
"name": "Abapura",
119+
"subDistrictISO": "6612",
120+
"district": "BANSWARA"
121+
},
122+
{
123+
"identifier": 4,
124+
"name": "Abdasa",
125+
"subDistrictISO": "3728",
126+
"district": "KACHCHH"
127+
},
128+
{
129+
"identifier": 5,
130+
"name": "Abdullapurmet",
131+
"subDistrictISO": "6319",
132+
"district": "RANGA REDDY"
133+
},
134+
{
135+
"identifier": 6857,
136+
"name": "Zunheboto Sadar",
137+
"subDistrictISO": "1772",
138+
"district": "ZUNHEBOTO"
139+
}
140+
],
141+
"Message": null
142+
}
143+
```
144+
145+
## Notes
146+
147+
- The `state_name` field can be used to filter sub-districts by their state.
148+
- If no parameters are provided, the API will return a list of all available sub-districts.

‎docs/master_or_utility_apis/hpr/11_nurse_affiliated_boards.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Nurse Affiliated Boards API
2+
3+
The Nurse Affiliated Boards API fetches a list of affiliated boards or universities. You can filter the results based on parameters provided in the payload.
4+
5+
6+
## Parameters
7+
8+
- `identifier` (Integer, optional) - The unique identifier of the affiliated board or university to filter by.
9+
10+
11+
## Method
12+
```ruby
13+
fetch_nurse_affiliated_boards(
14+
identifier:
15+
)
16+
```
17+
18+
19+
## Request Body 1
20+
To fetch nurse affiliated boards with a specific identifier:
21+
22+
```ruby
23+
@client.fetch_nurse_affiliated_boards(identifier: 1)
24+
```
25+
26+
27+
#### Response
28+
```json
29+
{
30+
"nurseAffiliatedBoard": [
31+
{
32+
"identifier": 1,
33+
"name": "Central Board Of Secondary Education (CBSE)",
34+
"state": null
35+
}
36+
],
37+
"Message": null
38+
}
39+
```
40+
41+
42+
## Request Body 2
43+
44+
To fetch a list of all nurse affiliated boards:
45+
46+
```ruby
47+
@client.fetch_nurse_affiliated_boards
48+
```
49+
50+
51+
## Response Body
52+
53+
```json
54+
{
55+
"nurseAffiliatedBoard": [
56+
{
57+
"identifier": 280,
58+
"name": "ABC BOARD",
59+
"state": "Sikkim"
60+
},
61+
{
62+
"identifier": 358,
63+
"name": "Acharaya N.G.Ranga Agricultural University",
64+
"state": "Telangana"
65+
},
66+
{
67+
"identifier": 281,
68+
"name": "Acharaya Nagarjuna University",
69+
"state": "Sikkim"
70+
},
71+
{
72+
"identifier": 462,
73+
"name": "ALIAH UNIVERSITY",
74+
"state": "West bengal"
75+
},
76+
{
77+
"identifier": 398,
78+
"name": "ALIGARH MUSLIM UNIVERSITY",
79+
"state": "Uttarakhand"
80+
},
81+
{
82+
"identifier": 208,
83+
"name": "YMCA University of Science & Technology",
84+
"state": "Punjab"
85+
}
86+
],
87+
"Message": null
88+
}
89+
```
90+
91+
## Notes
92+
93+
- The `identifier` field can be used to filter the affiliated boards by their unique identifier.
94+
- If no parameters are provided, the API will return a list of all available nurse affiliated boards.

‎docs/master_or_utility_apis/hpr/1_system_of_medicine.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# System of Medicine API
2+
3+
The `System of Medicine API` retrieves a list of systems of medicine used in the Health Facility Registry (HFR) system. This list helps categorize and standardize the medical practices followed in various health facilities.
4+
5+
6+
## Notes
7+
8+
1. This API does not require any parameters.
9+
10+
2. The response includes a list of `systemofMedicineList`.
11+
12+
13+
## Method
14+
```ruby
15+
fetch_system_of_medicine()
16+
```
17+
18+
19+
## Request Body
20+
21+
```ruby
22+
@client.fetch_system_of_medicine
23+
```
24+
25+
26+
## Response Body
27+
28+
```json
29+
{
30+
"systemofMedicineList": [
31+
{
32+
"identifier": 4,
33+
"name": "Ayurveda",
34+
"code": "ayurveda"
35+
},
36+
{
37+
"identifier": 2,
38+
"name": "Dentistry",
39+
"code": "dentist"
40+
},
41+
{
42+
"identifier": 3,
43+
"name": "Homoeopathy",
44+
"code": "homeopathy"
45+
},
46+
{
47+
"identifier": 1,
48+
"name": "Modern Medicine",
49+
"code": "modern_medicine"
50+
},
51+
{
52+
"identifier": 13,
53+
"name": "Pharmacy",
54+
"code": "pharma"
55+
},
56+
{
57+
"identifier": 8,
58+
"name": "Registered Auxiliary Nurse Midwife(RANM)",
59+
"code": "ranm"
60+
},
61+
{
62+
"identifier": 11,
63+
"name": "Registered Lady Health Visitor (RLHV)",
64+
"code": "rlhv"
65+
},
66+
{
67+
"identifier": 9,
68+
"name": "registered nurse (RN)",
69+
"code": "rn"
70+
},
71+
{
72+
"identifier": 10,
73+
"name": "Registered Nurse and Registered Midwife (RN & RM)",
74+
"code": "rnrm"
75+
},
76+
{
77+
"identifier": 12,
78+
"name": "Registered Pharmacist",
79+
"code": "rp"
80+
},
81+
{
82+
"identifier": 6,
83+
"name": "Siddha",
84+
"code": "siddha"
85+
},
86+
{
87+
"identifier": 7,
88+
"name": "Sowa-Rigpa",
89+
"code": "sowa_rigpa"
90+
},
91+
{
92+
"identifier": 5,
93+
"name": "Unani",
94+
"code": "unani"
95+
}
96+
],
97+
"Message": null
98+
}
99+
```

0 commit comments

Comments
 (0)