# mulesoft Healthcare - Full Documentation
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# Accelerator Setup Guide
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
## Salesforce Health Cloud - Enabling Person Accounts
There are different ways to represent patients in Health Cloud. This template requires that the
patients in Health Cloud are represented as _Person Accounts_.
Following are the general steps to achieve this. Please consult with your Salesforce representative
for additional information.
- Ask your Salesforce representative to make Person Accounts available in your organization.
- From Setup, enter Custom Settings in the Quick Find box, then select Custom Settings.
- In the list of custom settings, click Manage next to the Use Person Accounts custom settings.
- Click **Edit** next to Use Person Account.
- Select Enable. After person accounts are enabled, assign them to profiles. Please refer to the
attached
[document](https://help.salesforce.com/s/articleView?language=en_US&id=sf.admin_person_account_overview.htm)
for the detailed explanation of representing patients in Health Cloud.
## Salesforce Connected App
This accelerator uses MuleSoft’s Salesforce Composite Connector to perform atomic upserts to
multiple Salesforce objects in a single transaction. It requires a 'Connected App' in Salesforce.
Please refer to the instructions in Salesforce docs to create a Connected App.
Please refer to the
[instructions](https://help.salesforce.com/s/articleView?language=en_US&id=connected_app_create.htm&type=5)
in Salesforce docs to create a connected app.
## Enable Read/Write Permissions for Salesforce Objects
Spring 2021 or later versions of Health Cloud Data Model Contact Object’s few fields need read/write
permissions enabled. The process to enable the access is:
- Login to org -→ Setup -→ Profiles -→ System Admin -→ Object settings
- Choose the object to be edited for enabling field’s read/write access
- Identify the field to be edited and check the boxes for Read and Write access
Example:
Login > Setup > Profiles > Object Setting > Contact > Edit > Check the Edit and Read Access
## HL7 Connector - Configuration for Custom Segments
This accelerator uses MuleSoft’s HL7 Connector. If you’re required to use custom segments for a
specific message structure, please follow the following instructions.
- HL7 schema definitions are distributed inside the hl7-schemas-4.1.1.jar file, embedded inside the
HL7 Connector package. Copy the following files to a folder inside src/main/resources location.
- Message structure schema file - for example, ADT\_A31.esl
- Base definitions file - basedefs.esl
- Event message map file - event-message.yaml
- Modify the message structure schema file (for example, ADT\_A31.esl) to include your custom
segment (or modify an existing segment to fit your needs).
- Modify the basedefs.esl file to include the changes for segment definitions.
The
[implementation template](https://anypoint.mulesoft.com/exchange/org.mule.examples/hc-accelerator-sfdc-adt-api/)
for storing ADT messages in Salesforce Health Cloud shows an example of custom segment processing.
Please check the src/main/resources/config/hl7/v2\_2 folder in the implementation template. This
folder has the necessary changes required to process custom segment `ZG1`.
For additional details on HL7 Connector, please refer to the
[documentation](https://docs.mulesoft.com/hl7-connector/latest/).
## Maven POM Parent
In addition to some global settings and repository references, the Maven
[POM parent](https://anypoint.mulesoft.com/exchange/org.mule.examples/accelerator-pom-parent-src/)
config also defines the versions of all MuleSoft connectors and modules used by applications. Refer
to the
[Exchange documentation](https://anypoint.mulesoft.com/exchange/org.mule.examples/accelerator-pom-parent-src/)
for information on how to make changes to the POM parent file.
## See Also
- [Prerequisites](https://docs.mulesoft.com/healthcare/latest/prerequisites)
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# C-CDA to FHIR Converter
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The
[C-CDA to FHIR converter](https://anypoint.mulesoft.com/exchange/org.mule.examples/hls-ccda-to-fhir-sys-api/)
comes with a ready to use template for
[CDA](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=496) to FHIR conversion.
This template can be extended or modified to meet specific conversion requirements.
## Functional diagram

## Advantages
- Accelerates efforts to standardize on FHIR and enables more comprehensive view into patients
- Follows best practices prescribed by HL7 and removes manual work associated with conversion
- Solution can be extended to support additional CDA documents
- Highly performant with underlying DataWeave engine
## See Also
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# FHIR R4 Assets
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The following are a collection of assets to support MuleSoft customers who are developing Fast
Healthcare Interoperability Resources (FHIR) APIs using MuleSoft. Visit the
[official HL7 website](https://www.hl7.org/fhir/) for more information.
- [FHIR RAML auto-generator](https://anypoint.mulesoft.com/exchange/org.mule.examples/hls-fhirjson-to-raml-sys-api-spec/) -
Utility to generate RAML specifications for FHIR resources from the JSON schema provided by HL7.
- [FHIR R4 US Core Profile Assets](https://docs.mulesoft.com/healthcare/latest/fhir-r4-us-core-profiles) - A collection of API specifications,
data types, and libraries designed to meet FHIR USCDI Core Profile compliance standards.
- [FHIR R4 Resources List](https://docs.mulesoft.com/healthcare/latest/fhir-r4-resources) - A collection of API specifications, data types, and
libraries designed to align to the FHIR R4 base standard.
- [FHIR Error API Policy](https://anypoint.mulesoft.com/exchange/org.mule.examples/fhir-error-policy/) -
A custom policy that captures error responses and transforms them into an FHIR compliant
`OperationOutcome` format. This policy can also be used with other out-of-the-box API policies
provided in Anypoint Platform, such as OAuth or JWT.
- [Okta SMART on FHIR](https://anypoint.mulesoft.com/exchange/org.mule.examples/hc-accelerator-okta-smartfhir/) -
Guidance for setting up a reference "SMART on FHIR" implementation on Anypoint Platform using Okta
as the identity provider.
## See Also
- [Getting Started Guide](https://docs.mulesoft.com/accelerators-home/getting-started)
- [Prerequisites](https://docs.mulesoft.com/healthcare/latest/prerequisites)
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# FHIR R4 Resources
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The MuleSoft Accelerator for Healthcare provides a library of United States Core Data for
Interoperability (USCDI) and FHIR R4 resources to help healthcare developers adhere to
interoperability needs and jumpstart the development of healthcare digital transformation
initiatives.
You can also use the
[FHIR Error API Policy](https://anypoint.mulesoft.com/exchange/org.mule.examples/fhir-error-policy/)
to capture error responses and format them in an FHIR OperationOutcome-compliant format, since
Anypoint Platform’s out-of-the-box (OOTB) policies do not provide error messages in an
FHIR-compliant format. This policy can also be used with other OOTB API policies provided in
Anypoint Platform, such as OAuth or JWT.
For the list of US core profile assets, please refer to [this link](https://docs.mulesoft.com/healthcare/latest/fhir-r4-us-core-profiles).
## FHIR R4 Resource List
_API specifications, data types, and libraries built to meet compliance with FHIR R4 standards._
NOTE:
_\[N\] indicates Normative content. It is considered to be stable and has been 'locked' subjecting
it to FHIR Inter-version Compatibility Rules. For more details please see HL7 FHIR
\_https://www.hl7.org/fhir/versions.html#2.7.0\[\_Version Management Policy_\]
_\[u\] indicates the resource is still under development and review by appropriate workgroups._
_\# indicates the resource has a Trial-Use Note._
## FHIR Error API Policy
This FHIR Error API policy can be used to capture error responses and format them in an FHIR
OperationOutcome-compliant format. This policy can also be used with other out-of-the-box API
policies provided in Anypoint Platform, such as OAuth or JWT.
See the following page to learn more about the FHIR Error API Policy:
- [FHIR Error API Policy](https://anypoint.mulesoft.com/exchange/org.mule.examples/fhir-error-policy/)
## See Also
- [FHIR R4 US Core Profile Assets](https://docs.mulesoft.com/healthcare/latest/fhir-r4-us-core-profiles)
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# FHIR R4 US Core Profile
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The MuleSoft Accelerator for Healthcare provides a library of United States Core Data for
Interoperability (USCDI) and FHIR R4 resources to help healthcare developers adhere to
interoperability needs and jumpstart the development of healthcare digital transformation
initiatives.
You can also use the
[FHIR Error API Policy](https://anypoint.mulesoft.com/exchange/org.mule.examples/fhir-error-policy/)
to capture error responses and format them in an FHIR OperationOutcome-compliant format, since
Anypoint Platform’s out-of-the-box (OOTB) policies do not provide error messages in an
FHIR-compliant format. This policy can also be used with other OOTB API policies provided in
Anypoint Platform, such as OAuth or JWT.
For the list of all FHIR R4 assets, please refer to [this link](https://docs.mulesoft.com/healthcare/latest/fhir-r4-resources).
## USCDI Core Profile Asset list
_API specifications, data types, and libraries built to meet compliance with FHIR R4 USCDI Core
Profile standards._
_APIs marked with `*` have both FHIR R4 and US Core-specific Library and API specification
available._
## See Also
- [FHIR R4 Resources List](https://docs.mulesoft.com/healthcare/latest/fhir-r4-resources)
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# HL7 v2 to FHIR Converter
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The
[HL7 v2 to FHIR converter](https://anypoint.mulesoft.com/exchange/org.mule.examples/hc-accelerator-hl7v2-to-fhir-sys-api)
comes with a ready to use template for HL7 v2 to FHIR conversion, which is based on the guidance
provided by the [HL7 v2 to FHIR Implementation Guide](https://build.fhir.org/ig/HL7/v2-to-fhir).
This template can be extended or modified to meet specific conversion requirements.
## Functional diagram

## Advantages
- Removes manual work associated with HL7 v2 and FHIR conversion following
[HL7 identified mappings](https://build.fhir.org/ig/HL7/v2-to-fhir/message_maps.html)
- Supports the most commonly used HL7 v2 message formats
- HL7 connector is preconfigured for this use case to easily read HL7 v2 messages
- Solution can be extended to support any custom fields and segments
- Highly performant with underlying DataWeave engine
## See Also
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# MuleSoft Accelerator for Healthcare
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The MuleSoft Accelerator for Healthcare equips Payer, Provider, and Life Sciences organizations with
foundational assets to accelerate their digital transformation journey. With our pre-built APIs,
connectors, implementation templates, and reference architectures, IT teams can spend more time
innovating rather than building from scratch.
For solutions related to life sciences, the
[MuleSoft Accelerator for Life Sciences](https://docs.mulesoft.com/life-sciences/latest/) helps pharmaceuticals, medical
device companies, and contract research organizations (CROs) integrate digital operations and get
their products to market faster.
## Use Cases
The following describes the use cases supported by the MuleSoft Accelerator for Healthcare:
- [Patient 360](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/wtk-yon/Use%20case%201%20-%20Patient%20360/)
— Includes HL7 v2 and FHIR R4 options for surfacing patient demographics and clinical data from an
electronic health record (EHR) system into Salesforce Health Cloud. Assets can be used for a
variety of use cases and provide customers with a reference implementation to integrate with
common EHR systems, such as Epic and Cerner via API.
- [CMS Interoperability](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/66z-g8s/Use%20case%202%20-%20CMS%20Interoperability/)
— Includes assets to accelerate your API development efforts to meet
[CMS Interoperability and Patient Access final rule](https://www.cms.gov/priorities/burden-reduction/overview/interoperability).
- [Labs integration](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/84n-52t/Use%20case%203%20-%20Labs%20integration/)
— Includes an asset to accelerate the transmission of laboratory results that identify a
notifiable condition to public health agencies, such as California Department of Public Health.
- [Appointment scheduling](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/voe-5o5/Use%20case%204%20-%20Appointment%20scheduling/)
— Includes assets to enable scheduling, updating, and canceling appointments in EHR systems via
APIs from patient engagement platforms like Salesforce Health Cloud, mobile apps, and patient
portals.
- [Benefits and eligibility verification](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/hfn-ghq/Use%20case%205%20-%20Benefits%20and%20eligibility%20verification/)
— Includes assets to perform real-time benefits and eligibility verification to allow
organizations to electronically verify a patient’s insurance coverage for medical treatment
directly within Salesforce Health Cloud.
- [Prior Authorization](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/4bs-4tz/Use%20case%206%20-%20Prior%20Authorization/)
— Includes assets to accelerate the development of Coverage Requirement Discovery (CRD),
Documentation Templates and Rule (DTR), and Prior Authorization Support (PAS) APIs to enable
API-based prior authorizations between healthcare providers and payers to reduce administrative
burden and drive better patient outcomes.
- [Population health management](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/rco-2ps/Use%20case%207%20-%20Population%20health%20management/) -
Includes assets to convert and ingest valuable patient information into platforms like Amazon
HealthLake to power population health initiatives.
- [Qualified Health Information Networks Integration](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/57n-39f/Use%20case%208%20-%20Qualified%20health%20information%20networks%20integration/) -
Includes assets to streamline patient onboarding and remove the need for manual data entry by
integrating with external organizations via a QHIN query for clinical documentation.
- [Patient De-identification Solution](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/minor/2.24/pages/zfs-7wh/Use%20case%209%20-%20Patient%20de-identification%20solution/) -
Includes assets to de-identify Fast Healthcare Interoperability Resources (FHIR) patient datasets
to power innovative research and AI initiatives.
### Use Case Agnostic Assets
The following use-case agnostic assets are also available:
- [FHIR R4 assets](https://docs.mulesoft.com/healthcare/latest/fhir-r4-assets) — Start your journey using these FHIR-based APIs. Includes links
to additional use-case agnostic assets (resources, libraries, and APIs), as well as an API Policy
that you can use to format error messages in an FHIR-compliant format.
- [HL7 v2 to FHIR converter](https://docs.mulesoft.com/healthcare/latest/hl7-v2-fhir-converter) — The converter comes with a ready to use
template for HL7 v2 to FHIR conversion, which is based on the guidance provided by the HL7 v2 to
FHIR Implementation Guide. This template can be extended or modified to meet specific conversion
requirements.
- [X12 to FHIR converter](https://docs.mulesoft.com/healthcare/latest/x12-fhir-converter) — The converter comes with a ready to use template for
FHIR to X12 conversion. This template can be extended or modified to meet specific conversion
requirements.
- [C-CDA to FHIR converter](https://docs.mulesoft.com/healthcare/latest/ccda-fhir-converter) — The converter comes with a ready to use template
for CDA to FHIR conversion. This template can be extended or modified to meet specific conversion
requirements.
## See Also
- [Getting Started Guide](https://docs.mulesoft.com/accelerators-home/getting-started)
- [Prerequisites](https://docs.mulesoft.com/healthcare/latest/prerequisites)
- [Available Assets](https://docs.mulesoft.com/healthcare/latest/fhir-r4-assets)
- [Release Notes](https://docs.mulesoft.com/release-notes/accelerators/healthcare/healthcare-release-notes)
- [MuleSoft Accelerator for Healthcare on Exchange](https://www.anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-healthcare/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# Prerequisites for MuleSoft Accelerator for Healthcare
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
This page provides a summary of the guides available for configuring the various systems and
products required to implement the use cases provided by this solution. The individual systems
needed, and amount of configuration required, depend on which assets are to be deployed in your
target environment(s) - refer to the use case pages for more details.
## Available Guides
The [Salesforce Health Cloud Setup Guide](https://docs.mulesoft.com/healthcare/latest/sfdc-health-cloud-setup-guide) is available for this
accelerator.
Most of the implementation templates also contain details on requirements specific to those
applications.
## See Also
- For guidance on configuring your local build environment to download, modify, and deploy
accelerator assets, see
[Getting Started with MuleSoft Accelerators](https://docs.mulesoft.com/accelerators-home/getting-started).
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# SMART on FHIR with Okta
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
See the
[Okta SMART on FHIR - Implementation Template](https://anypoint.mulesoft.com/exchange/org.mule.examples/hc-accelerator-okta-smartfhir/)
asset, which walks you through how to set up a reference SMART on FHIR implementation on Anypoint
Platform using Okta as the identity provider.
The **S**ubstitutable **M**edical **A**pplications and **R**eusable **T**echnology (SMART) is a
web/mobile app, which is typically embedded in EHR but can also serve as a standalone smartphone
app. SMART on FHIR provides a consistent approach to security and data requirements for health
applications. It also provides a workflow to securely request access to data, receive the data, and
use the data.
SMART on FHIR addresses the following three key aspects:
- Identity and access management by using the OpenID Connect identity management protocol with
different categories of scopes
- Clinical data (example, `patient/Observation.read`)
- Contextual data (example, `launch/patient`)
- Identity data (example, `openid fhirUser`)
- Access to the data using FHIR based APIs
- Launch workflow for different use cases such as:
- Patient apps that launch standalone
- Patient apps that launch from an EHR portal
- Provider apps that launch standalone
- Provider apps that launch from an EHR portal
Anypoint platform supports SMART on FHIR in the following ways:
- Identity and access management
- Provisioning third-party
[OIDC client provider](https://docs.mulesoft.com/access-management/configure-client-management-openid-task)
like Okta for identity management
- Out-of-the-box
[OpenID Connect token enforcement policy](https://docs.mulesoft.com/gateway/latest/policies-included-openid-token-enforcement)
- Leverage OAuth provider information in the `authentication` object for custom policy
- Access to the data using FHIR based APIs
- MuleSoft Accelerator for Healthcare provides FHIR R4 specifications for all the FHIR resources
- Out-of-the-box
[cross origin resource sharing (CORS) policy](https://docs.mulesoft.com/gateway/latest/policies-included-cors)
enables cross origin data exchange.
## See Also
- [Prerequisites](https://docs.mulesoft.com/healthcare/latest/prerequisites)
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)
---
product: Healthcare
version: 2.24
is-latest-version: true
---
# X12 to FHIR Converter
> For the full documentation index, see: https://docs.mulesoft.com/llms.txt
The
[X12 to FHIR converter](https://anypoint.mulesoft.com/exchange/org.mule.examples/hls-fhir-to-x12-sys-api/)
comes with a ready to use template for [X12](https://x12.org/) to FHIR conversion. This template can
be extended or modified to meet specific conversion requirements. The converter converts FHIR R4 to
X12 formats and its responses from X12 to FHIR R4.
## Functional Diagram

## Advantages
- Removes manual work associated with X12 and FHIR conversion
- X12 connector is preconfigured for this use case to easily read & write X12 EDI events
- Supports multiple X12 message formats and use cases:
- 270 and 271 (Eligibility Verification Inquiry)
- 278, 278i, and 275 (Prior Authorization)
- 837 (Claims)
- Solution can be extended to support any custom fields and segments
- Highly performant with underlying DataWeave engine
## See Also
- [Prerequisites](https://docs.mulesoft.com/healthcare/latest/prerequisites)
- [MuleSoft Accelerator for Healthcare](https://docs.mulesoft.com/healthcare/latest/)