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 Collection API

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

Microsoft Azure Health Data Services Collection 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 Collection. 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 2 operations across 2 paths, and defines 20 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.

2 operations 2 paths 20 schemas 2 GET

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 Collection 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 2

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

Collection 2
GET
/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services
Get all the service instances in a subscription.
Services_List 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services
Get all the service instances in a resource group.
Services_ListByResourceGroup 3 params → 200default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ServicesProperties (10 properties), ServicesResource (8 properties), systemData (6 properties), ServiceCorsConfigurationInfo (5 properties). Each schema is shown below with its type and property counts.

ServiceCosmosDbConfigurationInfo
object
The settings for the Cosmos DB database backing the service.
3 properties
ServiceExportConfigurationInfo
object
Export operation configuration information
1 property
ServiceOciArtifactEntry
object
An Open Container Initiative (OCI) artifact.
3 properties
systemData
object
Metadata pertaining to creation and last modification of the resource.
6 properties
ServiceCorsConfigurationOriginEntry
string
An origin for CORS.
ErrorDetails
object
Error details.
1 property
ServicesDescriptionListResult
object
A list of service description objects with a next link.
2 properties
ProvisioningState
string
The provisioning state.
ErrorDetailsInternal
object
Error details.
3 properties
ServicesProperties
object
The properties of a service instance.
10 properties
ServiceAccessPoliciesInfo
array
The access policies of the service instance.
ServiceAuthenticationConfigurationInfo
object
Authentication configuration information
3 properties
ServiceAccessPolicyEntry
object
An access policy entry.
1 property 1 required
ServicesResource
object
The common properties of a service.
8 properties 2 required
ServiceCorsConfigurationHeaderEntry
string
A header for CORS.
ServiceCorsConfigurationMethodEntry
string
A method for CORS.
ServiceCorsConfigurationInfo
object
The settings for the CORS configuration of the service instance.
5 properties
ServiceImportConfigurationInfo
object
Import operation configuration information
3 properties
ServiceAcrConfigurationInfo
object
Azure container registry configuration information
2 properties
ServicesDescription
object
The description of the service.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

Microsoft Azure Health Data Services Deid API
Microsoft Azure Health Data Services DicomServices API
Microsoft Azure Health Data Services FhirServices 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 Collection 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.