Add smart on fhir and on prem accelerator deployment guides

en/docs/install-and-setup/configure-km.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 5
+title: "Configure IS 7.x as Key Manager"
+description: This guide provides step-by-step instructions to configure WSO2 Identity Server 7.x as a Key Manager for WSO2 API Manager, enabling secure API access and management.
+---
+
+This guide provides step-by-step instructions to configure WSO2 Identity Server 7.x as a Key Manager for WSO2 API Manager, enabling secure API access and management.
+
+1. Sign in to the Admin Portal of API Manager at https://localhost:9443/admin.
+2. Go to **Key Managers** on the left main menu.
+![add-key-manager.png](../assets/img/get-started/add-key-manager.png)
+3. Configure [WSO2 IS 7.x as a keymanager](https://apim.docs.wso2.com/en/latest/api-security/key-management/third-party-key-managers/configure-wso2is7-connector/). Enable role creation in WSO2 Identity Server 7.
+:::tip
+You can configure well-known URL (`https://<WSO2_APIM_BASE>:9453/oauth2/token/.well-known/openid-configuration`) and import Key manager endpoints.
+:::
+
+
+:::note
+Use the introspection endpoint in the iam-service-extension service to enable healthcare specific introspection response. `https://<IAM_SERVICE_EXTENSION_BASE>:<PORT>/introspect`.
+:::
+4. Go to the list of Key Managers and select **Resident Key Manager**.
+5. Disable the Resident Key Manager.

en/docs/install-and-setup/deploy-fhir-apis.md

@@ -0,0 +1,107 @@
+---
+sidebar_position: 6
+title: "Deploy FHIR APIs"
+description: This guide provides step-by-step instructions to deploy FHIR APIs in WSO2 API Manager, enabling healthcare organizations to securely expose and manage their FHIR-based services.
+---
+
+# Deploy FHIR APIs
+
+This guide walks through the steps to generate an OpenAPI specification from a FHIR Implementation Guide using the Ballerina Health Tool, and then deploy it as a managed API in WSO2 API Manager using the FHIR Repository as the backend.
+
+## Prerequisites
+
+1. Install and setup [WSO2 Open Healthcare](./manual.md).
+2. Install [Ballerina](./manual.md#ballerina-installation-steps) (Swan Lake or later).
+3. A FHIR Implementation Guide (IG) to generate the API.
+
+## Step 1 - Generate OpenAPI Specification from a FHIR Implementation Guide
+
+The [Ballerina Health Tool](https://ballerina.io/learn/health-tool/#fhir-template-generation) can generate an OpenAPI specification and a Ballerina project template directly from a FHIR Implementation Guide.
+
+1. Pull the Ballerina Health Tool:
+
+    ```bash
+    bal tool pull health
+    ```
+
+2. Run the FHIR template generation command, pointing to your Implementation Guide package:
+
+    ```bash
+    bal health gen fhir -m template --org-name [ORG_NAME] [IG_PACKAGE_NAME]
+    ```
+
+    Replace the placeholders with:
+    - `[ORG_NAME]`: Your Ballerina organization name (e.g., `healthcare`)
+    - `[IG_PACKAGE_NAME]`: The Ballerina package name of the FHIR IG (e.g., `ballerinax/health.fhir.r4.uscore501`)
+
+    Example:
+
+    ```bash
+    bal health gen fhir -m template --org-name healthcare ballerinax/health.fhir.r4.uscore501
+    ```
+
+3. The tool generates a Ballerina project with:
+    - An OpenAPI specification (OAS) file for each FHIR resource in the IG.
+    - A Ballerina service template with boilerplate FHIR resource handlers.
+
+4. Locate the generated OAS file(s) in the output directory. These will be used to create the API in WSO2 API Manager.
+
+:::tip
+For standard FHIR R4 APIs without a custom IG, you can skip this step and directly download a pre-built OAS file from the [FHIR API Definitions](./fhir-artifacts) page.
+:::
+
+## Step 2 - Create and Deploy the API in WSO2 API Manager
+
+1. Log in to the WSO2 APIM Publisher Portal at `https://localhost:9443/publisher`.
+
+    ![WSO2 Publisher Portal](../assets/img/guildes/exposing-an-api/oh-publisher-portal.png)
+
+2. Click **Create API** and select **Import Open API**.
+
+3. Upload the OAS file generated in Step 1 and click **Next**.
+
+4. Fill in the API details:
+    - **Name**: e.g., `USCorePatientAPI`
+    - **Context**: e.g., `/fhir/r4`
+    - **Version**: e.g., `1.0.0`
+    - **Endpoint URL**: The URL of the running Ballerina FHIR service (e.g., `http://localhost:9090/r4`)
+
+5. Click **Create** to create the API.
+
+6. In the API overview, go to **Deployments** and click **Deploy**:
+    - Select the target **Gateway** (e.g., Default).
+    - Click **Deploy**.
+
+7. Go to **Lifecycle** and click **Publish** to make the API available in the Developer Portal.
+
+:::note
+Ensure the WSO2 APIM gateway can reach the Ballerina FHIR service endpoint. If running locally, use `host.docker.internal` instead of `localhost` when APIM runs in Docker.
+:::
+
+## Step 3 - Verify the Deployment
+
+1. Navigate to the Developer Portal at `https://localhost:9443/devportal`.
+
+    ![WSO2 Developer Portal](../assets/img/guildes/exposing-an-api/oh-developer-portal.png)
+
+2. Find the published FHIR API and confirm it appears in the portal.
+3. Invoke the well-known endpoint to verify the FHIR gateway is responding:
+
+    ```bash
+    curl https://localhost:8243/r4/.well-known/smart-configuration
+    ```
+
+4. Test a FHIR resource endpoint:
+
+    ```bash
+    curl https://localhost:8243/r4/metadata
+    ```
+
+    A valid FHIR CapabilityStatement response confirms the API is deployed and the FHIR backend is reachable.
+
+## See Also
+
+- [Manual Installation Guide](./manual.md)
+- [Expose FHIR APIs](../fhir/guides/expose-fhir-apis.md)
+- [SMART on FHIR — Deploy On Premise](../secure-health-apis/guides/configure-smart-on-fhir.md)
+- [Ballerina Health Tool](https://ballerina.io/learn/health-tool/#fhir-template-generation)

en/docs/install-and-setup/fhir-artifacts.md

@@ -0,0 +1,169 @@
+---
+sidebar_position: 7
+title: "Download FHIR API Definitions"
+description: Download OpenAPI Specification (OAS) files for FHIR R4 APIs to use with WSO2 API Manager. APIs are organized by clinical category.
+---
+
+# Download FHIR API Definitions
+
+This page provides OpenAPI Specification (OAS/YAML) files for FHIR R4 APIs. These definitions can be imported directly into WSO2 API Manager to create and publish managed FHIR APIs.
+
+:::note
+These OAS files are based on the **FHIR R4** specification. To generate OAS files for a specific Implementation Guide (e.g., US Core, AU Base), use the [Ballerina Health Tool](./deploy-fhir-apis.md#step-1---generate-openapi-specification-from-a-fhir-implementation-guide).
+:::
+
+## Patient and Demographics
+
+| API | Download |
+|-----|----------|
+| Patient API | [Download](../../assets/specs/oas/PatientAPI.yaml) |
+| Person API | [Download](../../assets/specs/oas/PersonAPI.yaml) |
+| Related Person API | [Download](../../assets/specs/oas/RelatedPersonAPI.yaml) |
+| Practitioner API | [Download](../../assets/specs/oas/PractitionerAPI.yaml) |
+| Practitioner Role API | [Download](../../assets/specs/oas/PractitionerRoleAPI.yaml) |
+| Organization API | [Download](../../assets/specs/oas/OrganizationAPI.yaml) |
+| Organization Affiliation API | [Download](../../assets/specs/oas/OrganizationAffiliationAPI.yaml) |
+| Healthcare Service API | [Download](../../assets/specs/oas/HealthcareServiceAPI.yaml) |
+| Location API | [Download](../../assets/specs/oas/LocationAPI.yaml) |
+
+## Clinical
+
+| API | Download |
+|-----|----------|
+| Condition API | [Download](../../assets/specs/oas/ConditionAPI.yaml) |
+| Observation API | [Download](../../assets/specs/oas/ObservationAPI.yaml) |
+| Observation Definition API | [Download](../../assets/specs/oas/ObservationDefinitionAPI.yaml) |
+| Diagnostic Report API | [Download](../../assets/specs/oas/DiagnosticReportAPI.yaml) |
+| Procedure API | [Download](../../assets/specs/oas/ProcedureAPI.yaml) |
+| Encounter API | [Download](../../assets/specs/oas/EncounterAPI.yaml) |
+| Episode of Care API | [Download](../../assets/specs/oas/EpisodeOfCareAPI.yaml) |
+| Allergy Intolerance API | [Download](../../assets/specs/oas/AllergyIntoleranceAPI.yaml) |
+| Adverse Event API | [Download](../../assets/specs/oas/AdverseEventAPI.yaml) |
+| Detected Issue API | [Download](../../assets/specs/oas/DetectedIssueAPI.yaml) |
+| Clinical Impression API | [Download](../../assets/specs/oas/ClinicalImpressionAPI.yaml) |
+| Family Member History API | [Download](../../assets/specs/oas/FamilyMemberHistoryAPI.yaml) |
+| Risk Assessment API | [Download](../../assets/specs/oas/RiskAssessmentAPI.yaml) |
+| Imaging Study API | [Download](../../assets/specs/oas/ImagingStudyAPI.yaml) |
+| Body Structure API | [Download](../../assets/specs/oas/BodyStructureAPI.yaml) |
+| Specimen API | [Download](../../assets/specs/oas/SpecimenAPI.yaml) |
+| Specimen Definition API | [Download](../../assets/specs/oas/SpecimenDefinitionAPI.yaml) |
+| Molecular Sequence API | [Download](../../assets/specs/oas/MolecularSequenceAPI.yaml) |
+
+## Medications
+
+| API | Download |
+|-----|----------|
+| Medication API | [Download](../../assets/specs/oas/MedicationAPI.yaml) |
+| Medication Request API | [Download](../../assets/specs/oas/MedicationRequestAPI.yaml) |
+| Medication Administration API | [Download](../../assets/specs/oas/MedicationAdministrationAPI.yaml) |
+| Medication Dispense API | [Download](../../assets/specs/oas/MedicationDispenseAPI.yaml) |
+| Medication Statement API | [Download](../../assets/specs/oas/MedicationStatementAPI.yaml) |
+| Medication Knowledge API | [Download](../../assets/specs/oas/MedicationKnowledgeAPI.yaml) |
+| Immunization API | [Download](../../assets/specs/oas/ImmunizationAPI.yaml) |
+| Immunization Evaluation API | [Download](../../assets/specs/oas/ImmunizationEvaluationAPI.yaml) |
+| Immunization Recommendation API | [Download](../../assets/specs/oas/ImmunizationRecommendationAPI.yaml) |
+| Nutrition Order API | [Download](../../assets/specs/oas/NutritionOrderAPI.yaml) |
+
+## Care Management
+
+| API | Download |
+|-----|----------|
+| Care Plan API | [Download](../../assets/specs/oas/CarePlanAPI.yaml) |
+| Care Team API | [Download](../../assets/specs/oas/CareTeamAPI.yaml) |
+| Goal API | [Download](../../assets/specs/oas/GoalAPI.yaml) |
+| Service Request API | [Download](../../assets/specs/oas/ServiceRequestAPI.yaml) |
+| Appointment API | [Download](../../assets/specs/oas/AppointmentAPI.yaml) |
+| Appointment Response API | [Download](../../assets/specs/oas/AppointmentResponseAPI.yaml) |
+| Schedule API | [Download](../../assets/specs/oas/ScheduleAPI.yaml) |
+| Slot API | [Download](../../assets/specs/oas/SlotAPI.yaml) |
+| Flag API | [Download](../../assets/specs/oas/FlagAPI.yaml) |
+| Consent API | [Download](../../assets/specs/oas/ConsentAPI.yaml) |
+| Communication API | [Download](../../assets/specs/oas/CommunicationAPI.yaml) |
+| Communication Request API | [Download](../../assets/specs/oas/CommunicationRequestAPI.yaml) |
+| Request Group API | [Download](../../assets/specs/oas/RequestGroupAPI.yaml) |
+| Task API | [Download](../../assets/specs/oas/TaskAPI.yaml) |
+
+## Devices
+
+| API | Download |
+|-----|----------|
+| Device API | [Download](../../assets/specs/oas/DeviceAPI.yaml) |
+| Device Definition API | [Download](../../assets/specs/oas/DeviceDefinitionAPI.yaml) |
+| Device Metric API | [Download](../../assets/specs/oas/DeviceMetricAPI.yaml) |
+| Device Request API | [Download](../../assets/specs/oas/DeviceRequestAPI.yaml) |
+| Device Use Statement API | [Download](../../assets/specs/oas/DeviceUseStatementAPI.yaml) |
+| Biologically Derived Product API | [Download](../../assets/specs/oas/BiologicallyDerivedProductAPI.yaml) |
+| Supply Delivery API | [Download](../../assets/specs/oas/SupplyDeliveryAPI.yaml) |
+| Supply Request API | [Download](../../assets/specs/oas/SupplyRequestAPI.yaml) |
+
+## Financial
+
+| API | Download |
+|-----|----------|
+| Claim API | [Download](../../assets/specs/oas/ClaimAPI.yaml) |
+| Claim Response API | [Download](../../assets/specs/oas/ClaimResponseAPI.yaml) |
+| Coverage API | [Download](../../assets/specs/oas/CoverageAPI.yaml) |
+| Coverage Eligibility Request API | [Download](../../assets/specs/oas/CoverageEligibilityRequestAPI.yaml) |
+| Coverage Eligibility Response API | [Download](../../assets/specs/oas/CoverageEligibilityResponseAPI.yaml) |
+| Explanation of Benefit API | [Download](../../assets/specs/oas/ExplanationOfBenefitAPI.yaml) |
+| Insurance Plan API | [Download](../../assets/specs/oas/InsurancePlanAPI.yaml) |
+| Invoice API | [Download](../../assets/specs/oas/InvoiceAPI.yaml) |
+| Payment Notice API | [Download](../../assets/specs/oas/PaymentNoticeAPI.yaml) |
+| Payment Reconciliation API | [Download](../../assets/specs/oas/PaymentReconciliationAPI.yaml) |
+| Charge Item API | [Download](../../assets/specs/oas/ChargeItemAPI.yaml) |
+| Charge Item Definition API | [Download](../../assets/specs/oas/ChargeItemDefinitionAPI.yaml) |
+| Account API | [Download](../../assets/specs/oas/AccountAPI.yaml) |
+| Contract API | [Download](../../assets/specs/oas/ContractAPI.yaml) |
+| Enrollment Request API | [Download](../../assets/specs/oas/EnrollmentRequestAPI.yaml) |
+| Enrollment Response API | [Download](../../assets/specs/oas/EnrollmentResponseAPI.yaml) |
+
+## Terminology and Definitions
+
+| API | Download |
+|-----|----------|
+| Code System API | [Download](../../assets/specs/oas/CodeSystemAPI.yaml) |
+| Value Set API | [Download](../../assets/specs/oas/ValueSetAPI.yaml) |
+| Concept Map API | [Download](../../assets/specs/oas/ConceptMapAPI.yaml) |
+| Naming System API | [Download](../../assets/specs/oas/NamingSystemAPI.yaml) |
+| Terminology Capabilities API | [Download](../../assets/specs/oas/TerminologyCapabilitiesAPI.yaml) |
+| Structure Definition API | [Download](../../assets/specs/oas/StructureDefinitionAPI.yaml) |
+| Structure Map API | [Download](../../assets/specs/oas/StructureMapAPI.yaml) |
+| Implementation Guide API | [Download](../../assets/specs/oas/ImplementationGuideAPI.yaml) |
+| Graph Definition API | [Download](../../assets/specs/oas/GraphDefinitionAPI.yaml) |
+| Compartment Definition API | [Download](../../assets/specs/oas/CompartmentDefinitionAPI.yaml) |
+| Operation Definition API | [Download](../../assets/specs/oas/OperationDefinitionAPI.yaml) |
+| Search Parameter API | [Download](../../assets/specs/oas/SearchParameterAPI.yaml) |
+| Message Definition API | [Download](../../assets/specs/oas/MessageDefinitionAPI.yaml) |
+| Event Definition API | [Download](../../assets/specs/oas/EventDefinitionAPI.yaml) |
+| Plan Definition API | [Download](../../assets/specs/oas/PlanDefinitionAPI.yaml) |
+| Library API | [Download](../../assets/specs/oas/LibraryAPI.yaml) |
+| Measure API | [Download](../../assets/specs/oas/MeasureAPI.yaml) |
+| Measure Report API | [Download](../../assets/specs/oas/MeasureReportAPI.yaml) |
+| Questionnaire API | [Download](../../assets/specs/oas/QuestionnaireAPI.yaml) |
+| Questionnaire Response API | [Download](../../assets/specs/oas/QuestionnaireResponseAPI.yaml) |
+
+## Infrastructure
+
+| API | Download |
+|-----|----------|
+| Bundle API | [Download](../../assets/specs/oas/BundleAPI.yaml) |
+| Capability Statement API | [Download](../../assets/specs/oas/CapabilityStatementAPI.yaml) |
+| Message Header API | [Download](../../assets/specs/oas/MessageHeaderAPI.yaml) |
+| Document Manifest API | [Download](../../assets/specs/oas/DocumentManifestAPI.yaml) |
+| Document Reference API | [Download](../../assets/specs/oas/DocumentReferenceAPI.yaml) |
+| Composition API | [Download](../../assets/specs/oas/CompositionAPI.yaml) |
+| Audit Event API | [Download](../../assets/specs/oas/AuditEventAPI.yaml) |
+| Provenance API | [Download](../../assets/specs/oas/ProvenanceAPI.yaml) |
+| Subscription API | [Download](../../assets/specs/oas/SubscriptionAPI.yaml) |
+| Endpoint API | [Download](../../assets/specs/oas/EndpointAPI.yaml) |
+| Binary API | [Download](../../assets/specs/oas/BinaryAPI.yaml) |
+| Basic API | [Download](../../assets/specs/oas/BasicAPI.yaml) |
+| Linkage API | [Download](../../assets/specs/oas/LinkageAPI.yaml) |
+| Group API | [Download](../../assets/specs/oas/GroupAPI.yaml) |
+| List API | [Download](../../assets/specs/oas/ListAPI.yaml) |
+| Operation Outcome API | [Download](../../assets/specs/oas/OperationOutcomeAPI.yaml) |
+
+## See Also
+
+- [Deploy FHIR APIs](./deploy-fhir-apis.md)
+- [Expose FHIR APIs](../fhir/guides/expose-fhir-apis.md)