Azure API for FHIR

https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir
Admin
Azure API for FHIR is a managed, standards-based, compliant API for clinical health data, enabling...
Tokens:328,575
Snippets:1,588
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Azure API for FHIR Quickstart

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

A guide on how to get started with Azure API for FHIR, including creating a workspace and an FHIR account. This quickstart covers the initial setup process in the Azure portal.

```APIDOC
Azure API for FHIR Quickstart:
  - Create new resource
  - Search for Azure API for FHIR
  - Create Azure API for FHIR account
    - Enter account details
    - Additional settings (optional)
  - Fetch FHIR API capability statement
  - Clean up resources
  - Next steps
```

--------------------------------

### Getting Started with Azure API for FHIR using CLI

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

A quick start guide for deploying and configuring Azure API for FHIR using the Azure CLI. It provides example commands for resource creation.

```CLI
# Example Azure CLI command to create an Azure API for FHIR resource
# (This is a simplified example, actual deployment may require more parameters)
az provider register --namespace Microsoft.HealthcareApis
az healthcareapis create --name myfhirapi --resource-group myresourcegroup --location eastus --kind Fhir --skuName STU3
```

--------------------------------

### Get Started with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart

Provides quickstart guides for deploying and getting started with Azure API for FHIR using different tools and methods.

```APIDOC
Get Started with Azure API for FHIR:
  - Using Portal: Step-by-step guide to deploy via the Azure portal.
  - Using PowerShell: Scripting deployment with Azure PowerShell.
  - Using CLI: Command-line interface instructions for deployment.
  - Using ARM template: Deployment using Azure Resource Manager templates.
```

--------------------------------

### Getting Started with Azure API for FHIR using PowerShell

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

A quick start guide for deploying and configuring Azure API for FHIR using PowerShell. It outlines the necessary cmdlets and parameters for a basic setup.

```PowerShell
# Example PowerShell command to create an Azure API for FHIR resource
# (This is a simplified example, actual deployment may require more parameters)
New-AzApiForFhir -Name "myfhirapi" -ResourceGroupName "myresourcegroup" -Location "eastus" -SkuName "STU3"
```

--------------------------------

### Getting Started with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

Provides guides for getting started with Azure API for FHIR using various methods including the Azure portal, PowerShell, Azure CLI, and ARM templates.

```APIDOC
Get started with Azure API for FHIR:
  - Using Portal: Step-by-step guide for deployment and configuration via the Azure portal.
  - Using PowerShell: Scripting examples for deploying and managing the service.
  - Using CLI: Commands for interacting with Azure API for FHIR via the Azure CLI.
  - Using ARM template: Resource Manager templates for automated deployment.
```

```PowerShell
# Example PowerShell command (conceptual)
# New-AzHealthcareApisService -Name "myfhirservice" -ResourceGroupName "myresourcegroup" -Location "eastus" -Kind "fhir"
```

```CLI
# Example Azure CLI command (conceptual)
# az healthcareapis service create --name myfhirservice --resource-group myresourcegroup --kind fhir --location eastus
```

```ARM Template
{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.HealthcareApis/services",
      "apiVersion": "2021-11-01",
      "name": "myfhirservice",
      "location": "eastus",
      "kind": "fhir",
      "properties": {
        "accessPolicies": [],
        "authenticationConfiguration": {
          "type": "ManagedIdentity"
        }
      }
    }
  ]
}
```

--------------------------------

### Azure API for FHIR Quickstarts

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart_source=recommendations

Guides for deploying and getting started with Azure API for FHIR using different tools.

```APIDOC
Azure API for FHIR Deployment:

- Using Portal:
  Quickstart guide for deploying Azure API for FHIR via the Azure portal.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

- Using PowerShell:
  Quickstart guide for deploying Azure API for FHIR using Azure PowerShell.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart

- Using CLI:
  Quickstart guide for deploying Azure API for FHIR using Azure CLI.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

- Using ARM Template:
  Guide for deploying Azure API for FHIR using Azure Resource Manager (ARM) templates.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-api-fhir-resource-manager-template
```

--------------------------------

### Getting Started with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

A guide to help users set up and start using Azure API for FHIR. It covers the initial steps for deployment and basic configuration.

```APIDOC
Get started with Azure API for FHIR:
  1. Create an Azure API for FHIR resource in the Azure portal.
  2. Configure authentication using Microsoft Entra ID.
  3. Access the FHIR service endpoint.
  4. Perform basic FHIR operations (e.g., create, read resources).
```

--------------------------------

### Get Started with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir_source=recommendations

Provides guidance on setting up and starting with Azure API for FHIR. This includes initial configuration steps.

```APIDOC
Get Started with Azure API for FHIR:
  1. Create an Azure API for FHIR resource in the Azure portal.
  2. Configure Microsoft Entra ID for authentication and authorization.
  3. Obtain access tokens using Microsoft Entra ID.
  4. Interact with the FHIR API using standard HTTP requests.
```

--------------------------------

### Deploy Azure API for FHIR using Azure portal

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir_source=recommendations

A quickstart guide on deploying Azure API for FHIR and configuring its settings using the Azure portal. This covers the initial setup and deployment process.

```APIDOC
APIDOC:
  title: Quickstart: Deploy Azure API for FHIR using Azure portal
  description: |-
    Learn how to deploy Azure API for FHIR and configure settings using the Azure portal.
    Covers the initial deployment and basic configuration steps.
  related:
    - What is Azure API for FHIR?
```

--------------------------------

### Azure API for FHIR Quickstarts

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-api-fhir-resource-manager-template

Guides for deploying and getting started with Azure API for FHIR using different tools.

```APIDOC
Azure API for FHIR Deployment:

- Using Portal:
  Quickstart guide for deploying Azure API for FHIR via the Azure portal.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

- Using PowerShell:
  Quickstart guide for deploying Azure API for FHIR using Azure PowerShell.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart

- Using CLI:
  Quickstart guide for deploying Azure API for FHIR using Azure CLI.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

- Using ARM Template:
  Guide for deploying Azure API for FHIR using Azure Resource Manager (ARM) templates.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-api-fhir-resource-manager-template
```

--------------------------------

### Tutorial: Web Application with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-write-web-app_source=recommendations

A step-by-step guide to setting up Azure API for FHIR and developing a web application that interacts with it. Covers initial setup, application registration, and writing the web application.

```APIDOC
Tutorial Steps:
  1. Initial setup and FHIR deployment.
  2. Register public client application in Microsoft Entra ID.
  3. Write web application to interact with FHIR API.
```

--------------------------------

### Tutorial: Web Application with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-fhir-server_source=recommendations

A step-by-step guide to setting up Azure API for FHIR and developing a web application that interacts with it. Covers initial setup, application registration, and writing the web application.

```APIDOC
Tutorial Steps:
  1. Initial setup and FHIR deployment.
  2. Register public client application in Microsoft Entra ID.
  3. Write web application to interact with FHIR API.
```

--------------------------------

### Tutorial: Web Application with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-public-app-reg_source=recommendations

A step-by-step guide to setting up Azure API for FHIR and developing a web application that interacts with it. Covers initial setup, application registration, and writing the web application.

```APIDOC
Tutorial Steps:
  1. Initial setup and FHIR deployment.
  2. Register public client application in Microsoft Entra ID.
  3. Write web application to interact with FHIR API.
```

--------------------------------

### Install Azure Health Data Services CLI Extension

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

This command installs the Azure Health Data Services extension for the Azure CLI, which is required for managing FHIR services.

```bash
az extension add --name healthcareapis
```

--------------------------------

### Azure CLI Authentication and Version Check

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

Demonstrates how to log in to Azure using the Azure CLI and how to check the installed version and dependent libraries. It also shows how to upgrade the CLI.

```azurecli
az login
az version
az upgrade
```

--------------------------------

### Install Azure Health Data Services Extension

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

Installs the Azure Health Data Services extension for the Azure CLI, which is required for managing Azure API for FHIR resources.

```bash
az extension add --name healthcareapis
```

--------------------------------

### Azure CLI for FHIR Operations

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart_source=recommendations

Examples of using the Azure CLI to interact with Azure API for FHIR, including creating, managing, and querying FHIR resources.

```azurecli
az provider register --namespace Microsoft.HealthcareApis
az healthcareapis account create --resource-group <resource-group-name> --name <fhir-account-name> --kind fhir-stu3 --location <location>
az healthcareapis fhir-data-store create --resource-group <resource-group-name> --account-name <fhir-account-name> --name <fhir-store-name> --kind r4
az healthcareapis fhir-resource search --resource-group <resource-group-name> --account-name <fhir-account-name> --store-name <fhir-store-name> --resource-type Patient --query "total"

```

--------------------------------

### Python SDK for Azure FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

This snippet shows how to use the Azure SDK for Python to interact with Azure API for FHIR. It includes examples of authenticating and performing basic FHIR operations.

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

credential = DefaultAzureCredential()
client = HealthcareApisManagementClient(credential, subscription_id='YOUR_SUBSCRIPTION_ID')

# Example: List FHIR services in a resource group
fhir_services = client.fhir_services.list_by_resource_group('<your-resource-group>')
for fhir_service in fhir_services:
    print(fhir_service.name)
```

--------------------------------

### SMART on FHIR Integration

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

Tutorial on enabling SMART on FHIR applications with Azure API for FHIR. This guide explains how to integrate external applications using the SMART on FHIR standard.

```APIDOC
SMART on FHIR:
  - Enables SMART on FHIR applications with Azure API for FHIR.
  - Facilitates secure access to healthcare data for third-party applications.
  - Requires specific configuration and adherence to SMART on FHIR protocols.
```

--------------------------------

### Manage Azure API for FHIR with PowerShell

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart

This snippet covers common PowerShell commands for managing the Azure API for FHIR, such as getting service details and updating configurations.

```powershell
Get-AzFhirService -ResourceGroupName "fhirrg" -Name "myfhirservice"
Set-AzFhirService -ResourceGroupName "fhirrg" -Name "myfhirservice" -EnablePublicNetworkAccess $false
```

--------------------------------

### Azure API for FHIR Python Examples

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/how-to-run-a-reindex

Provides Python code examples for common tasks when working with the Azure API for FHIR.

```Python
from azure.identity import DefaultAzureCredential
from azure.healthcare.fhir import FhirClient

# ...

client = FhirClient("https://your-fhir-server.azurehealthcareapis.com", DefaultAzureCredential())

# Example: Read a Patient resource
patient_id = "example-patient-id"
response = client.read_patient(patient_id)
patient = response.result()

print(f"Patient Name: {patient.name[0].given[0]} {patient.name[0].family}")
```

--------------------------------

### Deploy Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

Deploy an instance of Azure API for FHIR using various methods including the Azure portal, PowerShell, Azure CLI, and ARM templates.

```arm
{
    "type": "Microsoft.HealthcareApis/services",
    "apiVersion": "2021-11-01",
    "location": "<location>",
    "properties": {
        "kind": "fhir-stu3",
        "accessPolicies": [],
        "authenticationConfiguration": {
            "type": "aad",
            "audience": "https://<fhir-service-name>.azurehealthcareapis.com",
            "authority": "https://login.microsoftonline.com/<tenant-id>"
        }
    }
}
```

--------------------------------

### Deploy Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

Deploy an instance of Azure API for FHIR using various methods including the Azure portal, PowerShell, Azure CLI, and ARM templates.

```powershell
Register-AzResourceProvider -ProviderNamespace Microsoft.HealthcareApis
New-AzHealthcareApisService -ResourceGroupName <resource-group-name> -Name <fhir-service-name> -Kind "fhir-stu3" -Location <location>
```

--------------------------------

### Deploy Azure API for FHIR using Azure portal

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/overview_source=recommendations

Quickstart guide on deploying Azure API for FHIR and configuring its settings through the Azure portal. This process involves creating and setting up an instance of the service.

```APIDOC
Deploy Azure API for FHIR via Azure Portal:

This quickstart outlines the steps to deploy and configure Azure API for FHIR using the Azure portal.

Steps:
1. Sign in to the Azure portal.
2. Navigate to 'Create a resource'.
3. Search for 'Azure API for FHIR' and select it.
4. Click 'Create'.
5. Fill in the required details:
   - Subscription
   - Resource group
   - Region
   - FHIR service name
   - Kind (e.g., FHIR)
   - Authentication type (e.g., Managed Identity, Local).
6. Configure additional settings as needed (e.g., networking, access policies).
7. Review and create the FHIR service instance.

Dependencies:
- An active Azure subscription.
- Appropriate permissions to create resources in Azure.

Inputs:
- Azure portal credentials.
- Configuration details for the FHIR service.

Outputs:
- A deployed Azure API for FHIR instance.

Limitations:
- Portal-based deployment may not be suitable for automated or complex deployments.
```

--------------------------------

### Azure API for FHIR Quickstarts

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-api-fhir-resource-manager-template_tabs=azure-portal

Guides for deploying and getting started with Azure API for FHIR using different tools.

```APIDOC
Azure API for FHIR Deployment:

- Using Portal:
  Quickstart guide for deploying Azure API for FHIR via the Azure portal.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart

- Using PowerShell:
  Quickstart guide for deploying Azure API for FHIR using Azure PowerShell.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart

- Using CLI:
  Quickstart guide for deploying Azure API for FHIR using Azure CLI.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

- Using ARM Template:
  Guide for deploying Azure API for FHIR using Azure Resource Manager (ARM) templates.
  URL: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-api-fhir-resource-manager-template
```

--------------------------------

### Getting Started with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/security-controls-policy_source=recommendations

This resource provides a guide on how to begin using Azure API for FHIR, covering initial setup and configuration.

```APIDOC
Resource:
  Type: Azure API for FHIR
  Purpose: Getting Started Guide
  Link: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir?source=recommendations
```

--------------------------------

### Get Started with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-api-fhir-access-token-validation

This document describes how to get started with Azure API for FHIR. It provides an introductory guide to setting up and using the service.

```APIDOC
Getting Started Guide:
  - Provides instructions on how to get started with Azure API for FHIR.
  - Covers initial setup and basic usage of the service.
```

--------------------------------

### Azure API for FHIR Development Tutorials

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-write-web-app

Guides for developing applications with Azure API for FHIR, including setting up the environment, registering applications, and writing web applications.

```APIDOC
Azure API for FHIR Development Tutorials:
  1. Initial setup and FHIR deployment:
     - Steps to deploy and configure Azure API for FHIR.
  2. Register public client application:
     - Instructions for registering a public client application in Microsoft Entra ID.
  3. Write web application:
     - Guidance on building a web application that interacts with Azure API for FHIR.
```

--------------------------------

### Tutorial: Web Application with Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-fhir-server

A step-by-step tutorial for setting up Azure API for FHIR and developing a web application, including initial setup, FHIR deployment, and public client application registration.

```APIDOC
Tutorial: Web Application with Azure API for FHIR:
  1. Initial setup and FHIR deployment
  2. Register public client application
  3. Write web application
```

--------------------------------

### DaVinci_PlanNet_Sample_Resources.http Example

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/davinci-plan-net

This snippet contains sample FHIR resources, pulled from the Implementation Guide examples, to be used for testing query capabilities against the Da Vinci Plan-Net profile.

```http
POST https://example.com/fhir/Patient
Content-Type: application/fhir+json

{
  "resourceType": "Patient",
  "id": "sample-patient-1",
  "name": [
    {
      "use": "official",
      "family": "Smith",
      "given": [
        "John"
      ]
    }
  ],
  "gender": "male"
}

POST https://example.com/fhir/Organization
Content-Type: application/fhir+json

{
  "resourceType": "Organization",
  "id": "sample-org-1",
  "name": "Example Health System"
}
```

--------------------------------

### Azure API for FHIR Development Tutorials

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-public-app-reg

Guides for developing applications with Azure API for FHIR, including setting up the environment, registering applications, and writing web applications.

```APIDOC
Azure API for FHIR Development Tutorials:
  1. Initial setup and FHIR deployment:
     - Steps to deploy and configure Azure API for FHIR.
  2. Register public client application:
     - Instructions for registering a public client application in Microsoft Entra ID.
  3. Write web application:
     - Guidance on building a web application that interacts with Azure API for FHIR.
```

--------------------------------

### Clone FHIR Server Repository and Navigate to SmartLauncher

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/smart-on-fhir_source=recommendations

Commands to clone the FHIR Server for Azure GitHub repository and navigate into the SmartLauncher sample application directory.

```PowerShell
git clone https://github.com/Microsoft/fhir-server
cd fhir-server/samples/apps/SmartLauncher
```

--------------------------------

### Access Token Validation

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

Details on how Azure API for FHIR validates access tokens, crucial for troubleshooting access issues.

```APIDOC
Azure API for FHIR Access Token Validation:

Purpose:
  To understand the process by which Azure API for FHIR validates incoming access tokens to grant or deny access to resources.

Validation Steps:
  1. Token Signature Verification: Ensures the token was issued by a trusted authority and has not been tampered with.
  2. Token Expiration Check: Verifies that the token has not expired.
  3. Audience Validation: Confirms that the token is intended for the Azure API for FHIR service.
  4. Issuer Validation: Checks that the token was issued by the correct Microsoft Entra ID tenant.
  5. Scope and Claim Validation: Evaluates the permissions and user roles defined within the token to determine access rights to specific FHIR resources.

Troubleshooting:
  - Ensure the client application is correctly registered in Microsoft Entra ID.
  - Verify that the correct scopes are requested and included in the token.
  - Confirm that the token's audience and issuer match the FHIR service configuration.

Related Topics:
  - Access Control Overview
  - Register a client application
```

--------------------------------

### Microsoft Learn Product Documentation

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/centers-for-medicare-tutorial-introduction_source=recommendations

Links to in-depth articles on Microsoft developer tools and technologies, covering a wide range of products.

```APIDOC
Product Documentation:
  ASP.NET
  Azure
  Dynamics 365
  Microsoft 365
  Microsoft Copilot
  Microsoft Entra
  Microsoft Exchange
  Microsoft Fabric
  Microsoft Intune
  .NET
  Power Apps
  Power BI
  Power Platform
  Microsoft Purview
  SharePoint
  SQL
  Microsoft Teams
  Visual Studio
  Windows
  Windows Server

View all products: https://learn.microsoft.com/en-us/docs/
```

--------------------------------

### Azure API for FHIR Documentation

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

This section provides API documentation for interacting with Azure API for FHIR. It outlines common operations and their parameters.

```APIDOC
Azure API for FHIR:

This API provides a managed, cloud-based service that supports the HL7 FHIR standard for healthcare data.

Resources:
  - Patients
  - Observations
  - Conditions
  - Medications

Common Operations:

GET /Patient
  - Retrieves a list of patients.
  - Parameters:
    - _id: The ID of the patient.
    - name: The name of the patient.
  - Returns: A Bundle resource containing Patient resources.

POST /Patient
  - Creates a new patient resource.
  - Request Body:
    - A Patient resource in FHIR format.
  - Returns: The created Patient resource with its ID.

GET /Patient/{id}
  - Retrieves a specific patient by ID.
  - Parameters:
    - id: The ID of the patient.
  - Returns: The Patient resource.

PUT /Patient/{id}
  - Updates an existing patient resource.
  - Parameters:
    - id: The ID of the patient.
  - Request Body:
    - The updated Patient resource in FHIR format.
  - Returns: The updated Patient resource.

DELETE /Patient/{id}
  - Deletes a patient resource.
  - Parameters:
    - id: The ID of the patient.
  - Returns: Success or error status.
```

--------------------------------

### Deploy Azure API for FHIR using PowerShell

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart

This snippet demonstrates the PowerShell commands required to deploy the Azure API for FHIR. It includes setting up the resource group, location, and the FHIR service itself.

```powershell
New-AzResourceGroup -Name "fhirrg" -Location "eastus"
New-AzFhirService -ResourceGroupName "fhirrg" -Name "myfhirservice" -Location "eastus"
```

--------------------------------

### Azure CLI Quickstart for Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

This snippet demonstrates the basic Azure CLI commands for setting up and interacting with the Azure API for FHIR. It covers resource group creation, FHIR service deployment, and accessing the FHIR service endpoint.

```azurecli
az group create --name "MyResourceGroup" --location "eastus"
az provider register --namespace Microsoft.HealthcareApis
az healthcareapis create --resource-group "MyResourceGroup" --name "MyFhirServer" --kind "fhir-R4" --location "eastus"
az healthcareapis show --resource-group "MyResourceGroup" --name "MyFhirServer" --query "privateEndpointConnections[0].privateLinkServiceConnectionState.description"
```

--------------------------------

### Install Healthcare APIs Extension

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

Adds the Azure Health Data Services extension to your Azure CLI environment, enabling commands for managing FHIR services.

```azurecli
az extension add --name healthcareapis
```

--------------------------------

### Azure API for FHIR Configuration

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-database

This snippet provides a link to the configuration guide for Azure API for FHIR, likely covering database setup and other essential settings.

```APIDOC
APIDOC:
  Endpoint: /configure-database
  Method: GET
  Description: Provides guidance on configuring the database for Azure API for FHIR.
  Parameters:
    None
  Returns:
    Documentation link for database configuration.
```

--------------------------------

### US Core Profiles Loading Example

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/davinci-pdex-tutorial_source=recommendations

Demonstrates how to load US Core profiles for Azure API for FHIR to validate against IG requirements and remove warnings. Includes a link to a sample HTTP file for creating profiles.

```HTTP
GET https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/validation-against-profiles
GET https://github.com/microsoft/fhir-server/blob/main/docs/rest/PayerDataExchange/USCore.http
GET http://hl7.org/fhir/us/core/STU3.1.1/profiles.html#profiles
```

--------------------------------

### Azure Portal Deployment for FHIR Server

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart_source=recommendations

This section details the process of deploying the Azure API for FHIR service through the Azure portal. It outlines the necessary steps and configurations for a successful deployment.

```APIDOC
Azure API for FHIR Deployment via Azure Portal:

1. **Navigate to Azure Portal**: Log in to the Azure portal.
2. **Create a Resource**: Click '+ Create a resource'.
3. **Search for FHIR**: In the search bar, type 'Azure API for FHIR' and select it from the results.
4. **Configure Service**: 
   - **Subscription**: Select your Azure subscription.
   - **Resource group**: Choose an existing or create a new resource group.
   - **Region**: Select the desired Azure region.
   - **FHIR service name**: Enter a unique name for your FHIR service.
   - **Kind**: Select 'FHIR'.
   - **Authentication**: Configure authentication settings (e.g., Managed Identity, Azure Active Directory).
   - **Access Policies**: Define access policies for users and applications.
5. **Review and Create**: Review the configuration and click 'Create'.

**Post-Deployment**: 
- Once deployed, you can access the FHIR service endpoint and configure it further.
```

--------------------------------

### Microsoft Learn Product Documentation

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-fhir-server_source=recommendations

Provides in-depth articles on Microsoft developer tools and technologies, including Azure API for FHIR.

```APIDOC
Product Documentation:
  Azure:
    - Description: Managed, cloud-based API that supports the HL7 FHIR standard.
    - Link: https://learn.microsoft.com/en-us/azure/
```

--------------------------------

### Azure API for FHIR Deployment

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart_source=recommendations

This section outlines the process of deploying Azure API for FHIR via the Azure portal. It details the necessary steps and considerations for a successful deployment.

```APIDOC
Azure API for FHIR Deployment:

1. **Navigate to Azure Portal**: Log in to the Azure portal.
2. **Create Resource**: Click on 'Create a resource'.
3. **Search for FHIR**: Search for 'Azure API for FHIR' and select it.
4. **Configure Service**: 
   - **Subscription**: Choose your Azure subscription.
   - **Resource Group**: Create a new or select an existing resource group.
   - **Account Name**: Enter a unique name for your FHIR account.
   - **Region**: Select the desired Azure region.
   - **Kind**: Choose the FHIR version (e.g., FHIR R4).
   - **Authentication**: Configure authentication settings (e.g., Managed Identity, Azure Active Directory).
5. **Review and Create**: Review the configuration and click 'Create'.

**Note**: Access to the deployed service may require specific authorization and directory changes.
```

--------------------------------

### Query Patient-everything by Date Range

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/patient-everything

This example demonstrates how to use the Patient-everything operation to retrieve resources within a specified date range (2010-2020). It utilizes the `start` and `end` query parameters.

```APIDOC
GET {FHIRURL}/Patient/{ID}/$everything?start=2010&end=2020
```

--------------------------------

### Client Application Registration

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

Explains the two types of application registrations (resource and client) required for applications to interact with Microsoft Entra ID and the FHIR server.

```APIDOC
Client Application Registration for Azure API for FHIR:

Purpose:
  To register applications with Microsoft Entra ID so they can authenticate and access the Azure API for FHIR.

Types of Registrations:
  1. Resource Application Registrations:
     - Represents the Azure API for FHIR service itself within Microsoft Entra ID.
     - Defines the API permissions that client applications can request.

  2. Client Application Registrations:
     - Represents the applications (e.g., web apps, mobile apps, services) that need to access the Azure API for FHIR.
     - Requires specific API permissions granted by the resource application registration.

Registration Process:
  - Navigate to the Microsoft Entra ID portal.
  - Create a new application registration.
  - Configure the application type (e.g., Web app, Public client).
  - Define redirect URIs.
  - Grant API permissions to the Azure API for FHIR resource application.
  - Obtain client secrets or certificates for authentication.

Related Topics:
  - Access Control Overview
  - Access token validation
```

--------------------------------

### Deploy Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart

Deploys an instance of Azure API for FHIR to a specified resource group and location. Replace placeholders with your specific values.

```bash
az healthcareapis create --resource-group <resource-group-name> --location <location> --name <fhir-service-name> --kind "fhir-R4"
```

--------------------------------

### Microsoft Learn Product Documentation Links

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-write-web-app_source=recommendations

Links to documentation for various Microsoft products and services, including Azure, .NET, Power Platform, and more. These resources are essential for developers working within the Microsoft ecosystem.

```APIDOC
Product Documentation:
  ASP.NET: https://learn.microsoft.com/en-us/aspnet/
  Azure: https://learn.microsoft.com/en-us/azure/
  Dynamics 365: https://learn.microsoft.com/en-us/dynamics365/
  Microsoft 365: https://learn.microsoft.com/en-us/microsoft-365/
  Microsoft Copilot: https://learn.microsoft.com/en-us/copilot/
  Microsoft Entra: https://learn.microsoft.com/en-us/entra/
  Microsoft Exchange: https://learn.microsoft.com/en-us/exchange/
  Microsoft Fabric: https://learn.microsoft.com/en-us/fabric/
  Microsoft Intune: https://learn.microsoft.com/en-us/mem/
  .NET: https://learn.microsoft.com/en-us/dotnet/
  Power Apps: https://learn.microsoft.com/en-us/power-apps/
  Power BI: https://learn.microsoft.com/en-us/power-bi/
  Power Platform: https://learn.microsoft.com/en-us/power-platform/
  Microsoft Purview: https://learn.microsoft.com/en-us/purview/
  SharePoint: https://learn.microsoft.com/en-us/sharepoint/
  SQL: https://learn.microsoft.com/en-us/sql/
  Microsoft Teams: https://learn.microsoft.com/en-us/microsoftteams/
  Visual Studio: https://learn.microsoft.com/en-us/visualstudio/
  Windows: https://learn.microsoft.com/en-us/windows/
  Windows Server: https://learn.microsoft.com/en-us/windows-server/
```

--------------------------------

### Patient-everything Query by Date Range

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/patient-everything_source=recommendations

This example demonstrates how to use the Patient-everything operation to retrieve all resources for a specific patient within a given date range. It utilizes the `start` and `end` query parameters.

```json
GET {FHIRURL}/Patient/{ID}/$everything?start=2010&end=2020
```

--------------------------------

### Microsoft Learn Product Documentation Links

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-github-projects_source=recommendations

Provides links to various Microsoft product documentation, including ASP.NET, Azure, Dynamics 365, Microsoft 365, and more. These links are useful for developers seeking information on Microsoft technologies.

```APIDOC
Product Documentation:
  ASP.NET: https://learn.microsoft.com/en-us/aspnet/
  Azure: https://learn.microsoft.com/en-us/azure/
  Dynamics 365: https://learn.microsoft.com/en-us/dynamics365/
  Microsoft 365: https://learn.microsoft.com/en-us/microsoft-365/
  Microsoft Copilot: https://learn.microsoft.com/en-us/copilot/
  Microsoft Entra: https://learn.microsoft.com/en-us/entra/
  Microsoft Exchange: https://learn.microsoft.com/en-us/exchange/
  Microsoft Fabric: https://learn.microsoft.com/en-us/fabric/
  Microsoft Intune: https://learn.microsoft.com/en-us/mem/
  .NET: https://learn.microsoft.com/en-us/dotnet/
  Power Apps: https://learn.microsoft.com/en-us/power-apps/
  Power BI: https://learn.microsoft.com/en-us/power-bi/
  Power Platform: https://learn.microsoft.com/en-us/power-platform/
  Microsoft Purview: https://learn.microsoft.com/en-us/purview/
  SharePoint: https://learn.microsoft.com/en-us/sharepoint/
  SQL: https://learn.microsoft.com/en-us/sql/
  Microsoft Teams: https://learn.microsoft.com/en-us/microsoftteams/
  Visual Studio: https://learn.microsoft.com/en-us/visualstudio/
  Windows: https://learn.microsoft.com/en-us/windows/
  Windows Server: https://learn.microsoft.com/en-us/windows-server/
```

--------------------------------

### Configure Azure RBAC for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

Details on using Azure Role-Based Access Control (Azure RBAC) to assign data plane access to the Azure API for FHIR.

```APIDOC
Azure RBAC Configuration for Azure API for FHIR Data Plane:

Purpose:
  To manage data plane access to the Azure API for FHIR using Azure Role-Based Access Control (Azure RBAC).

When to Use Azure RBAC:
  - Preferred method when data plane users are managed within the Microsoft Entra tenant associated with your Azure subscription.

Configuration Steps:
  1. Assign Azure Roles: Grant specific Azure roles (e.g., FHIR Data Contributor, FHIR Data Reader) to users, groups, or service principals.
  2. Scope of Assignment: Roles can be assigned at the FHIR service level or at a more granular scope if supported.
  3. Role Definitions: Understand the permissions associated with each built-in FHIR data role.

External Microsoft Entra Tenants:
  - If using an external Microsoft Entra tenant, refer to the local RBAC assignment reference for alternative configuration methods.

Related Topics:
  - Access Control Overview
  - Register a client application
```

--------------------------------

### Azure API for FHIR REST API Reference

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart_source=recommendations

Documentation for the RESTful API endpoints provided by Azure API for FHIR. This includes details on supported HTTP methods, request parameters, response formats, and common operations for managing FHIR resources.

```APIDOC
FHIR Resource Operations:

GET /{Resource}/{id}
  - Retrieves a specific FHIR resource by its ID.
  - Parameters:
    - Resource: The type of FHIR resource (e.g., Patient, Observation).
    - id: The unique identifier of the resource.
  - Returns: The requested FHIR resource in JSON format.

POST /{Resource}
  - Creates a new FHIR resource.
  - Parameters:
    - Resource: The type of FHIR resource to create.
    - Request Body: The FHIR resource data in JSON format.
  - Returns: The created FHIR resource with its assigned ID.

PUT /{Resource}/{id}
  - Updates an existing FHIR resource.
  - Parameters:
    - Resource: The type of FHIR resource.
    - id: The unique identifier of the resource to update.
    - Request Body: The updated FHIR resource data in JSON format.
  - Returns: The updated FHIR resource.

DELETE /{Resource}/{id}
  - Deletes a FHIR resource.
  - Parameters:
    - Resource: The type of FHIR resource.
    - id: The unique identifier of the resource to delete.
  - Returns: Success or error status.

Search Operations:

GET /{Resource}?parameter=value
  - Searches for FHIR resources based on specified parameters.
  - Parameters:
    - Resource: The type of FHIR resource to search.
    - parameter: Search parameters (e.g., name, birthdate).
  - Returns: A Bundle resource containing matching FHIR resources.

Example Search:
GET /Patient?name=John&birthdate=1990-01-01

Supported FHIR Versions:
- R4
- STU3

Authentication and Authorization:
- Azure Active Directory (Azure AD) integration for secure access.
- Role-based access control (RBAC) for managing permissions.

Error Handling:
- Standard HTTP status codes for errors (e.g., 400 Bad Request, 404 Not Found, 401 Unauthorized).
- FHIR OperationOutcome resource for detailed error information.
```

--------------------------------

### Get Access Token using Azure CLI

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/register-resource-azure-ad-client-app_source=recommendations

This snippet demonstrates how to obtain an access token for Azure API for FHIR using the Azure CLI. It requires the Azure CLI to be installed and authenticated.

```bash
az account get-access-token --resource=https://<fhir-url> --output tsv --query accessToken
```

--------------------------------

### Viewing US Core Goal Profile

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/store-profiles-in-fhir

An example of viewing the US Core Goal profile using a GET request. This retrieves the StructureDefinition resource for the specified profile.

```HTTP
GET https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/StructureDefinition?url=http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal
```

```JSON
{
  "resourceType" : "StructureDefinition",
  "id" : "us-core-goal",
  "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal",
  "version" : "3.1.1",
  "name" : "USCoreGoalProfile",
  "title" : "US Core Goal Profile",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-07-21",
  "publisher" : "HL7 US Realm Steering Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.healthit.gov"
        }
      ]
    }
  ],
  "description" : "Defines constraints and extensions on the Goal resource for the minimal set of data to query and retrieve a patient's goal(s).",

}
```

--------------------------------

### Microsoft Learn Product Documentation

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-azure-rbac_source=recommendations

Links to in-depth articles on Microsoft developer tools and technologies, including Azure, .NET, Power Platform, and more.

```APIDOC
Product Documentation:
  ASP.NET: https://learn.microsoft.com/en-us/aspnet/
  Azure: https://learn.microsoft.com/en-us/azure/
  Dynamics 365: https://learn.microsoft.com/en-us/dynamics365/
  Microsoft 365: https://learn.microsoft.com/en-us/microsoft-365/
  Microsoft Copilot: https://learn.microsoft.com/en-us/copilot/
  Microsoft Entra: https://learn.microsoft.com/en-us/entra/
  Microsoft Exchange: https://learn.microsoft.com/en-us/exchange/
  Microsoft Fabric: https://learn.microsoft.com/en-us/fabric/
  Microsoft Intune: https://learn.microsoft.com/en-us/mem/
  .NET: https://learn.microsoft.com/en-us/dotnet/
  Power Apps: https://learn.microsoft.com/en-us/power-apps/
  Power BI: https://learn.microsoft.com/en-us/power-bi/
  Power Platform: https://learn.microsoft.com/en-us/power-platform/
  Microsoft Purview: https://learn.microsoft.com/en-us/purview/
  SharePoint: https://learn.microsoft.com/en-us/sharepoint/
  SQL: https://learn.microsoft.com/en-us/sql/
  Microsoft Teams: https://learn.microsoft.com/en-us/microsoftteams/
  Visual Studio: https://learn.microsoft.com/en-us/visualstudio/
  Windows: https://learn.microsoft.com/en-us/windows/
  Windows Server: https://learn.microsoft.com/en-us/windows-server/
```

--------------------------------

### Microsoft Product Documentation

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-public-app-reg_source=recommendations

Links to documentation for various Microsoft products and technologies, including Azure, .NET, Power Platform, and more.

```APIDOC
Product Documentation:
  ASP.NET: https://learn.microsoft.com/en-us/aspnet/
  Azure: https://learn.microsoft.com/en-us/azure/
  Dynamics 365: https://learn.microsoft.com/en-us/dynamics365/
  Microsoft 365: https://learn.microsoft.com/en-us/microsoft-365/
  Microsoft Copilot: https://learn.microsoft.com/en-us/copilot/
  Microsoft Entra: https://learn.microsoft.com/en-us/entra/
  Microsoft Exchange: https://learn.microsoft.com/en-us/exchange/
  Microsoft Fabric: https://learn.microsoft.com/en-us/fabric/
  Microsoft Intune: https://learn.microsoft.com/en-us/mem/
  .NET: https://learn.microsoft.com/en-us/dotnet/
  Power Apps: https://learn.microsoft.com/en-us/power-apps/
  Power BI: https://learn.microsoft.com/en-us/power-bi/
  Power Platform: https://learn.microsoft.com/en-us/power-platform/
  Microsoft Purview: https://learn.microsoft.com/en-us/purview/
  SharePoint: https://learn.microsoft.com/en-us/sharepoint/
  SQL: https://learn.microsoft.com/en-us/sql/
  Microsoft Teams: https://learn.microsoft.com/en-us/microsoftteams/
  Visual Studio: https://learn.microsoft.com/en-us/visualstudio/
  Windows: https://learn.microsoft.com/en-us/windows/
  Windows Server: https://learn.microsoft.com/en-us/windows-server/
```

--------------------------------

### Deploy Azure API for FHIR

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-started-with-azure-api-fhir

Deploy an instance of Azure API for FHIR using various methods including the Azure portal, PowerShell, Azure CLI, and ARM templates.

```azurecli
az provider register --namespace Microsoft.HealthcareApis
az healthcareapis account create --resource-group <resource-group-name> --name <fhir-service-name> --kind fhir-stu3 --location <location>
```

--------------------------------

### Microsoft Learn Resources

Source: https://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-public-app-reg_source=recommendations

Links to various learning resources on Microsoft Learn, including documentation, training, credentials, Q&A, code samples, assessments, and shows.

```APIDOC
Microsoft Learn Resources:
  Documentation: https://learn.microsoft.com/en-us/docs/
  Training: https://learn.microsoft.com/en-us/training/
  Credentials: https://learn.microsoft.com/en-us/credentials/
  Q&A: https://learn.microsoft.com/en-us/answers/
  Code Samples: https://learn.microsoft.com/en-us/samples/
  Assessments: https://learn.microsoft.com/en-us/assessments/
  Shows: https://learn.microsoft.com/en-us/shows/
```
Tokens:
Raw