HealthcareApisClient

Name: HealthcareApisClient API
Brand: Azure Healthcare APIs Management
Availability: InStock

★ Only Publicly Available OpenAPI DocumentHealthcareEhr Emroauth29 EndpointsREST

For Agents

Provision Microsoft Healthcare APIs (FHIR) service instances on Azure, list services across a subscription, and manage their lifecycle.

Connect the HealthcareApisClient to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the HealthcareApisClient, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with HealthcareApisClient API.

Provision a new Microsoft Healthcare APIs service instance with a FHIR data store

Check whether a proposed service name is available before creation

List all Healthcare APIs services in a subscription or filter by resource group

Retrieve the configuration of a specific service including its FHIR endpoint

GET STARTED

Start building with HealthcareApisClient API

Explore with Jentic

View OpenAPI Document

Use for: I need to provision a new Healthcare APIs service for a FHIR project, Check whether the service name 'patient-records-prod' is available, List every Healthcare APIs service in subscription 'sub-clinical', Retrieve the FHIR endpoint URL for service 'patient-records-prod'

Not supported: Does not read or write FHIR resources, run FHIR queries, or manage clinical data — use for provisioning and managing Healthcare APIs service instances only.

Jentic publishes the only available OpenAPI document for HealthcareApisClient, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for HealthcareApisClient, keeping it validated and agent-ready. The Azure Healthcare APIs Management API provisions and manages Microsoft Healthcare APIs services through Azure Resource Manager. These services host FHIR-compliant clinical data stores in Azure, and this control-plane API handles their lifecycle: name availability, create or update, get, list, update, and delete. The data plane (actual FHIR resource access) is reached through each provisioned service's hostname; this API governs the service resource itself. Authentication is Azure AD OAuth2 against management.azure.com.

Use Cases

Patterns agents use HealthcareApisClient API for, with concrete tasks.

★ Stand up a FHIR data store on Azure

Provision a Microsoft Healthcare APIs service via PUT on /subscriptions/.../services/{resourceName} with the desired location, kind (fhir-R4 or fhir-Stu3), and authentication configuration. Once Succeeded, the service exposes a FHIR endpoint that applications can use for clinical data exchange. Suitable for healthcare ISVs needing a managed FHIR server.

Create a Healthcare APIs service named 'patient-records-prod' in resource group 'clinical-rg' with kind 'fhir-R4' and the agreed Azure AD authority configured.

Pre-flight name availability check

Validate a candidate service name with POST /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability before attempting a PUT. This avoids a failed provision if the name is taken across the subscription scope. Useful in self-service portals that surface name validation to users.

POST /subscriptions/{sub}/providers/Microsoft.HealthcareApis/checkNameAvailability with the proposed name 'patient-records-prod' and report whether it is available.

Subscription-wide FHIR service inventory

List all Healthcare APIs services across a subscription via GET /subscriptions/.../providers/Microsoft.HealthcareApis/services. The response gives each service's FHIR kind, endpoint hostname, and current provisioning state. Useful for compliance teams that need a snapshot of every clinical data store under management.

GET all Healthcare APIs services in subscription 'sub-clinical' and return each service's resource ID, kind, and FHIR endpoint.

AI agent FHIR provisioning via Jentic

A clinical platform agent uses Jentic to spin up FHIR data stores on demand for new tenants. Jentic finds Services_CreateOrUpdate, loads the input schema, and executes against ARM with a scoped bearer token. The agent never sees the raw Azure credentials.

Use Jentic to search for 'create azure healthcare apis service', load Services_CreateOrUpdate, and execute it for a new tenant with kind 'fhir-R4' in the agreed region.

Key Endpoints

9 endpoints — jentic publishes the only available openapi specification for healthcareapisclient, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

PUT