swagger: '2.0' info: title: Azure Health Data Services de-identification service Collection FhirServices API version: '2024-11-15' x-typespec-generated: - emitter: '@azure-tools/typespec-autorest' schemes: - https consumes: - application/json produces: - application/json security: - AadToken: - https://deid.azure.com/.default tags: - name: FhirServices paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices : get: tags: - FhirServices description: Lists all FHIR Services for the given workspace operationId: FhirServices_ListByWorkspace x-ms-examples: List fhirservices: $ref: ./examples/fhirservices/FhirServices_List.json parameters: - $ref: '#/parameters/resourceGroupName' - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/workspaceName' responses: '200': description: List of FHIR Services. schema: $ref: '#/definitions/FhirServiceCollection' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorDetails' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName} : get: tags: - FhirServices description: Gets the properties of the specified FHIR Service. operationId: FhirServices_Get x-ms-examples: Get a Fhir Service: $ref: ./examples/fhirservices/FhirServices_Get.json parameters: - $ref: '#/parameters/resourceGroupName' - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/workspaceName' - $ref: '#/parameters/fhirServiceName' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/FhirService' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorDetails' put: tags: - FhirServices description: Creates or updates a FHIR Service resource with the specified parameters. operationId: FhirServices_CreateOrUpdate x-ms-long-running-operation: true x-ms-examples: Create or update a Fhir Service: $ref: ./examples/fhirservices/FhirServices_Create.json parameters: - $ref: '#/parameters/resourceGroupName' - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/workspaceName' - $ref: '#/parameters/fhirServiceName' - name: fhirservice description: The parameters for creating or updating a Fhir Service resource. in: body required: true schema: $ref: '#/definitions/FhirService' responses: '200': description: Updated - Put request accepted and an existing resource is updated. schema: $ref: '#/definitions/FhirService' '201': description: Created - Put request accepted and an existing resource is being created asynchronously. schema: $ref: '#/definitions/FhirService' '202': description: Accepted - Put request accepted and an existing resource is being updated asynchronously. schema: $ref: '#/definitions/FhirService' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorDetails' patch: tags: - FhirServices description: Patch FHIR Service details. operationId: FhirServices_Update x-ms-long-running-operation: true x-ms-examples: Update a Fhir Service: $ref: ./examples/fhirservices/FhirServices_Patch.json parameters: - $ref: '#/parameters/resourceGroupName' - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/fhirServiceName' - $ref: '#/parameters/workspaceName' - name: fhirservicePatchResource description: The parameters for updating a Fhir Service. in: body required: true schema: $ref: '#/definitions/FhirServicePatchResource' responses: '200': description: Updated - Patch request accepted and an existing resource is updated. schema: $ref: '#/definitions/FhirService' '202': description: Accepted - Patch request accepted and an existing resource is being updated asynchronously. schema: $ref: '#/definitions/FhirService' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorDetails' delete: tags: - FhirServices description: Deletes a FHIR Service. operationId: FhirServices_Delete x-ms-long-running-operation: true x-ms-examples: Delete a Fhir Service: $ref: ./examples/fhirservices/FhirServices_Delete.json parameters: - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/fhirServiceName' - $ref: '#/parameters/workspaceName' responses: '200': description: Resource deleted. '202': description: Delete request accepted; the operation will complete asynchronously. '204': description: The resource does not exist. default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' definitions: CorsConfigurationOriginEntry: description: An origin for CORS. type: string pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$ ErrorDetails: description: Error details. type: object properties: error: description: Error details $ref: '#/definitions/ErrorDetailsInternal' FhirServiceCorsConfiguration: description: The settings for the CORS configuration of the service instance. type: object properties: origins: type: array description: The origins to be allowed via CORS. readOnly: false items: $ref: '#/definitions/CorsConfigurationOriginEntry' headers: type: array description: The headers to be allowed via CORS. readOnly: false items: $ref: '#/definitions/CorsConfigurationHeaderEntry' methods: type: array description: The methods to be allowed via CORS. readOnly: false items: $ref: '#/definitions/CorsConfigurationMethodEntry' maxAge: type: integer format: int32 description: The max age to be allowed via CORS. readOnly: false minimum: 0 maximum: 99999 allowCredentials: type: boolean description: If credentials are allowed via CORS. readOnly: false FhirServiceProperties: description: Fhir Service properties. type: object properties: provisioningState: description: The provisioning state. $ref: '#/definitions/ProvisioningState' acrConfiguration: description: Fhir Service Azure container registry configuration. $ref: '#/definitions/FhirServiceAcrConfiguration' authenticationConfiguration: description: Fhir Service authentication configuration. $ref: '#/definitions/FhirServiceAuthenticationConfiguration' corsConfiguration: description: Fhir Service Cors configuration. $ref: '#/definitions/FhirServiceCorsConfiguration' exportConfiguration: description: Fhir Service export configuration. $ref: '#/definitions/FhirServiceExportConfiguration' privateEndpointConnections: description: The list of private endpoint connections that are set up for this resource. type: array items: $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection readOnly: true publicNetworkAccess: description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. $ref: '#/definitions/ResourcePublicNetworkAccess' eventState: description: Fhir Service event support status. $ref: '#/definitions/ResourceEventState' resourceVersionPolicyConfiguration: description: Determines tracking of history for resources. $ref: '#/definitions/ResourceVersionPolicyConfiguration' importConfiguration: description: Fhir Service import configuration. $ref: '#/definitions/FhirServiceImportConfiguration' implementationGuidesConfiguration: description: Implementation Guides configuration. $ref: '#/definitions/ImplementationGuidesConfiguration' encryption: description: The encryption settings of the FHIR service $ref: '#/definitions/Encryption' FhirService: type: object description: The description of Fhir Service allOf: - $ref: '#/definitions/TaggedResource' - $ref: '#/definitions/ServiceManagedIdentity' properties: kind: readOnly: false type: string description: The kind of the service. enum: - fhir-Stu3 - fhir-R4 x-ms-enum: name: fhirServiceKind modelAsString: true properties: description: Fhir Service configuration. $ref: '#/definitions/FhirServiceProperties' x-ms-client-flatten: true systemData: description: Metadata pertaining to creation and last modification of the resource. $ref: '#/definitions/systemData' FhirServiceAuthenticationConfiguration: description: Authentication configuration information type: object properties: authority: type: string description: The authority url for the service readOnly: false audience: type: string description: The audience url for the service readOnly: false smartProxyEnabled: type: boolean description: If the SMART on FHIR proxy is enabled readOnly: false smartIdentityProviders: type: array description: The array of identity provider configurations for SMART on FHIR authentication. readOnly: false items: $ref: '#/definitions/SmartIdentityProviderConfiguration' x-ms-identifiers: [] FhirResourceVersionPolicy: type: string description: Controls how resources are versioned on the FHIR service enum: - no-version - versioned - versioned-update x-ms-enum: name: FhirResourceVersionPolicy modelAsString: true SmartIdentityProviderConfiguration: description: An object to configure an identity provider for use with SMART on FHIR authentication. type: object properties: authority: description: The identity provider token authority also known as the token issuing authority. type: string applications: type: array description: The array of identity provider applications for SMART on FHIR authentication. readOnly: false items: $ref: '#/definitions/SmartIdentityProviderApplication' x-ms-identifiers: [] FhirServicePatchResource: type: object description: FhirService patch properties allOf: - $ref: '#/definitions/ResourceTags' - $ref: '#/definitions/ServiceManagedIdentity' SmartIdentityProviderApplication: description: An Application configured in the Identity Provider used to access FHIR resources. type: object properties: clientId: description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. type: string audience: description: The audience that will be used to validate bearer tokens against the given authority. type: string allowedDataActions: description: The actions that are permitted to be performed on FHIR resources for the application. type: array items: $ref: '#/definitions/SmartDataActions' FhirServiceCollection: description: A collection of Fhir services. type: object properties: nextLink: description: The link used to get the next page of Fhir Services. type: string value: description: The list of Fhir Services. type: array items: $ref: '#/definitions/FhirService' ServiceOciArtifactEntry: description: An Open Container Initiative (OCI) artifact. type: object properties: loginServer: description: The Azure Container Registry login server. type: string imageName: description: The artifact name. type: string digest: description: The artifact digest. type: string ServiceManagedIdentity: type: object description: Managed service identity (system assigned and/or user assigned identities) properties: identity: type: object description: Setting indicating whether the service has a managed identity associated with it. properties: type: description: Type of identity being specified, currently SystemAssigned and None are allowed. type: string enum: - None - SystemAssigned - UserAssigned - SystemAssigned,UserAssigned x-ms-enum: name: ServiceManagedIdentityType modelAsString: true principalId: readOnly: true format: uuid type: string description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. tenantId: readOnly: true format: uuid type: string description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. userAssignedIdentities: $ref: '#/definitions/UserAssignedIdentities' required: - type ErrorDetailsInternal: description: Error details. type: object properties: code: description: The error code. type: string readOnly: true message: description: The error message. type: string readOnly: true target: description: The target of the particular error. type: string readOnly: true LocationBasedResource: type: object description: The common properties for any location based resource, tracked or proxy. allOf: - $ref: '#/definitions/ResourceCore' properties: location: type: string description: The resource location. x-ms-mutability: - create - read x-ms-azure-resource: true FhirServiceImportConfiguration: description: Import operation configuration information type: object properties: integrationDataStore: type: string description: The name of the default integration storage account. readOnly: false initialImportMode: type: boolean description: If the FHIR service is in InitialImportMode. readOnly: false enabled: type: boolean description: If the import operation is enabled. readOnly: false FhirServiceAcrConfiguration: description: Azure container registry configuration information type: object properties: loginServers: type: array description: The list of the Azure container registry login servers. readOnly: false items: type: string ociArtifacts: type: array description: The list of Open Container Initiative (OCI) artifacts. readOnly: false items: $ref: '#/definitions/ServiceOciArtifactEntry' x-ms-identifiers: [] Encryption: description: Settings to encrypt a service type: object properties: customerManagedKeyEncryption: type: object description: The encryption settings for the customer-managed key readOnly: false properties: keyEncryptionKeyUrl: type: string description: The URL of the key to use for encryption readOnly: false FhirServiceExportConfiguration: description: Export operation configuration information type: object properties: storageAccountName: type: string description: The name of the default export storage account. readOnly: false UserAssignedIdentity: type: object description: User assigned identity properties properties: principalId: description: The principal ID of the assigned identity. format: uuid type: string readOnly: true clientId: description: The client ID of the assigned identity. format: uuid type: string readOnly: true ResourceTags: type: object description: List of key value pairs that describe the resource. This will overwrite the existing tags. properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. CorsConfigurationHeaderEntry: description: A header for CORS. type: string CorsConfigurationMethodEntry: description: A method for CORS. type: string Error: description: Error details. type: object properties: error: description: Error details $ref: '#/definitions/ErrorDetailsInternal' ResourceVersionPolicyConfiguration: description: The settings for history tracking for FHIR resources. type: object properties: default: description: The default value for tracking history across all resources. $ref: '#/definitions/FhirResourceVersionPolicy' resourceTypeOverrides: description: A list of FHIR Resources and their version policy overrides. type: object additionalProperties: $ref: '#/definitions/FhirResourceVersionPolicy' SmartDataActions: type: string description: The Data Actions that can be enabled for a Smart Identity Provider Application. enum: - Read x-ms-enum: name: SmartDataActions modelAsString: true TaggedResource: type: object description: The common properties of tracked resources in the service. allOf: - $ref: '#/definitions/ResourceTags' - $ref: '#/definitions/LocationBasedResource' x-ms-azure-resource: true ResourcePublicNetworkAccess: description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. enum: - Enabled - Disabled type: string x-ms-enum: name: PublicNetworkAccess modelAsString: true readOnly: true ProvisioningState: description: The provisioning state. enum: - Deleting - Succeeded - Creating - Accepted - Verifying - Updating - Failed - Canceled - Deprovisioned - Moving - Suspended - Warned - SystemMaintenance type: string readOnly: true x-ms-enum: name: provisioningState modelAsString: true UserAssignedIdentities: title: User-Assigned Identities description: 'The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.' type: object additionalProperties: $ref: '#/definitions/UserAssignedIdentity' ImplementationGuidesConfiguration: description: The settings for Implementation Guides - defining capabilities for national standards, vendor consortiums, clinical societies, etc. type: object properties: usCoreMissingData: type: boolean description: If US Core Missing Data requirement is enabled. readOnly: false ResourceCore: type: object description: The common properties for any resource, tracked or proxy. properties: id: readOnly: true type: string description: The resource identifier. name: readOnly: true type: string description: The resource name. pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$ type: readOnly: true type: string description: The resource type. etag: description: An etag associated with the resource, used for optimistic concurrency when editing it. type: string x-ms-azure-resource: true ResourceEventState: type: string description: Indicates the current status of event support for the resource. enum: - Disabled - Enabled - Updating x-ms-enum: name: ServiceEventState modelAsString: true readOnly: true systemData: description: Metadata pertaining to creation and last modification of the resource. type: object readOnly: true properties: createdBy: type: string description: The identity that created the resource. createdByType: type: string description: The type of identity that created the resource. enum: - User - Application - ManagedIdentity - Key x-ms-enum: name: createdByType modelAsString: true createdAt: type: string format: date-time description: The timestamp of resource creation (UTC). lastModifiedBy: type: string description: The identity that last modified the resource. lastModifiedByType: type: string description: The type of identity that last modified the resource. enum: - User - Application - ManagedIdentity - Key x-ms-enum: name: createdByType modelAsString: true lastModifiedAt: type: string format: date-time description: The timestamp of resource last modification (UTC) parameters: fhirServiceName: name: fhirServiceName in: path required: true type: string description: The name of FHIR Service resource. x-ms-parameter-location: method minLength: 3 maxLength: 24 resourceGroupName: name: resourceGroupName in: path description: The name of the resource group that contains the service instance. required: true type: string x-ms-parameter-location: method pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 workspaceName: name: workspaceName in: path required: true type: string description: The name of workspace resource. x-ms-parameter-location: method minLength: 3 maxLength: 24 securityDefinitions: AadToken: type: oauth2 description: The Azure Active Directory OAuth2 Flow flow: accessCode authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scopes: https://deid.azure.com/.default: '' tokenUrl: https://login.microsoftonline.com/common/oauth2/token x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - name: endpoint in: path description: Url of your De-identification Service. required: true type: string format: uri x-ms-skip-url-encoding: true