openapi: 3.0.0 info: version: '2017-07-01' x-release: v4 title: Amazon HealthLake description: 'AWS HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: healthlake x-aws-signingName: healthlake x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/healthlake-2017-07-01.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/healthlake/' servers: - url: 'http://healthlake.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The HealthLake multi-region endpoint - url: 'https://healthlake.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The HealthLake multi-region endpoint - url: 'http://healthlake.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The HealthLake endpoint for China (Beijing) and China (Ningxia) - url: 'https://healthlake.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The HealthLake endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#X-Amz-Target=HealthLake.CreateFHIRDatastore: post: operationId: CreateFHIRDatastore description: Creates a data store that can ingest and export FHIR formatted data. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFHIRDatastoreResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFHIRDatastoreRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.CreateFHIRDatastore summary: Amazon HealthLake Create FHIR Datastore x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.DeleteFHIRDatastore: post: operationId: DeleteFHIRDatastore description: 'Deletes a data store. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFHIRDatastoreResponse' '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteFHIRDatastoreRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.DeleteFHIRDatastore summary: Amazon HealthLake Delete FHIR Datastore x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.DescribeFHIRDatastore: post: operationId: DescribeFHIRDatastore description: 'Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store''s endpoint.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFHIRDatastoreResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeFHIRDatastoreRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.DescribeFHIRDatastore summary: Amazon HealthLake Describe FHIR Datastore x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.DescribeFHIRExportJob: post: operationId: DescribeFHIRExportJob description: 'Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFHIRExportJobResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeFHIRExportJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.DescribeFHIRExportJob summary: Amazon HealthLake Describe FHIR Export Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.DescribeFHIRImportJob: post: operationId: DescribeFHIRImportJob description: 'Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFHIRImportJobResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeFHIRImportJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.DescribeFHIRImportJob summary: Amazon HealthLake Describe FHIR Import Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.ListFHIRDatastores: post: operationId: ListFHIRDatastores description: 'Lists all FHIR data stores that are in the user’s account, regardless of data store status.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFHIRDatastoresResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListFHIRDatastoresRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.ListFHIRDatastores summary: Amazon HealthLake List FHIR Datastores x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.ListFHIRExportJobs: post: operationId: ListFHIRExportJobs description: ' Lists all FHIR export jobs associated with an account and their statuses. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFHIRExportJobsResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListFHIRExportJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.ListFHIRExportJobs summary: Amazon HealthLake List FHIR Export Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.ListFHIRImportJobs: post: operationId: ListFHIRImportJobs description: ' Lists all FHIR import jobs associated with an account and their statuses. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFHIRImportJobsResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListFHIRImportJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.ListFHIRImportJobs summary: Amazon HealthLake List FHIR Import Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.ListTagsForResource: post: operationId: ListTagsForResource description: ' Returns a list of all existing tags associated with a data store. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.ListTagsForResource summary: Amazon HealthLake List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.StartFHIRExportJob: post: operationId: StartFHIRExportJob description: Begins a FHIR export job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartFHIRExportJobResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartFHIRExportJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.StartFHIRExportJob summary: Amazon HealthLake Start FHIR Export Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.StartFHIRImportJob: post: operationId: StartFHIRImportJob description: Begins a FHIR Import job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartFHIRImportJobResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartFHIRImportJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.StartFHIRImportJob summary: Amazon HealthLake Start FHIR Import Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.TagResource: post: operationId: TagResource description: ' Adds a user specified key and value tag to a data store. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.TagResource summary: Amazon HealthLake Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=HealthLake.UntagResource: post: operationId: UntagResource description: ' Removes tags from a data store. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UntagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - HealthLake.UntagResource summary: Amazon HealthLake Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: CreateFHIRDatastoreResponse: type: object required: - DatastoreId - DatastoreArn - DatastoreStatus - DatastoreEndpoint properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS-generated data store id. This id is in the output from the initial data store creation call. DatastoreArn: allOf: - $ref: '#/components/schemas/DatastoreArn' - description: The data store ARN is generated during the creation of the data store and can be found in the output from the initial data store creation call. DatastoreStatus: allOf: - $ref: '#/components/schemas/DatastoreStatus' - description: The status of the FHIR data store. DatastoreEndpoint: allOf: - $ref: '#/components/schemas/BoundedLengthString' - description: The AWS endpoint for the created data store. CreateFHIRDatastoreRequest: type: object required: - DatastoreTypeVersion title: CreateFHIRDatastoreRequest properties: DatastoreName: allOf: - $ref: '#/components/schemas/DatastoreName' - description: The user generated name for the data store. DatastoreTypeVersion: allOf: - $ref: '#/components/schemas/FHIRVersion' - description: The FHIR version of the data store. The only supported version is R4. SseConfiguration: allOf: - $ref: '#/components/schemas/SseConfiguration' - description: ' The server-side encryption key configuration for a customer provided encryption key specified for creating a data store. ' PreloadDataConfig: allOf: - $ref: '#/components/schemas/PreloadDataConfig' - description: 'Optional parameter to preload data upon creation of the data store. Currently, the only supported preloaded data is synthetic data generated from Synthea.' ClientToken: allOf: - $ref: '#/components/schemas/ClientTokenString' - description: Optional user provided token used for ensuring idempotency. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: ' Resource tags that are applied to a data store when it is created. ' IdentityProviderConfiguration: allOf: - $ref: '#/components/schemas/IdentityProviderConfiguration' - description: The configuration of the identity provider that you want to use for your data store. ValidationException: {} ThrottlingException: {} AccessDeniedException: {} InternalServerException: {} DeleteFHIRDatastoreResponse: type: object required: - DatastoreId - DatastoreArn - DatastoreStatus - DatastoreEndpoint properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS-generated ID for the data store to be deleted. DatastoreArn: allOf: - $ref: '#/components/schemas/DatastoreArn' - description: The Amazon Resource Name (ARN) that gives AWS HealthLake access permission. DatastoreStatus: allOf: - $ref: '#/components/schemas/DatastoreStatus' - description: 'The status of the data store that the user has requested to be deleted. ' DatastoreEndpoint: allOf: - $ref: '#/components/schemas/BoundedLengthString' - description: The AWS endpoint for the data store the user has requested to be deleted. DeleteFHIRDatastoreRequest: type: object required: - DatastoreId title: DeleteFHIRDatastoreRequest properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: ' The AWS-generated ID for the data store to be deleted.' ConflictException: {} ResourceNotFoundException: {} DescribeFHIRDatastoreResponse: type: object required: - DatastoreProperties properties: DatastoreProperties: allOf: - $ref: '#/components/schemas/DatastoreProperties' - description: 'All properties associated with a data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store''s endpoint.' DescribeFHIRDatastoreRequest: type: object required: - DatastoreId title: DescribeFHIRDatastoreRequest properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS-generated data store ID. DescribeFHIRExportJobResponse: type: object required: - ExportJobProperties properties: ExportJobProperties: allOf: - $ref: '#/components/schemas/ExportJobProperties' - description: 'Displays the properties of the export job, including the ID, Arn, Name, and the status of the job. ' DescribeFHIRExportJobRequest: type: object required: - DatastoreId - JobId title: DescribeFHIRExportJobRequest properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS generated ID for the data store from which files are being exported from for an export job. JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The AWS generated ID for an export job. DescribeFHIRImportJobResponse: type: object required: - ImportJobProperties properties: ImportJobProperties: allOf: - $ref: '#/components/schemas/ImportJobProperties' - description: 'The properties of the Import job request, including the ID, ARN, name, and the status of the job.' DescribeFHIRImportJobRequest: type: object required: - DatastoreId - JobId title: DescribeFHIRImportJobRequest properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS-generated ID of the data store. JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The AWS-generated job ID. ListFHIRDatastoresResponse: type: object required: - DatastorePropertiesList properties: DatastorePropertiesList: allOf: - $ref: '#/components/schemas/DatastorePropertiesList' - description: All properties associated with the listed data stores. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Pagination token that can be used to retrieve the next page of results. ListFHIRDatastoresRequest: type: object title: ListFHIRDatastoresRequest properties: Filter: allOf: - $ref: '#/components/schemas/DatastoreFilter' - description: Lists all filters associated with a FHIR data store request. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Fetches the next page of data stores when results are paginated. MaxResults: allOf: - $ref: '#/components/schemas/MaxResultsInteger' - description: The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call. ListFHIRExportJobsResponse: type: object required: - ExportJobPropertiesList properties: ExportJobPropertiesList: allOf: - $ref: '#/components/schemas/ExportJobPropertiesList' - description: ' The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job. ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. ' ListFHIRExportJobsRequest: type: object required: - DatastoreId title: ListFHIRExportJobsRequest properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: ' This parameter limits the response to the export job with the specified data store ID. ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. ' MaxResults: allOf: - $ref: '#/components/schemas/MaxResultsInteger' - description: ' This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user. ' JobName: allOf: - $ref: '#/components/schemas/JobName' - description: ' This parameter limits the response to the export job with the specified job name. ' JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: ' This parameter limits the response to the export jobs with the specified job status. ' SubmittedBefore: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' This parameter limits the response to FHIR export jobs submitted before a user specified date. ' SubmittedAfter: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' This parameter limits the response to FHIR export jobs submitted after a user specified date. ' ListFHIRImportJobsResponse: type: object required: - ImportJobPropertiesList properties: ImportJobPropertiesList: allOf: - $ref: '#/components/schemas/ImportJobPropertiesList' - description: ' The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job. ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. ' ListFHIRImportJobsRequest: type: object required: - DatastoreId title: ListFHIRImportJobsRequest properties: DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: ' This parameter limits the response to the import job with the specified data store ID. ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. ' MaxResults: allOf: - $ref: '#/components/schemas/MaxResultsInteger' - description: ' This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user. ' JobName: allOf: - $ref: '#/components/schemas/JobName' - description: ' This parameter limits the response to the import job with the specified job name. ' JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: ' This parameter limits the response to the import job with the specified job status. ' SubmittedBefore: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' This parameter limits the response to FHIR import jobs submitted before a user specified date. ' SubmittedAfter: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' This parameter limits the response to FHIR import jobs submitted after a user specified date. ' ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: '#/components/schemas/TagList' - description: ' Returns a list of tags associated with a data store. ' ListTagsForResourceRequest: type: object required: - ResourceARN title: ListTagsForResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: ' The Amazon Resource Name(ARN) of the data store for which tags are being added. ' StartFHIRExportJobResponse: type: object required: - JobId - JobStatus properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The AWS generated ID for an export job. JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: 'The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.' DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS generated ID for the data store from which files are being exported for an export job. StartFHIRExportJobRequest: type: object required: - OutputDataConfig - DatastoreId - DataAccessRoleArn - ClientToken title: StartFHIRExportJobRequest properties: JobName: allOf: - $ref: '#/components/schemas/JobName' - description: The user generated name for an export job. OutputDataConfig: allOf: - $ref: '#/components/schemas/OutputDataConfig' - description: The output data configuration that was supplied when the export job was created. DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS generated ID for the data store from which files are being exported for an export job. DataAccessRoleArn: allOf: - $ref: '#/components/schemas/IamRoleArn' - description: The Amazon Resource Name used during the initiation of the job. ClientToken: allOf: - $ref: '#/components/schemas/ClientTokenString' - description: An optional user provided token used for ensuring idempotency. StartFHIRImportJobResponse: type: object required: - JobId - JobStatus properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The AWS-generated job ID. JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: The status of an import job. DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS-generated data store ID. StartFHIRImportJobRequest: type: object required: - InputDataConfig - JobOutputDataConfig - DatastoreId - DataAccessRoleArn - ClientToken title: StartFHIRImportJobRequest properties: JobName: allOf: - $ref: '#/components/schemas/JobName' - description: The name of the FHIR Import job in the StartFHIRImport job request. InputDataConfig: allOf: - $ref: '#/components/schemas/InputDataConfig' - description: The input properties of the FHIR Import job in the StartFHIRImport job request. JobOutputDataConfig: $ref: '#/components/schemas/OutputDataConfig' DatastoreId: allOf: - $ref: '#/components/schemas/DatastoreId' - description: The AWS-generated data store ID. DataAccessRoleArn: allOf: - $ref: '#/components/schemas/IamRoleArn' - description: The Amazon Resource Name (ARN) that gives AWS HealthLake access permission. ClientToken: allOf: - $ref: '#/components/schemas/ClientTokenString' - description: Optional user provided token used for ensuring idempotency. TagResourceResponse: type: object properties: {} TagResourceRequest: type: object required: - ResourceARN - Tags title: TagResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: ' The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to. ' Tags: allOf: - $ref: '#/components/schemas/TagList' - description: ' The user specified key and value pair tags being added to a data store. ' UntagResourceResponse: type: object properties: {} UntagResourceRequest: type: object required: - ResourceARN - TagKeys title: UntagResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name(ARN) of the data store for which tags are being removed. TagKeys: allOf: - $ref: '#/components/schemas/TagKeyList' - description: ' The keys for the tags to be removed from the HealthLake data store. ' AmazonResourceName: type: string pattern: '^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-z0-9-]+:\d{12}:datastore\/fhir\/.{32}' minLength: 1 maxLength: 1011 AuthorizationStrategy: type: string enum: - SMART_ON_FHIR_V1 - AWS_AUTH Boolean: type: boolean BoundedLengthString: type: string pattern: '[\P{M}\p{M}]{1,5000}' minLength: 1 maxLength: 5000 ClientTokenString: type: string pattern: '^[a-zA-Z0-9-]+$' minLength: 1 maxLength: 64 CmkType: type: string enum: - CUSTOMER_MANAGED_KMS_KEY - AWS_OWNED_KMS_KEY ConfigurationMetadata: type: string DatastoreName: type: string pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$' minLength: 1 maxLength: 256 FHIRVersion: type: string enum: - R4 SseConfiguration: type: object required: - KmsEncryptionConfig properties: KmsEncryptionConfig: allOf: - $ref: '#/components/schemas/KmsEncryptionConfig' - description: ' The KMS encryption configuration used to provide details for data encryption. ' description: ' The server-side encryption key configuration for a customer provided encryption key. ' PreloadDataConfig: type: object required: - PreloadDataType properties: PreloadDataType: allOf: - $ref: '#/components/schemas/PreloadDataType' - description: The type of preloaded data. Only Synthea preloaded data is supported. description: ' The input properties for the preloaded data store. Only data preloaded from Synthea is supported.' TagList: type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 200 IdentityProviderConfiguration: type: object required: - AuthorizationStrategy properties: AuthorizationStrategy: allOf: - $ref: '#/components/schemas/AuthorizationStrategy' - description: The authorization strategy that you selected when you created the data store. FineGrainedAuthorizationEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: If you enabled fine-grained authorization when you created the data store. Metadata: allOf: - $ref: '#/components/schemas/ConfigurationMetadata' - description: '
The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART''s App Launch specification.
authorization_endpoint: The URL to the OAuth2 authorization endpoint.
grant_types_supported: An array of grant types that are supported at the token endpoint.
You must provide at least one grant type option. Valid options are authorization_code and client_credentials.
token_endpoint: The URL to the
OAuth2 token endpoint.
capabilities: An array of strings of the SMART capabilities that the authorization server supports.
code_challenge_methods_supported:
An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.