How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Health Data Services FhirServices API

The FhirServices API from Microsoft Azure Health Data Services — 2 operation(s) for fhirservices.

Microsoft Azure Health Data Services FhirServices API is one of 13 APIs that Microsoft Azure Health Data Services publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include FhirServices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and pricing.

This API exposes 5 operations across 2 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2024-11-15.

Requests are made against the base URL https://{workspace-name}-{fhir-service-name}.fhir.azurehealthcareapis.com.

5 operations 2 paths 34 schemas 1 DELETE2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-11-15
Base URL
https://{workspace-name}-{fhir-service-name}.fhir.azurehealthcareapis.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Microsoft Azure Health Data Services FhirServices API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (AadToken) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

  • AadToken — The Azure Active Directory OAuth2 Flow

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

FhirServices 5
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices
Lists all FHIR Services for the given workspace
FhirServices_ListByWorkspace 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
Gets the properties of the specified FHIR Service.
FhirServices_Get 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
Creates or updates a FHIR Service resource with the specified parameters.
FhirServices_CreateOrUpdate 5 params body → 200201202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
Patch FHIR Service details.
FhirServices_Update 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
Deletes a FHIR Service.
FhirServices_Delete 5 params → 200202204default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are FhirServiceProperties (12 properties), systemData (6 properties), FhirServiceCorsConfiguration (5 properties), FhirServiceAuthenticationConfiguration (4 properties). Each schema is shown below with its type and property counts.

CorsConfigurationOriginEntry
string
An origin for CORS.
ResourceVersionPolicyConfiguration
object
The settings for history tracking for FHIR resources.
2 properties
Error
object
Error details.
1 property
UserAssignedIdentity
object
User assigned identity properties
2 properties
Encryption
object
Settings to encrypt a service
1 property
ResourcePublicNetworkAccess
string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
SmartDataActions
string
The Data Actions that can be enabled for a Smart Identity Provider Application.
FhirServiceCorsConfiguration
object
The settings for the CORS configuration of the service instance.
5 properties
FhirResourceVersionPolicy
string
Controls how resources are versioned on the FHIR service
ServiceOciArtifactEntry
object
An Open Container Initiative (OCI) artifact.
3 properties
systemData
object
Metadata pertaining to creation and last modification of the resource.
6 properties
FhirServiceImportConfiguration
object
Import operation configuration information
3 properties
ErrorDetails
object
Error details.
1 property
CorsConfigurationMethodEntry
string
A method for CORS.
FhirService
object
The description of Fhir Service
3 properties
ProvisioningState
string
The provisioning state.
FhirServiceAuthenticationConfiguration
object
Authentication configuration information
4 properties
FhirServiceExportConfiguration
object
Export operation configuration information
1 property
SmartIdentityProviderConfiguration
object
An object to configure an identity provider for use with SMART on FHIR authentication.
2 properties
ErrorDetailsInternal
object
Error details.
3 properties
UserAssignedIdentities
object
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscripti…
ResourceTags
object
List of key value pairs that describe the resource. This will overwrite the existing tags.
1 property
ResourceEventState
string
Indicates the current status of event support for the resource.
ImplementationGuidesConfiguration
object
The settings for Implementation Guides - defining capabilities for national standards, vendor consortiums, clinical societies, etc.
1 property
FhirServicePatchResource
object
FhirService patch properties
CorsConfigurationHeaderEntry
string
A header for CORS.
SmartIdentityProviderApplication
object
An Application configured in the Identity Provider used to access FHIR resources.
3 properties
FhirServiceProperties
object
Fhir Service properties.
12 properties
TaggedResource
object
The common properties of tracked resources in the service.
FhirServiceAcrConfiguration
object
Azure container registry configuration information
2 properties
ServiceManagedIdentity
object
Managed service identity (system assigned and/or user assigned identities)
1 property
LocationBasedResource
object
The common properties for any location based resource, tracked or proxy.
1 property
ResourceCore
object
The common properties for any resource, tracked or proxy.
4 properties
FhirServiceCollection
object
A collection of Fhir services.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azure-health-fhirservices-api-openapi.yml Raw ↑

Other APIs Microsoft Azure Health Data Services publishes across the network.

Microsoft Azure Health Data Services Collection API
Microsoft Azure Health Data Services Deid API
Microsoft Azure Health Data Services DicomServices API
Microsoft Azure Health Data Services IotConnectors API
Microsoft Azure Health Data Services Jobs API
Microsoft Azure Health Data Services PrivateEndpointConnections API
Microsoft Azure Health Data Services PrivateLinkResources API
Microsoft Azure Health Data Services Proxy API
Microsoft Azure Health Data Services Resource API
Microsoft Azure Health Data Services WorkspacePrivateEndpointConnections API
Microsoft Azure Health Data Services WorkspacePrivateLinkResources API
Microsoft Azure Health Data Services Workspaces API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Health Data Services FhirServices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.