Skip to content

Commit 8257e61

Browse files
nirmal070125claude
andcommitted
Fix typos and grammar errors across documentation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 1e373cb commit 8257e61

21 files changed

Lines changed: 57 additions & 57 deletions

en/docs/advance-topics/guides/enable-workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Healthcare accelerator provides the following capabilities.
1111

1212
- View the user details in a user creation request.
1313
- Option to approve/reject user creation request.
14-
- View the application details in a application creation request.
14+
- View the application details in an application creation request.
1515
- Option to approve/reject application creation request.
1616

1717
## How to enable the User/Application creation workflow
@@ -51,6 +51,6 @@ merge.sh
5151
1. Sign in to the Devportal and create an application.
5252
2. Since the application creation flow is enabled, initially application will remain as inactive until it gets approved.
5353
3. Login to the Admin Portal (https://localhost:9443/admin) and click on '**Application Creation**'.
54-
4. The application creation request is displyed in the Admin Portal for Admin user to approve/reject.
54+
4. The application creation request is displayed in the Admin Portal for Admin user to approve/reject.
5555
![application creation request](/assets/img/learn/workflow/application-creation-approval.png)
5656
5. Once the application creation request is approved, user should be able to use the application as it becomes active.

en/docs/configurations/email-notification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This is a required configuration.
4343
<strong>Note:</strong>The values given within '${}' are the default placeholders that will be populated internally.
4444

4545
:::
46-
### Upon User Approval/Rejection - To Specified Roles and Receipients
46+
### Upon User Approval/Rejection - To Specified Roles and Recipients
4747

4848
```json
4949
[[healthcare.notification.mail]]
@@ -77,7 +77,7 @@ This is a required configuration.
7777
email_body = "<html><body>A new application has been created. Visit the <a href=\"${server_url}/admin/tasks/application-creation/\">admin portal</a> to approve/reject.</body></html>"
7878
```
7979

80-
### Upon Application Approval/Rejection - To Specified Roles and Receipients
80+
### Upon Application Approval/Rejection - To Specified Roles and Recipients
8181

8282
```json
8383
[[healthcare.notification.mail]]

en/docs/data-transformation/guides/hl7v2-fhir.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,11 +220,11 @@ The service processes incoming POST requests containing HL7v2 messages. When a m
220220

221221
Let's look into the the detailed implementation of this. Let's assume the [custom-service-openapi.yaml](../references/custom-service-openapi.yaml) is inside the resources folder.
222222

223-
1. Genarate the files using openapi files as below.
223+
1. Generate the files using openapi files as below.
224224
```bash
225225
bal openapi -i resources/custom-service-openapi.yaml --mode service -o <OUTPUT-FOLDER>
226226
```
227-
2. They types.bal file is auto generated to the specified folder and it does not need any changes to be done.
227+
2. The types.bal file is auto generated to the specified folder and it does not need any changes to be done.
228228
3. Update the custom-service-openapi-service.bal file as below.
229229
```ballerina
230230
// AUTO-GENERATED FILE.

en/docs/fhir/guides/connecting-ehr-emr-systems.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ title: "Connecting Ehr EMR Systems"
44
description: WSO2’s solution offers out-of-the-box connectors for Health Care vendors such as EPIC, Cerner, and Athena Health EMRs and is capable of generating connectors automatically to any F.
55
---
66

7-
#Connecting EHR/EMR Systems
7+
# Connecting EHR/EMR Systems
88

9-
##Overview
10-
WSO2’s solution offers out-of-the-box connectors for Health Care vendors such as EPIC, Cerner, and Athena Health EMRs and is capable of generating connectors automatically to any FHIR based or Open API specificationbased EHR/EMR system.<br /> These connectors will increase the developer's productivity by providing an abstraction to the EHR/EMR system endpoints, but are not a must for WSO2 to integrate with an EHR/EMR.<br /><br /> This section will provide instruction on how to obtain the EHR/EMR connectors, how to install them, and how to use them.
9+
## Overview
10+
WSO2’s solution offers out-of-the-box connectors for Health Care vendors such as EPIC, Cerner, and Athena Health EMRs and is capable of generating connectors automatically to any FHIR-based or Open API specification-based EHR/EMR system.<br /> These connectors will increase the developer's productivity by providing an abstraction to the EHR/EMR system endpoints, but are not a must for WSO2 to integrate with an EHR/EMR.<br /><br /> This section will provide instruction on how to obtain the EHR/EMR connectors, how to install them, and how to use them.
1111

12-
##Set up the required connectors
12+
## Set up the required connectors
1313
Follow the instructions given below to set up the connectors you require in your WSO2 Integration Studio.
1414
<ul>
1515
<li> You can request a connector for any FHIR compliant EHR/EMR system, or a system that has an Open API specification.</li>
@@ -18,10 +18,10 @@ Follow the instructions given below to set up the connectors you require in your
1818
<li> The connector zip file will be provided after it is generated by the tool.</li>
1919
</ul>
2020

21-
##Install the connector
21+
## Install the connector
2222
As mentioned in the previous section, WSO2 Integration Studio is the IDE that will be used to develop integrations that will be deployed in the integration layer of the Healthcare solution. The connector zip that is obtained from WSO2 should be imported to the Integration Studio in order to develop the integration flow.<br /> Steps on installing and using the connector can be found by clicking the [link](https://apim.docs.wso2.com/en/4.0.0/reference/connectors/connectors-overview/#how-to-use-connectors)<br />
2323

24-
##Connect system to integration logic
24+
## Connect system to integration logic
2525
In this section let’s walk through a simple example of connecting to the Epic EHR system and searching and retrieving some patient data. Epic is a FHIR compliant EHR system. WSO2 has a pre-built connector for the Epic sandbox environment. Let’s create a new Integration project and add a Rest API to it. More information on creating the integration project,and the Rest API can be found [here](https://apim.docs.wso2.com/en/4.0.0/integrate/develop/integration-development-kickstart/).<br />Then let's import the Epic connector to the Integration Studio as mentioned in the previous section. Once imported the mediator <strong>Palette</strong> of the Integration Studio will have the Epic connector listed. As shown in the below image:
2626

2727
![Epic connector in the palette](/assets/img/guildes/configuring-ehr-emr-system/epic-in-palatte.png)
@@ -30,7 +30,7 @@ The required connector operations have to be dragged and dropped to the canvas.
3030

3131
![Integration canvas with Epic connector operations](/assets/img/guildes/configuring-ehr-emr-system/canvas.png)
3232

33-
The above image describes the user of the init and the searchPatient connector operations. When an operation is clicked the following property pane will be visible with all the parameters that the operation would accept.
33+
The above image describes the use of the init and the searchPatient connector operations. When an operation is clicked the following property pane will be visible with all the parameters that the operation would accept.
3434

3535
![Init operation property pane](/assets/img/guildes/configuring-ehr-emr-system/property.png)
3636

en/docs/fhir/guides/expose-fhir-apis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Please note that there are areas that WSO2 Open Healthcare does not support at t
5555

5656
Once the required FHIR resources have been exposed as FHIR APIs, the server is ready to go as a standard FHIR server. That is, all the subordinate components are getting updated and deployed accordingly.
5757

58-
To learn more about RESTful FHIR, refer the [official FHIR documentation](https://www.hl7.org/fhir/http.html).
58+
To learn more about RESTful FHIR, refer to the [official FHIR documentation](https://www.hl7.org/fhir/http.html).
5959

6060
- Interactions
61-
- Instance level - All the instance level interactions are pre templeted in the API definitions of the WSO2 FHIR API Hub. Relevant backend integration logic has to be implemented by the developer. (A project skeleton with boilerplate code will be provided to speed up the deployment.)
61+
- Instance level - All the instance level interactions are pre-templated in the API definitions of the WSO2 FHIR API Hub. Relevant backend integration logic has to be implemented by the developer. (A project skeleton with boilerplate code will be provided to speed up the deployment.)
6262
- Type level - Type level interactions are also handled in a similar manner as in Instance level interactions.
6363
- System level - Only Capabilities interaction is available as a default feature.
6464
- Capability statement
@@ -80,7 +80,7 @@ To learn more about RESTful FHIR, refer the [official FHIR documentation](https:
8080
| **Feature** | **Supported? (yes/no/partially)** | **Description** |
8181
| --- | --- | --- |
8282
| read | yes | Supports query parameters as well |
83-
| vread | yes | Appropriate Integration logic has to be implemented by the Integration developer. (Since versioning strategy might different from one system to a another) |
83+
| vread | yes | Appropriate Integration logic has to be implemented by the Integration developer. (Since versioning strategy might differ from one system to another) |
8484
| update | yes | Appropriate Integration logic has to be implemented by the Integration developer. |
8585
| patch | yes | Appropriate Integration logic has to be implemented by the Integration developer. |
8686
| delete | yes | |

en/docs/fhir/guides/exposing-an-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ With WSO2 Open Healthcare you can easily,
1717
- Readily available across different Implementation guides.
1818
- Rapid development tools to support any Implementation.
1919
- Expose existing FHIR APIs in a dedicated API marketplace (Developer Portal).
20-
- Build a custom integration flows to transform legacy data formats into FHIR resources, and expose them as FHIR APIs.
20+
- Build custom integration flows to transform legacy data formats into FHIR resources, and expose them as FHIR APIs.
2121
- Allow third-party developers to consume FHIR APIs through the Developer Portal.
2222
- Using APIM as the API management layer to manage the FHIR API and to expose it to consumers.
2323

en/docs/fhir/guides/fhir-repository-connector.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ fhir:FHIRResponse|fhir:FHIRError byId = fhirConnector->update({"resourceType": "
128128
129129
:::
130130
:::note Patch FHIR resource
131-
This method will allow the user to create a new current version for an existing resource by updating part of the resource.For we only support [FHIRPath Patch](https://hl7.org/FHIR/fhirpatch.html), the remaining content types will be supported in the future releases.
131+
This method will allow the user to create a new current version for an existing resource by updating part of the resource. Currently only [FHIRPath Patch](https://hl7.org/FHIR/fhirpatch.html) is supported; the remaining content types will be supported in future releases.
132132
133133
| Method name | getByVersion |
134134
|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -172,7 +172,7 @@ This method will allow the user to retrieve the change history for a particular
172172
| | *Parameters* - history search parameters (i.e count, since, at) |
173173
| | *returnMimeType* - The [Mime Type](https://www.hl7.org/fhir/http.html#mime-type:~:text=Content%20Types%20and%20encodings) of the return response |
174174
| | uriParameters - additional [params](https://www.hl7.org/fhir/http.html#history:~:text=_format%20parameter%2C%20the-,parameters,-to%20this%20interaction) as a name value map |
175-
| Returns | Requesed histories \| operationOutcomee |
175+
| Returns | Requested histories \| operationOutcome |
176176
| Server endpoint | [History](https://www.hl7.org/fhir/http.html#history) operation |
177177
178178
**sample usage**
@@ -184,7 +184,7 @@ fhir:FHIRResponse|fhir:FHIRError byId = fhirConnector->getInstanceHistory("Patie
184184
### Type Level Interactions
185185
186186
:::note Create FHIR resource
187-
This method will allow the user to create a new for a specified type. Here the user doesn't have control over the resource ID, it will be assigned by the server.
187+
This method will allow the user to create a new resource for a specified type. Here the user doesn't have control over the resource ID, it will be assigned by the server.
188188
189189
| Method name | create |
190190
|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -230,7 +230,7 @@ This method will allow the user to retrieve the change history for a particular
230230
| Parameters | *type* - The name of a resource type (e.g. "Patient")
231231
| | *Parameters* - history search parameters (i.e count, since, at) |
232232
| | *returnMimeType* - The [Mime Type](https://www.hl7.org/fhir/http.html#mime-type:~:text=Content%20Types%20and%20encodings) of the return response |
233-
| Returns | Requesed histories \| operationOutcome |
233+
| Returns | Requested histories \| operationOutcome |
234234
| Server endpoint | [History](https://www.hl7.org/fhir/http.html#history) operation |
235235
236236
**sample usage**
@@ -265,7 +265,7 @@ This method will allow the user to retrieve the change history for all resources
265265
|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|
266266
| Parameters | *Parameters* - history search parameters (i.e count, since, at) |
267267
| | *returnMimeType* - The [Mime Type](https://www.hl7.org/fhir/http.html#mime-type:~:text=Content%20Types%20and%20encodings) of the return response |
268-
| Returns | Requesed histories \| operationOutcome |
268+
| Returns | Requested histories \| operationOutcome |
269269
| Server endpoint | [History](https://www.hl7.org/fhir/http.html#history) operation |
270270
271271
**sample usage**

en/docs/fhir/guides/metadata-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,14 @@ Following configurations need to be added in a `Config.toml` or in the Choreo co
9494
| `patchFormat` | Patch formats supported <br/><br/> eg: `[application/json-patch+json]` |
9595
| `implementationUrl` | Base URL for the installation <br/><br/> eg: `https://choreoapis/dev/fhir_server/0.1.5` |
9696
| `implementationDescription` | Describes this specific instance <br/><br/> eg: `WSO2 Open Healthcare FHIR` |
97-
| `interaction` | The that operations are supported <br/><br/> eg: `[search-system, history-system]` |
97+
| `interaction` | The operations that are supported <br/><br/> eg: `[search-system, history-system]` |
9898
| `cors` | CORS Headers availability <br/><br/> eg: `true` |
9999
| `discoveryEndpoint` | The discovery endpoint for the server <br/><br/> eg: `https://api.asgardeo.io/t/<organization_name>/oauth2/token/.well-known/openid-configuration` |
100100
| `tokenEndpoint` | OPTIONAL: If not provided a discoveryEndpoint. <br/>OAUTH2 access token url <br/><br/> eg: `https://api.asgardeo.io/t/<organization_name>/oauth2/token` |
101101
| `revocationEndpoint` | OPTIONAL: If not provided a discoveryEndpoint. <br/>OAUTH2 access revoke url <br/><br/> eg: `https://api.asgardeo.io/t/<organization_name>/oauth2/revoke` |
102102
| `authorizeEndpoint` | OPTIONAL: If not provided a discoveryEndpoint. <br/>OAUTH2 access authorize url <br/><br/> eg: `https://api.asgardeo.io/t/<organization_name>/oauth2/authorize` |
103103
104-
A sample `Config.toml` is consisting above configurations as below.
104+
A sample `Config.toml` containing the above configurations is shown below.
105105
106106
```
107107
## server related configurables
@@ -222,7 +222,7 @@ This creates the organization and opens the Project Home page of the default pro
222222
223223
Follow the official documentation to deploy the smart configuration prebuilt service to your organization https://wso2.com/choreo/docs/develop-components/develop-services/develop-a-ballerina-rest-api/#step-2-build-and-deploy.
224224
225-
On deployment configurables mentioned in [Configurations](#configurations) needs to be configured in Choreo configurable editor.
225+
On deployment, configurables mentioned in [Configurations](#configurations) need to be configured in the Choreo configurable editor.
226226
227227
## Configurations
228228
@@ -246,7 +246,7 @@ Following configurations need to be added in a `Config.toml` or in the Choreo co
246246
| `capabilities` | REQUIRED, Array of strings representing SMART capabilities (e.g., sso-openid-connect or launch-standalone) that the server supports. <br/><br/> eg: `[launch-ehr, permission-patient, permission-v2, client-public, client-confidential-symmetric, context-ehr-patient, sso-openid-connect, launch-standalone, context-standalone-patient, permission-offline]` |
247247
| `codeChallengeMethodsSupported` | REQUIRED, Array of PKCE code challenge methods supported. The S256 method SHALL be included in this list, and the plain method SHALL NOT be included in this list. <br/><br/> eg: `[S256]`
248248
249-
A sample `Config.toml` is consisting above configurations as below.
249+
A sample `Config.toml` containing the above configurations is shown below.
250250
251251
```json
252252
[configs]

en/docs/fhir/guides/parsing-and-serializing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Before you begin, ensure you have <a href="https://ballerina.io/downloads/instal
2626
```bash
2727
$ bal new fhir_parsing_sample
2828
```
29-
2. Import the required modules to the Ballerina program. In this sample we are using FHIR Patient resource from international base FHIR IG . Therefore, we need to import `ballerinax/health.fhir.r4.internationa401` package. If you are using a different IG of FHIR, you can import the relevant package from the [central](https://central.ballerina.io/search?q=fhir&page=1&m=packages) or generated from the bal [health tool](https://ballerina.io/learn/health-tool/#package-generation).
29+
2. Import the required modules to the Ballerina program. In this sample we are using FHIR Patient resource from international base FHIR IG. Therefore, we need to import `ballerinax/health.fhir.r4.international401` package. If you are using a different IG of FHIR, you can import the relevant package from the [central](https://central.ballerina.io/search?q=fhir&page=1&m=packages) or generated from the bal [health tool](https://ballerina.io/learn/health-tool/#package-generation).
3030

3131
```ballerina
3232
import ballerina/io;

0 commit comments

Comments
 (0)