{ "smithy": "2.0", "shapes": { "com.amazonaws.connecthealth#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

This error is thrown when the client does not supply proper credentials to the API.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.connecthealth#ActivateSubscription": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#ActivateSubscriptionInput" }, "output": { "target": "com.amazonaws.connecthealth#ActivateSubscriptionOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "smithy.api#documentation": "

Activates a Subscription to enable billing for a user.

", "smithy.api#http": { "method": "POST", "uri": "/domains/{domainId}/subscriptions/{subscriptionId}/activate", "code": 200 } } }, "com.amazonaws.connecthealth#ActivateSubscriptionInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "domainId" } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The unique identifier of the Subscription.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "subscriptionId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#ActivateSubscriptionOutput": { "type": "structure", "members": { "subscription": { "target": "com.amazonaws.connecthealth#SubscriptionDescription", "traits": { "smithy.api#documentation": "

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#ArtifactDetails": { "type": "structure", "members": { "outputLocation": { "target": "com.amazonaws.connecthealth#Uri", "traits": { "smithy.api#documentation": "

" } }, "status": { "target": "com.amazonaws.connecthealth#PostStreamArtifactGenerationStatus", "traits": { "smithy.api#documentation": "

The generation status of the artifact

" } }, "failureReason": { "target": "com.amazonaws.connecthealth#ErrorMessage", "traits": { "smithy.api#documentation": "

The reason for failure if the artifact generation failed

" } } }, "traits": { "smithy.api#documentation": "

Details about a generated artifact including location and status

" } }, "com.amazonaws.connecthealth#ArtifactSourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" } }, "com.amazonaws.connecthealth#AudioChunk": { "type": "blob" }, "com.amazonaws.connecthealth#AudioOffset": { "type": "double" }, "com.amazonaws.connecthealth#BoundedSafeString": { "type": "string", "traits": { "smithy.api#documentation": "A bounded, safe-character string used for human-readable names and descriptions.", "smithy.api#length": { "min": 1, "max": 1028 }, "smithy.api#pattern": "^[\\x20-\\x21\\x23\\x24\\x2A-\\x3A\\x3F-\\x7E]*$" } }, "com.amazonaws.connecthealth#Checklist": { "type": "structure", "members": { "checklistId": { "target": "com.amazonaws.connecthealth#ChecklistId", "traits": { "smithy.api#documentation": "

The identifier of the checklist. For a managed note template, this value is the template type, such as HISTORY_AND_PHYSICAL. For a custom note template, this value is CUSTOM_ followed by the template base, such as CUSTOM_GIRPP.

", "smithy.api#required": {} } }, "items": { "target": "com.amazonaws.connecthealth#ChecklistItemList", "traits": { "smithy.api#documentation": "

The checklist items in template order. The list contains one item for each checklist section, including sections that have not been discussed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the sections of a note template checklist and the discussion status of each section.

" } }, "com.amazonaws.connecthealth#ChecklistId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.connecthealth#ChecklistItem": { "type": "structure", "members": { "itemKey": { "target": "com.amazonaws.connecthealth#ChecklistItemKey", "traits": { "smithy.api#documentation": "

The key that uniquely identifies the item within the checklist. For a managed note template, this value is a service-defined section key, such as CHIEF_COMPLAINT. For a custom note template, this value is the sectionHeader of the section that you defined.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#ChecklistItemStatus", "traits": { "smithy.api#documentation": "

The discussion status of the checklist item. The following values are valid:

The status usually progresses toward DISCUSSED, but it can return to NOT_DISCUSSED if a speaker retracts a statement.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains a checklist item and its discussion status.

" } }, "com.amazonaws.connecthealth#ChecklistItemKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#ChecklistItemList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#ChecklistItem" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.connecthealth#ChecklistItemStatus": { "type": "enum", "members": { "DISCUSSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISCUSSED" } }, "PARTIALLY_DISCUSSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIALLY_DISCUSSED" } }, "NOT_DISCUSSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_DISCUSSED" } } } }, "com.amazonaws.connecthealth#ChecklistList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#Checklist" }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.connecthealth#ClinicalNoteGenerationResult": { "type": "structure", "members": { "noteResult": { "target": "com.amazonaws.connecthealth#ArtifactDetails", "traits": { "smithy.api#documentation": "

Details about the generated clinical note

" } }, "transcriptResult": { "target": "com.amazonaws.connecthealth#ArtifactDetails", "traits": { "smithy.api#documentation": "

Details about the generated transcript

" } }, "afterVisitSummaryResult": { "target": "com.amazonaws.connecthealth#ArtifactDetails", "traits": { "smithy.api#documentation": "

Details about the generated after visit summary

" } } }, "traits": { "smithy.api#documentation": "

Results of clinical note generation including note, transcript, and summary

" } }, "com.amazonaws.connecthealth#ClinicalNoteGenerationSettings": { "type": "structure", "members": { "noteTemplateSettings": { "target": "com.amazonaws.connecthealth#NoteTemplateSettings", "traits": { "smithy.api#documentation": "

Settings for the note template to use

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Settings for generating clinical notes from the audio stream

" } }, "com.amazonaws.connecthealth#ClinicalNoteGenerationSettingsResponse": { "type": "structure", "members": { "noteTemplateSettings": { "target": "com.amazonaws.connecthealth#NoteTemplateSettingsResponse", "traits": { "smithy.api#documentation": "

Settings for the note template used

" } } }, "traits": { "smithy.api#documentation": "

Response containing settings for clinical note generation

" } }, "com.amazonaws.connecthealth#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

This error is thrown when a resource update is no longer valid due to assumptions about initial state changing.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.connecthealth#ConnectHealth": { "type": "service", "version": "2025-01-29", "operations": [ { "target": "com.amazonaws.connecthealth#ActivateSubscription" }, { "target": "com.amazonaws.connecthealth#CreateDataset" }, { "target": "com.amazonaws.connecthealth#CreateDomain" }, { "target": "com.amazonaws.connecthealth#CreateSubscription" }, { "target": "com.amazonaws.connecthealth#DeactivateSubscription" }, { "target": "com.amazonaws.connecthealth#DeleteDataset" }, { "target": "com.amazonaws.connecthealth#DeleteDomain" }, { "target": "com.amazonaws.connecthealth#GetDataset" }, { "target": "com.amazonaws.connecthealth#GetDomain" }, { "target": "com.amazonaws.connecthealth#GetMedicalCodingJob" }, { "target": "com.amazonaws.connecthealth#GetMedicalScribeListeningSession" }, { "target": "com.amazonaws.connecthealth#GetPatientInsightsJob" }, { "target": "com.amazonaws.connecthealth#GetSubscription" }, { "target": "com.amazonaws.connecthealth#ListDatasets" }, { "target": "com.amazonaws.connecthealth#ListDomains" }, { "target": "com.amazonaws.connecthealth#ListSubscriptions" }, { "target": "com.amazonaws.connecthealth#ListTagsForResource" }, { "target": "com.amazonaws.connecthealth#StartMedicalCodingJob" }, { "target": "com.amazonaws.connecthealth#StartMedicalScribeListeningSession" }, { "target": "com.amazonaws.connecthealth#StartPatientInsightsJob" }, { "target": "com.amazonaws.connecthealth#SubmitFeedback" }, { "target": "com.amazonaws.connecthealth#TagResource" }, { "target": "com.amazonaws.connecthealth#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "ConnectHealth", "arnNamespace": "health-agent", "endpointPrefix": "health-agent", "cloudTrailEventSource": "health-agent.amazonaws.com" }, "aws.auth#sigv4": { "name": "health-agent" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": { "http": [ "h2", "http/1.1" ], "eventStreamHttp": [ "h2" ] }, "smithy.api#cors": { "origin": "*", "additionalAllowedHeaders": [ "*", "content-type", "content-length", "authorization", "x-amz-date", "x-amz-security-token", "x-amz-content-sha256", "x-amz-user-agent", "x-api-key" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id", "Access-Control-Allow-Origin" ], "maxAge": 86400 }, "smithy.api#documentation": "

Amazon Connect Health is an AI-powered healthcare service built on Amazon Connect. It provides pre-built agents that automate patient engagement workflows and support clinical documentation at the point of care.

You can use the Amazon Connect Health API to programmatically manage domains, configure patient engagement agents, run patient insights jobs, and stream ambient documentation sessions. This API reference describes the available API operations and data types for Amazon Connect Health.

We recommend that you use the AWS SDKs to make programmatic API calls to Amazon Connect Health.

", "smithy.api#title": "Connect Health", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://health-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://health-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://health-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://health-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-agent-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-agent.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-agent-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-agent.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-agent-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-agent.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.connecthealth#CreateDataset": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#CreateDatasetInput" }, "output": { "target": "com.amazonaws.connecthealth#CreateDatasetOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#ConflictException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.iam#iamAction": { "resources": { "required": { "Domain": {}, "Dataset": {} } } }, "smithy.api#documentation": "

Creates a Dataset in a Domain and starts building it. A new dataset has the status CREATING. When it's ready to use, its status changes to ACTIVE, or to CREATE_FAILED if it fails to build. To check the status, call GetDataset.

This operation is idempotent: if you retry a request with the same clientToken, it returns the dataset that the first request created.

For a medical coding dataset, Amazon Connect Health uses the coded examples that are in the s3InputPath when you create the dataset, and writes evaluation scores to the s3OutputPath. Later changes to the s3InputPath don't change the dataset. To use this operation, you must have s3:GetObject and s3:ListBucket permissions for the input location and s3:PutObject permission for the output location, and kms:Decrypt and kms:GenerateDataKey permissions if you encrypt the locations with an AWS KMS key.

Datasets are in preview release and are subject to change.

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/domains/{domainId}/datasets" } } }, "com.amazonaws.connecthealth#CreateDatasetInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connecthealth#BoundedSafeString", "traits": { "smithy.api#documentation": "

A name for the dataset.

", "smithy.api#required": {} } }, "config": { "target": "com.amazonaws.connecthealth#DatasetConfig", "traits": { "smithy.api#documentation": "

The configuration of the dataset. The member that you set determines the dataset type. You can't change the configuration after you create the dataset.

", "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation returns the dataset that the first request created. If you reuse a clientToken with different parameters, the request fails with ConflictException. Use a new clientToken for a request with different parameters.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#notProperty": {}, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#CreateDatasetOutput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connecthealth#DatasetArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of the dataset.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connecthealth#DatasetType", "traits": { "smithy.api#documentation": "

The type of the dataset, determined by the configuration that you provided.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#DatasetStatus", "traits": { "smithy.api#documentation": "

The status of the dataset. A new dataset has the status CREATING.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the dataset was created.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#CreateDomain": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#CreateDomainInput" }, "output": { "target": "com.amazonaws.connecthealth#CreateDomainOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#ServiceQuotaExceededException" } ], "traits": { "aws.iam#requiredActions": [ "health-agent:TagResource", "iam:PassRole" ], "smithy.api#documentation": "

Creates a new Domain for managing HealthAgent resources.

", "smithy.api#http": { "method": "POST", "uri": "/domain", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.connecthealth#CreateDomainInput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.connecthealth#DomainName", "traits": { "smithy.api#documentation": "

The name for the new Domain.

", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.connecthealth#KmsKeyArn", "traits": { "smithy.api#documentation": "

The ARN of the KMS key to use for encrypting data in this Domain.

" } }, "webAppSetupConfiguration": { "target": "com.amazonaws.connecthealth#CreateWebAppConfiguration", "traits": { "smithy.api#documentation": "

Configuration for the Domain web application. Optional, but if provided all fields are required.

", "smithy.api#notProperty": {} } }, "tags": { "target": "com.amazonaws.connecthealth#TagMap", "traits": { "smithy.api#documentation": "

Tags to associate with the Domain.

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#CreateDomainOutput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.connecthealth#DomainArn", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connecthealth#DomainName", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.connecthealth#KmsKeyArn", "traits": { "smithy.api#documentation": "

" } }, "encryptionContext": { "target": "com.amazonaws.connecthealth#EncryptionContext", "traits": { "smithy.api#documentation": "

" } }, "status": { "target": "com.amazonaws.connecthealth#DomainStatus", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "webAppUrl": { "target": "com.amazonaws.connecthealth#WebAppUrl", "traits": { "smithy.api#documentation": "

" } }, "webAppConfiguration": { "target": "com.amazonaws.connecthealth#WebAppConfiguration", "traits": { "smithy.api#documentation": "

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#CreateSubscription": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#CreateSubscriptionInput" }, "output": { "target": "com.amazonaws.connecthealth#CreateSubscriptionOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a new Subscription within a Domain for billing and user management.

", "smithy.api#http": { "method": "POST", "uri": "/domains/{domainId}/subscriptions", "code": 201 } } }, "com.amazonaws.connecthealth#CreateSubscriptionInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#CreateSubscriptionOutput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "domainId" } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "subscriptionId" } }, "arn": { "target": "com.amazonaws.connecthealth#SubscriptionArn", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#SubscriptionStatus", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "activatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

" } }, "deactivatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#CreateWebAppConfiguration": { "type": "structure", "members": { "ehrRole": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

ARN of the IAM role used for EHR operations.

", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/.+$", "smithy.api#required": {} } }, "idcInstanceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Identity Center instance ID to use for creating the application.

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#required": {} } }, "idcRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The AWS region where Identity Center is configured.

", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input configuration for creating a web application. Used only in CreateDomain operation input.

" } }, "com.amazonaws.connecthealth#CustomTemplate": { "type": "structure", "members": { "templateType": { "target": "com.amazonaws.connecthealth#CustomTemplateBase", "traits": { "smithy.api#documentation": "

The base template type to customize

", "smithy.api#required": {} } }, "templateInstructions": { "target": "com.amazonaws.connecthealth#TemplateInstructions", "traits": { "smithy.api#documentation": "

Custom instructions for each section of the template

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration for using a custom note template with specific instructions

" } }, "com.amazonaws.connecthealth#CustomTemplateBase": { "type": "enum", "members": { "HISTORY_AND_PHYSICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HISTORY_AND_PHYSICAL" } }, "GIRPP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GIRPP" } }, "DAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAP" } }, "SIRP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIRP" } }, "BIRP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BIRP" } }, "BEHAVIORAL_SOAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEHAVIORAL_SOAP" } } } }, "com.amazonaws.connecthealth#CustomTemplateResponse": { "type": "structure", "members": { "templateType": { "target": "com.amazonaws.connecthealth#CustomTemplateBase", "traits": { "smithy.api#documentation": "

The base template type that was customized

" } } }, "traits": { "smithy.api#documentation": "

Response containing custom template information

" } }, "com.amazonaws.connecthealth#DatasetArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[a-z\\-]*:[a-z0-9\\-]+:[a-z0-9\\-]*:[0-9]{12}:.+$" } }, "com.amazonaws.connecthealth#DatasetArtifacts": { "type": "union", "members": { "medicalCoding": { "target": "com.amazonaws.connecthealth#MedicalCodingDatasetArtifacts", "traits": { "smithy.api#documentation": "

The results of building a medical coding dataset.

" } } }, "traits": { "smithy.api#documentation": "

The results of building a Dataset, by dataset type.

" } }, "com.amazonaws.connecthealth#DatasetConfig": { "type": "union", "members": { "medicalCoding": { "target": "com.amazonaws.connecthealth#MedicalCodingDatasetConfig", "traits": { "smithy.api#documentation": "

The configuration of a medical coding dataset, which tailors medical coding jobs to your coded examples.

" } } }, "traits": { "smithy.api#documentation": "

The configuration of a Dataset. Set one member, which determines the dataset type.

" } }, "com.amazonaws.connecthealth#DatasetId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a Dataset. System-generated, unique within a domain. Contains only lowercase letters and digits.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]{1,64}$" } }, "com.amazonaws.connecthealth#DatasetStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The dataset is being built.", "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The dataset is ready and can be referenced by feature requests.", "smithy.api#enumValue": "ACTIVE" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Building the dataset failed. Nothing usable was built; delete the dataset to free its quota slot. See statusDetails.", "smithy.api#enumValue": "CREATE_FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The dataset and its provisioned resources are being deleted.", "smithy.api#enumValue": "DELETING" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Deleting the dataset failed partway, so some provisioned resources may remain. Call DeleteDataset again to finish. See statusDetails.", "smithy.api#enumValue": "DELETE_FAILED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The dataset and its provisioned resources have been deleted. Not returned by GetDataset or ListDatasets.", "smithy.api#enumValue": "DELETED" } } }, "traits": { "smithy.api#documentation": "Lifecycle status of a Dataset. CREATING -> ACTIVE | CREATE_FAILED; ACTIVE | CREATE_FAILED | DELETE_FAILED -> DELETING -> DELETED | DELETE_FAILED." } }, "com.amazonaws.connecthealth#DatasetSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connecthealth#DatasetArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of the dataset.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connecthealth#BoundedSafeString", "traits": { "smithy.api#documentation": "

The name of the dataset.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connecthealth#DatasetType", "traits": { "smithy.api#documentation": "

The type of the dataset.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#DatasetStatus", "traits": { "smithy.api#documentation": "

The status of the dataset.

", "smithy.api#required": {} } }, "statusDetails": { "target": "com.amazonaws.connecthealth#BoundedSafeString", "traits": { "smithy.api#documentation": "

Details about the status of the dataset, such as the reason that it failed to build or delete.

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the dataset was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the dataset was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary information about a Dataset.

" } }, "com.amazonaws.connecthealth#DatasetSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#DatasetSummary" }, "traits": { "smithy.api#documentation": "A page of dataset summaries." } }, "com.amazonaws.connecthealth#DatasetType": { "type": "enum", "members": { "MEDICAL_CODING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Coded examples used to tailor medical coding.", "smithy.api#enumValue": "MEDICAL_CODING" } } }, "traits": { "smithy.api#documentation": "The Amazon Connect Health feature a Dataset is for. Set by the service from the DatasetConfig member supplied at create: medicalCoding -> MEDICAL_CODING." } }, "com.amazonaws.connecthealth#DeactivateSubscription": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#DeactivateSubscriptionInput" }, "output": { "target": "com.amazonaws.connecthealth#DeactivateSubscriptionOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deactivates a Subscription to stop billing for a user.

", "smithy.api#http": { "method": "POST", "uri": "/domains/{domainId}/subscriptions/{subscriptionId}/deactivate", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.connecthealth#DeactivateSubscriptionInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "domainId" } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The unique identifier of the Subscription.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "subscriptionId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#DeactivateSubscriptionOutput": { "type": "structure", "members": { "subscription": { "target": "com.amazonaws.connecthealth#SubscriptionDescription", "traits": { "smithy.api#documentation": "

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#DeleteDataset": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#DeleteDatasetInput" }, "output": { "target": "com.amazonaws.connecthealth#DeleteDatasetOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#ConflictException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.iam#iamAction": { "resources": { "required": { "Domain": {}, "Dataset": {} } } }, "smithy.api#documentation": "

Starts deleting a Dataset and the resources that Amazon Connect Health built for it. You can delete a dataset whose status is ACTIVE, CREATE_FAILED, or DELETE_FAILED. The dataset moves to DELETING, and then to DELETED. If the delete fails, the dataset moves to DELETE_FAILED, and you can call DeleteDataset again.

Medical coding jobs that already use the dataset finish. Amazon Connect Health rejects new requests that specify the dataset.

Datasets are in preview release and are subject to change.

", "smithy.api#http": { "code": 202, "method": "DELETE", "uri": "/domains/{domainId}/datasets/{datasetId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connecthealth#DeleteDatasetInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of the dataset to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#DeleteDatasetOutput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connecthealth#DatasetArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of the dataset.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#DatasetStatus", "traits": { "smithy.api#documentation": "

The status of the dataset. After Amazon Connect Health accepts the request, the status is DELETING.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#DeleteDomain": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#DeleteDomainInput" }, "output": { "target": "com.amazonaws.connecthealth#DeleteDomainOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a Domain and all associated resources.

", "smithy.api#http": { "method": "DELETE", "uri": "/domain/{domainId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.connecthealth#DeleteDomainInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The id of the Domain to delete

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#DeleteDomainOutput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The id of the Domain requested for deletion

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.connecthealth#DomainArn", "traits": { "smithy.api#documentation": "

The ARN of the Domain that was requested for deletion

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#DomainStatus", "traits": { "smithy.api#documentation": "

Current status of Domain

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#DomainArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain/(hai-|dom-)[a-z0-9]+$" } }, "com.amazonaws.connecthealth#DomainId": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::HealthAgent::Domain" }, "smithy.api#length": { "min": 20, "max": 25 }, "smithy.api#pattern": "^(hai-|dom-)[a-z0-9]+$" } }, "com.amazonaws.connecthealth#DomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.connecthealth#DomainStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.connecthealth#DomainSummary": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the Domain.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.connecthealth#DomainArn", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connecthealth#DomainName", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#DomainStatus", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the Domain was created.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary information about a Domain.

" } }, "com.amazonaws.connecthealth#DomainSummaryList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#DomainSummary" } }, "com.amazonaws.connecthealth#EncounterContext": { "type": "structure", "members": { "unstructuredContext": { "target": "com.amazonaws.connecthealth#SensitiveMarkdownString", "traits": { "smithy.api#documentation": "

Unstructured context information in markdown format

" } }, "medicalCodingContext": { "target": "com.amazonaws.connecthealth#MedicalCodingContext", "traits": { "smithy.api#documentation": "

Structured patient and encounter context for medical code generation.

" } } }, "traits": { "smithy.api#documentation": "

Context information about the clinical encounter

" } }, "com.amazonaws.connecthealth#EncounterType": { "type": "enum", "members": { "TELEHEALTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TELEHEALTH" } }, "IN_PERSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PERSON" } } } }, "com.amazonaws.connecthealth#EncryptionContext": { "type": "structure", "members": { "encryptionType": { "target": "com.amazonaws.connecthealth#EncryptionType", "traits": { "smithy.api#documentation": "

The type of encryption key used.

", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.connecthealth#KmsKeyArn", "traits": { "smithy.api#documentation": "

The ARN of the KMS key. Only present when encryptionType is CUSTOMER_MANAGED_KEY.

" } } }, "traits": { "smithy.api#documentation": "

Encryption context for a Domain.

" } }, "com.amazonaws.connecthealth#EncryptionType": { "type": "enum", "members": { "AWS_OWNED_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_OWNED_KEY" } }, "CUSTOMER_MANAGED_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" } } } }, "com.amazonaws.connecthealth#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.connecthealth#FHIRServer": { "type": "structure", "members": { "fhirEndpoint": { "target": "com.amazonaws.connecthealth#NonEmptyString", "traits": { "smithy.api#documentation": "

FHIR server endpoint URL for accessing patient data.

", "smithy.api#pattern": "^https?://[a-zA-Z0-9\\-._~:/?#\\[\\]@!$&'()*+,;=%]+$", "smithy.api#required": {} } }, "oauthToken": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

OAuth token for authenticating with the FHIR server.

" } } }, "traits": { "smithy.api#documentation": "

FHIR server configuration for input data source

" } }, "com.amazonaws.connecthealth#FeedbackArtifactType": { "type": "enum", "members": { "CLINICAL_DOC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLINICAL_DOC" } }, "MEDICAL_CODES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDICAL_CODES" } } } }, "com.amazonaws.connecthealth#FeedbackComments": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#GetDataset": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#GetDatasetInput" }, "output": { "target": "com.amazonaws.connecthealth#GetDatasetOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.iam#iamAction": { "resources": { "required": { "Domain": {}, "Dataset": {} } } }, "smithy.api#documentation": "

Retrieves information about a Dataset, including its status and, after it is built, its results. A dataset whose status is DELETED returns ResourceNotFoundException.

Datasets are in preview release and are subject to change.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/domains/{domainId}/datasets/{datasetId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#GetDatasetInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of the dataset.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#GetDatasetOutput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.connecthealth#DatasetArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of the dataset.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connecthealth#BoundedSafeString", "traits": { "smithy.api#documentation": "

The name of the dataset.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connecthealth#DatasetType", "traits": { "smithy.api#documentation": "

The type of the dataset.

", "smithy.api#required": {} } }, "config": { "target": "com.amazonaws.connecthealth#DatasetConfig", "traits": { "smithy.api#documentation": "

The configuration that you provided when you created the dataset.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#DatasetStatus", "traits": { "smithy.api#documentation": "

The status of the dataset.

", "smithy.api#required": {} } }, "statusDetails": { "target": "com.amazonaws.connecthealth#BoundedSafeString", "traits": { "smithy.api#documentation": "

Details about the status of the dataset, such as the reason that it failed to build or delete.

" } }, "artifacts": { "target": "com.amazonaws.connecthealth#DatasetArtifacts", "traits": { "smithy.api#documentation": "

The results of building the dataset, such as medical coding evaluation scores. Available after Amazon Connect Health builds the dataset.

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the dataset was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the dataset was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#GetDomain": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#GetDomainInput" }, "output": { "target": "com.amazonaws.connecthealth#GetDomainOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about a Domain.

", "smithy.api#http": { "method": "GET", "uri": "/domain/{domainId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#GetDomainInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The id of the Domain to get

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#GetDomainOutput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.connecthealth#DomainArn", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.connecthealth#DomainName", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.connecthealth#KmsKeyArn", "traits": { "smithy.api#documentation": "

" } }, "encryptionContext": { "target": "com.amazonaws.connecthealth#EncryptionContext", "traits": { "smithy.api#documentation": "

" } }, "status": { "target": "com.amazonaws.connecthealth#DomainStatus", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "webAppUrl": { "target": "com.amazonaws.connecthealth#WebAppUrl", "traits": { "smithy.api#documentation": "

" } }, "webAppConfiguration": { "target": "com.amazonaws.connecthealth#WebAppConfiguration", "traits": { "smithy.api#documentation": "

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connecthealth#TagMap", "traits": { "smithy.api#documentation": "

Tags associated with the Domain

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#GetMedicalCodingJob": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#GetMedicalCodingJobRequest" }, "output": { "target": "com.amazonaws.connecthealth#GetMedicalCodingJobResponse" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "resources": { "required": { "DomainResource": {}, "MedicalCodingJobResource": {} } } }, "smithy.api#documentation": "

Retrieves information about a medical coding job, including its status and, when it succeeds, the location of its results.

Medical coding jobs are in preview release and are subject to change.

", "smithy.api#endpoint": { "hostPrefix": "runtime." }, "smithy.api#http": { "code": 200, "method": "GET", "uri": "/domain/{domainId}/medical-coding-job/{jobId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#GetMedicalCodingJobRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.connecthealth#JobId", "traits": { "smithy.api#documentation": "

The unique identifier of the medical coding job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#GetMedicalCodingJobResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.connecthealth#JobId", "traits": { "smithy.api#documentation": "

The unique identifier of the medical coding job.

", "smithy.api#required": {} } }, "jobArn": { "target": "com.amazonaws.connecthealth#MedicalCodingJobArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the medical coding job.

", "smithy.api#required": {} } }, "jobStatus": { "target": "com.amazonaws.connecthealth#JobStatus", "traits": { "smithy.api#documentation": "

The status of the medical coding job.

", "smithy.api#required": {} } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the medical coding job was created.

", "smithy.api#timestampFormat": "date-time" } }, "updatedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the medical coding job was last updated.

", "smithy.api#timestampFormat": "date-time" } }, "text": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

The clinical text that the medical coding job codes.

", "smithy.api#required": {} } }, "patientContext": { "target": "com.amazonaws.connecthealth#MedicalCodesPatientContext", "traits": { "smithy.api#documentation": "

The patient context that you provided for the job.

" } }, "encounterContext": { "target": "com.amazonaws.connecthealth#MedicalCodesEncounterContext", "traits": { "smithy.api#documentation": "

The encounter context that you provided for the job.

" } }, "outputDataConfig": { "target": "com.amazonaws.connecthealth#MedicalCodingOutputDataConfig", "traits": { "smithy.api#documentation": "

The output configuration that you provided for the job.

", "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of the dataset that the job codes against. Not returned if the job uses the general medical coding knowledge base.

" } }, "medicalCodingOutput": { "target": "com.amazonaws.connecthealth#MedicalCodingOutput", "traits": { "smithy.api#documentation": "

The location of the job results. Returned when the job succeeds.

" } }, "statusDetails": { "target": "com.amazonaws.connecthealth#NonEmptyString", "traits": { "smithy.api#documentation": "

Details about the status of the job, such as the reason that it failed.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#GetMedicalScribeListeningSession": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#GetMedicalScribeListeningSessionInput" }, "output": { "target": "com.amazonaws.connecthealth#GetMedicalScribeListeningSessionOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Retrieves details about an existing Medical Scribe listening session

", "smithy.api#endpoint": { "hostPrefix": "streaming." }, "smithy.api#http": { "uri": "/medical-scribe-stream/domain/{domainId}/subscription/{subscriptionId}/session/{sessionId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#GetMedicalScribeListeningSessionInput": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.connecthealth#ScribeSessionId", "traits": { "smithy.api#documentation": "

The Session identifier

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The Domain identifier

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The Subscription identifier

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#GetMedicalScribeListeningSessionOutput": { "type": "structure", "members": { "medicalScribeListeningSessionDetails": { "target": "com.amazonaws.connecthealth#MedicalScribeListeningSessionDetails", "traits": { "smithy.api#documentation": "

Details about the Medical Scribe listening session

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#GetPatientInsightsJob": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#GetPatientInsightsJobRequest" }, "output": { "target": "com.amazonaws.connecthealth#GetPatientInsightsJobResponse" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "resources": { "required": { "DomainResource": {}, "PatientInsightsJobResource": {} } } }, "smithy.api#documentation": "

Get details of a started patient insights job.

", "smithy.api#endpoint": { "hostPrefix": "runtime." }, "smithy.api#http": { "code": 200, "method": "GET", "uri": "/domain/{domainId}/patient-insights-job/{jobId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#GetPatientInsightsJobRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.connecthealth#JobId", "traits": { "smithy.api#documentation": "

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#GetPatientInsightsJobResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.connecthealth#JobId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "jobArn": { "target": "com.amazonaws.connecthealth#JobArn", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "jobStatus": { "target": "com.amazonaws.connecthealth#JobStatus", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Date and time the patient insights job was submitted.

", "smithy.api#timestampFormat": "date-time" } }, "updatedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Date and time the patient insights job was last updated.

", "smithy.api#timestampFormat": "date-time" } }, "insightsOutput": { "target": "com.amazonaws.connecthealth#InsightsOutput", "traits": { "smithy.api#documentation": "

" } }, "statusDetails": { "target": "com.amazonaws.connecthealth#NonEmptyString", "traits": { "smithy.api#documentation": "

Contains information about the status of a job.

" } }, "patientContext": { "target": "com.amazonaws.connecthealth#PatientInsightsPatientContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "insightsContext": { "target": "com.amazonaws.connecthealth#InsightsContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "encounterContext": { "target": "com.amazonaws.connecthealth#PatientInsightsEncounterContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "userContext": { "target": "com.amazonaws.connecthealth#UserContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "inputDataConfig": { "target": "com.amazonaws.connecthealth#InputDataConfig", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "outputDataConfig": { "target": "com.amazonaws.connecthealth#OutputDataConfig", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#GetSubscription": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#GetSubscriptionInput" }, "output": { "target": "com.amazonaws.connecthealth#GetSubscriptionOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about a Subscription.

", "smithy.api#http": { "method": "GET", "uri": "/domains/{domainId}/subscriptions/{subscriptionId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#GetSubscriptionInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "domainId" } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The unique identifier of the Subscription.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "subscriptionId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#GetSubscriptionOutput": { "type": "structure", "members": { "subscription": { "target": "com.amazonaws.connecthealth#SubscriptionDescription", "traits": { "smithy.api#documentation": "

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#IdempotencyToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.connecthealth#InputDataConfig": { "type": "structure", "members": { "fhirServer": { "target": "com.amazonaws.connecthealth#FHIRServer", "traits": { "smithy.api#documentation": "

FHIR server configuration to retrieve patient data.

" } }, "s3Sources": { "target": "com.amazonaws.connecthealth#S3Sources", "traits": { "smithy.api#documentation": "

List of S3 sources containing patient data.

" } } }, "traits": { "smithy.api#documentation": "

Configuration details for input patient data

" } }, "com.amazonaws.connecthealth#InsightsContext": { "type": "structure", "members": { "insightsType": { "target": "com.amazonaws.connecthealth#InsightsType", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details for insights that user wants to generate

" } }, "com.amazonaws.connecthealth#InsightsOutput": { "type": "structure", "members": { "uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Output of patient insights job

" } }, "com.amazonaws.connecthealth#InsightsType": { "type": "enum", "members": { "PRE_VISIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_VISIT" } } } }, "com.amazonaws.connecthealth#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

This error is thrown when a transient error causes our API to fail.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.connecthealth#JobArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 200 }, "smithy.api#pattern": "^arn:aws[-a-z]*:health-agent:[-a-z0-9]+:[0-9]{12}:domain/[-a-zA-Z0-9-]+/patient-insights-job/[-a-zA-Z0-9_/.]+$" } }, "com.amazonaws.connecthealth#JobId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 } } }, "com.amazonaws.connecthealth#JobStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBMITTED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } } } }, "com.amazonaws.connecthealth#KmsKeyArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9-]+$" } }, "com.amazonaws.connecthealth#ListDatasets": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#ListDatasetsInput" }, "output": { "target": "com.amazonaws.connecthealth#ListDatasetsOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.iam#iamAction": { "resources": { "required": { "Domain": {} } } }, "smithy.api#documentation": "

Lists the Datasets in a Domain. You can list only the datasets of one type. The operation doesn't return datasets whose status is DELETED, and the order of the results isn't specified. We recommend using pagination to ensure that the operation returns quickly and successfully.

Datasets are in preview release and are subject to change.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/domains/{domainId}/datasets" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#ListDatasetsInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.connecthealth#DatasetType", "traits": { "smithy.api#documentation": "

Returns only datasets of this type.

", "smithy.api#httpQuery": "type", "smithy.api#notProperty": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token for the next page of results, from a previous ListDatasets response. If you don't specify a value, the operation returns the first page of results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum number of datasets to return in one page. The default is 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#notProperty": {}, "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#ListDatasetsOutput": { "type": "structure", "members": { "items": { "target": "com.amazonaws.connecthealth#DatasetSummaryList", "traits": { "smithy.api#documentation": "

A list of dataset summaries.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token for the next page of results. Not returned if there are no more results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#ListDomains": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#ListDomainsInput" }, "output": { "target": "com.amazonaws.connecthealth#ListDomainsOutput" }, "traits": { "smithy.api#documentation": "

Lists Domains for a given account.

", "smithy.api#http": { "method": "GET", "uri": "/domain" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "domains" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListDomainsSuccess", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.connecthealth#ListDomainsInput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.connecthealth#DomainStatus", "traits": { "smithy.api#documentation": "

Filter by Domain status.

", "smithy.api#httpQuery": "status" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Maximum number of results to return.

", "smithy.api#httpQuery": "maxResults", "smithy.api#notProperty": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Token for pagination.

", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#ListDomainsOutput": { "type": "structure", "members": { "domains": { "target": "com.amazonaws.connecthealth#DomainSummaryList", "traits": { "smithy.api#documentation": "

List of Domains.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Token for the next page of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#ListSubscriptions": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#ListSubscriptionsInput" }, "output": { "target": "com.amazonaws.connecthealth#ListSubscriptionsOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all Subscriptions within a Domain.

", "smithy.api#http": { "method": "GET", "uri": "/domains/{domainId}/subscriptions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "subscriptions" }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#ListSubscriptionsInput": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Maximum number of results to return.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Token for pagination.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#ListSubscriptionsOutput": { "type": "structure", "members": { "subscriptions": { "target": "com.amazonaws.connecthealth#SubscriptionList", "traits": { "smithy.api#documentation": "

List of Subscriptions.

", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Token for the next page of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.connecthealth#ListTagsForResourceOutput" }, "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list the tags for the specified resource", "smithy.api#documentation": "

Lists the tags associated with the specified resource

", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.connecthealth#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the resource to list tags for

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#ListTagsForResourceOutput": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.connecthealth#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the resource

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#ManagedNoteTemplate": { "type": "enum", "members": { "HISTORY_AND_PHYSICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HISTORY_AND_PHYSICAL" } }, "GIRPP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GIRPP" } }, "DAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAP" } }, "SIRP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIRP" } }, "BIRP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BIRP" } }, "BEHAVIORAL_SOAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEHAVIORAL_SOAP" } }, "PHYSICAL_SOAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHYSICAL_SOAP" } } } }, "com.amazonaws.connecthealth#ManagedTemplate": { "type": "structure", "members": { "templateType": { "target": "com.amazonaws.connecthealth#ManagedNoteTemplate", "traits": { "smithy.api#documentation": "

The type of managed template to use

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration for using a managed note template

" } }, "com.amazonaws.connecthealth#ManagedTemplateResponse": { "type": "structure", "members": { "templateType": { "target": "com.amazonaws.connecthealth#ManagedNoteTemplate", "traits": { "smithy.api#documentation": "

The type of managed template used

" } } }, "traits": { "smithy.api#documentation": "

Response containing managed template information

" } }, "com.amazonaws.connecthealth#MedicalCodeGenerationResult": { "type": "structure", "members": { "medicalCodesResult": { "target": "com.amazonaws.connecthealth#ArtifactDetails", "traits": { "smithy.api#documentation": "

Details about the generated medical codes. If the status is SKIPPED, medical codes weren't generated, for example because the clinical note wasn't generated or had no content.

" } }, "jobId": { "target": "com.amazonaws.connecthealth#JobId", "traits": { "smithy.api#documentation": "

The identifier of the medical coding job that generated the medical codes. To submit feedback on the medical codes, use this value as the artifactSourceId, with the artifactType MEDICAL_CODES, in SubmitFeedback.

" } } }, "traits": { "smithy.api#documentation": "

Results of medical code generation, including the medical codes and the medical coding job.

" } }, "com.amazonaws.connecthealth#MedicalCodeGenerationSettings": { "type": "structure", "members": { "enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether to generate medical codes for the session. If you set this to true, the service generates medical codes from the clinical note after the session ends, using your permissions for medical coding, the output Amazon S3 location, and the AWS KMS key. You can set this to true only in a Region where medical code generation is available. To provide a medicalCodingContext, you must set this to true.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Settings for generating medical codes from the clinical note after the session ends. Medical code generation is in preview release and is subject to change. Medical code generation is available in the US East (N. Virginia) and US West (Oregon) AWS Regions.

" } }, "com.amazonaws.connecthealth#MedicalCodeGenerationSettingsResponse": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.connecthealth#NonNullBoolean", "traits": { "smithy.api#documentation": "

Indicates whether medical code generation was requested for the session.

" } } }, "traits": { "smithy.api#documentation": "

Response containing settings for medical code generation.

" } }, "com.amazonaws.connecthealth#MedicalCodesEncounterContext": { "type": "structure", "members": { "encounterType": { "target": "com.amazonaws.connecthealth#EncounterType", "traits": { "smithy.api#documentation": "

The type of the encounter, either in person or telehealth.

" } }, "encounterReason": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

The reason for the encounter. The reason can contain letters, numbers, spaces, periods, commas, and hyphens, and can't contain only spaces.

", "smithy.api#length": { "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9 .,-]+$" } }, "afterHours": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the encounter took place outside regular business hours.

" } }, "encounterDate": { "target": "com.amazonaws.connecthealth#SensitiveIsoDateString", "traits": { "smithy.api#documentation": "

The date of the encounter, in YYYY-MM-DD format. The date can't be more than one day after the current date in UTC.

" } }, "encounterDurationMinutes": { "target": "com.amazonaws.connecthealth#SensitiveNonNegativeInteger", "traits": { "smithy.api#documentation": "

The duration of the encounter, in minutes, from 1 to 1440.

", "smithy.api#range": { "min": 1, "max": 1440 } } } }, "traits": { "smithy.api#documentation": "

Encounter context for a medical coding job. All fields are optional.

" } }, "com.amazonaws.connecthealth#MedicalCodesPatientContext": { "type": "structure", "members": { "sex": { "target": "com.amazonaws.connecthealth#Sex", "traits": { "smithy.api#documentation": "

The sex of the patient.

" } }, "status": { "target": "com.amazonaws.connecthealth#PatientStatus", "traits": { "smithy.api#documentation": "

The status of the patient, either new or established.

" } }, "dateOfBirth": { "target": "com.amazonaws.connecthealth#SensitiveIsoDateString", "traits": { "smithy.api#documentation": "

The date of birth of the patient, in YYYY-MM-DD format. The date can't be after the current date in UTC.

" } }, "insurance": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

The insurance of the patient.

" } } }, "traits": { "smithy.api#documentation": "

Patient context for a medical coding job. All fields are optional.

" } }, "com.amazonaws.connecthealth#MedicalCodingContext": { "type": "structure", "members": { "sex": { "target": "com.amazonaws.connecthealth#Sex", "traits": { "smithy.api#documentation": "

The sex of the patient.

" } }, "status": { "target": "com.amazonaws.connecthealth#PatientStatus", "traits": { "smithy.api#documentation": "

The status of the patient, either new or established.

" } }, "dateOfBirth": { "target": "com.amazonaws.connecthealth#SensitiveIsoDateString", "traits": { "smithy.api#documentation": "

The date of birth of the patient, in YYYY-MM-DD format. The date can't be after the current date in UTC.

" } }, "encounterType": { "target": "com.amazonaws.connecthealth#EncounterType", "traits": { "smithy.api#documentation": "

The type of the encounter, either in person or telehealth.

" } }, "encounterReason": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

The reason for the encounter. The reason can contain letters, numbers, spaces, periods, commas, and hyphens, and can't contain only spaces.

", "smithy.api#length": { "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9 .,-]+$" } }, "afterHours": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the encounter took place outside regular business hours.

" } }, "encounterDate": { "target": "com.amazonaws.connecthealth#SensitiveIsoDateString", "traits": { "smithy.api#documentation": "

The date of the encounter, in YYYY-MM-DD format. The date can't be more than one day after the current date in UTC.

" } } }, "traits": { "smithy.api#documentation": "

Patient and encounter context for medical code generation. Providing this information can improve the accuracy of the medical codes. To provide it, you must also set enabled to true in medicalCodeGenerationSettings. All fields are optional. The service generates medical codes without any field that you leave out.

" } }, "com.amazonaws.connecthealth#MedicalCodingDatasetArtifacts": { "type": "structure", "members": { "evaluationS3Uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 location, under the s3OutputPath of the dataset, of the evaluation scores for the dataset.

" } } }, "traits": { "smithy.api#documentation": "

The results of building a medical coding dataset.

" } }, "com.amazonaws.connecthealth#MedicalCodingDatasetConfig": { "type": "structure", "members": { "s3InputPath": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 location of your coded examples. You need s3:GetObject and s3:ListBucket permissions for it, and kms:Decrypt if you encrypt it with an AWS KMS key.

", "smithy.api#required": {} } }, "s3OutputPath": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 location where Amazon Connect Health writes the evaluation scores for the dataset. You need s3:PutObject permission for it, and kms:GenerateDataKey if you encrypt it with an AWS KMS key.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration of a medical coding dataset. Amazon Connect Health uses the coded examples that are in the input location when you create the dataset, and writes evaluation scores to the output location, with your permissions. Later changes to the input location don't change the dataset.

" } }, "com.amazonaws.connecthealth#MedicalCodingJobArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 200 }, "smithy.api#pattern": "^arn:aws[-a-z]*:health-agent:[-a-z0-9]+:[0-9]{12}:domain/[-a-zA-Z0-9-]+/medical-coding-job/[-a-zA-Z0-9_/.]+$" } }, "com.amazonaws.connecthealth#MedicalCodingOutput": { "type": "structure", "members": { "uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 location of the medical codes that the job generated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The location of the results of a medical coding job.

" } }, "com.amazonaws.connecthealth#MedicalCodingOutputDataConfig": { "type": "structure", "members": { "s3OutputPath": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 location where Amazon Connect Health writes the results of the job.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The output configuration for a medical coding job.

" } }, "com.amazonaws.connecthealth#MedicalScribeAudioEvent": { "type": "structure", "members": { "audioChunk": { "target": "com.amazonaws.connecthealth#AudioChunk", "traits": { "smithy.api#documentation": "

The audio data chunk

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An event containing audio data for the Medical Scribe stream

" } }, "com.amazonaws.connecthealth#MedicalScribeBinaryAudioEvent": { "type": "structure", "members": { "audioChunk": { "target": "com.amazonaws.connecthealth#AudioChunk", "traits": { "smithy.api#documentation": "

The raw binary audio data chunk

", "smithy.api#eventPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An event containing raw binary audio data for the Medical Scribe stream. The audio is sent as a raw binary payload rather than as a base64-encoded value.

" } }, "com.amazonaws.connecthealth#MedicalScribeChannelDefinition": { "type": "structure", "members": { "channelId": { "target": "com.amazonaws.connecthealth#MedicalScribeChannelId", "traits": { "smithy.api#documentation": "

The channel identifier

", "smithy.api#required": {} } }, "participantRole": { "target": "com.amazonaws.connecthealth#MedicalScribeParticipantRole", "traits": { "smithy.api#documentation": "

The role of the participant on this channel

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a channel in the audio stream

" } }, "com.amazonaws.connecthealth#MedicalScribeChannelDefinitions": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#MedicalScribeChannelDefinition" }, "traits": { "smithy.api#length": { "min": 2, "max": 2 } } }, "com.amazonaws.connecthealth#MedicalScribeChannelId": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1 } } }, "com.amazonaws.connecthealth#MedicalScribeChecklistEvent": { "type": "structure", "members": { "snapshotVersion": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The version of this snapshot. Versions increase within a session and can skip values. Keep the snapshot with the highest version and ignore any event whose version is not higher, including after you reconnect to the session. Versions of checklist events and periodontal chart events are independent.

", "smithy.api#required": {} } }, "checklists": { "target": "com.amazonaws.connecthealth#ChecklistList", "traits": { "smithy.api#documentation": "

The checklists for the session. The list is empty when no checklist is active.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Real-time extraction is in preview release for Amazon Connect Health and is subject to change. To request access to this feature, contact your AWS account team.

The session's checklist as of this point in the session. Each event carries every item with its current status, not only the items that changed.

" } }, "com.amazonaws.connecthealth#MedicalScribeConfigurationEvent": { "type": "structure", "members": { "postStreamActionSettings": { "target": "com.amazonaws.connecthealth#MedicalScribePostStreamActionSettings", "traits": { "smithy.api#documentation": "

Settings for actions to perform after the stream ends

", "smithy.api#required": {} } }, "channelDefinitions": { "target": "com.amazonaws.connecthealth#MedicalScribeChannelDefinitions", "traits": { "smithy.api#documentation": "

Channel definitions for the audio stream

" } }, "encounterContext": { "target": "com.amazonaws.connecthealth#EncounterContext", "traits": { "smithy.api#documentation": "

Context information about the clinical encounter

" } } }, "traits": { "smithy.api#documentation": "

An event containing configuration for the Medical Scribe session

" } }, "com.amazonaws.connecthealth#MedicalScribeInputStream": { "type": "union", "members": { "audioEvent": { "target": "com.amazonaws.connecthealth#MedicalScribeAudioEvent", "traits": { "smithy.api#documentation": "

" } }, "binaryAudioEvent": { "target": "com.amazonaws.connecthealth#MedicalScribeBinaryAudioEvent", "traits": { "smithy.api#documentation": "

An event containing raw binary audio data for the Medical Scribe stream. The audio is sent as a raw binary payload rather than as a base64-encoded value.

" } }, "sessionControlEvent": { "target": "com.amazonaws.connecthealth#MedicalScribeSessionControlEvent", "traits": { "smithy.api#documentation": "

" } }, "configurationEvent": { "target": "com.amazonaws.connecthealth#MedicalScribeConfigurationEvent", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Input stream for Medical Scribe containing audio and configuration events

", "smithy.api#streaming": {} } }, "com.amazonaws.connecthealth#MedicalScribeLanguageCode": { "type": "enum", "members": { "EN_US": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "en-US" } }, "MULTI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "multi" } } } }, "com.amazonaws.connecthealth#MedicalScribeListeningSessionDetails": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.connecthealth#ScribeSessionId", "traits": { "smithy.api#documentation": "

The Session identifier

" } }, "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The Domain identifier

" } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The Subscription identifier

" } }, "languageCode": { "target": "com.amazonaws.connecthealth#MedicalScribeLanguageCode", "traits": { "smithy.api#documentation": "

The Language Code for the audio in the session

" } }, "mediaSampleRateHertz": { "target": "com.amazonaws.connecthealth#MedicalScribeMediaSampleRateHertz", "traits": { "smithy.api#documentation": "

The sample rate of the input audio

" } }, "mediaEncoding": { "target": "com.amazonaws.connecthealth#MedicalScribeMediaEncoding", "traits": { "smithy.api#documentation": "

The encoding for the input audio

" } }, "channelDefinitions": { "target": "com.amazonaws.connecthealth#MedicalScribeChannelDefinitions", "traits": { "smithy.api#documentation": "

Channel definitions for the audio stream

" } }, "postStreamActionSettings": { "target": "com.amazonaws.connecthealth#MedicalScribePostStreamActionSettingsResponse", "traits": { "smithy.api#documentation": "

Settings for post-stream actions

" } }, "postStreamActionResult": { "target": "com.amazonaws.connecthealth#MedicalScribePostStreamActionsResult", "traits": { "smithy.api#documentation": "

Results of post-stream actions

" } }, "encounterContextProvided": { "target": "com.amazonaws.connecthealth#NonNullBoolean", "traits": { "smithy.api#documentation": "

Indicates whether encounter context was provided

" } }, "medicalCodingContextProvided": { "target": "com.amazonaws.connecthealth#NonNullBoolean", "traits": { "smithy.api#documentation": "

Indicates whether medical coding context was provided.

" } }, "streamStatus": { "target": "com.amazonaws.connecthealth#MedicalScribeStreamStatus", "traits": { "smithy.api#documentation": "

The current status of the stream

" } }, "streamCreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the stream was created

" } }, "streamEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the stream ended

" } } }, "traits": { "smithy.api#documentation": "

Detailed information about a Medical Scribe listening session

" } }, "com.amazonaws.connecthealth#MedicalScribeMediaEncoding": { "type": "enum", "members": { "PCM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pcm" } }, "FLAC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "flac" } } } }, "com.amazonaws.connecthealth#MedicalScribeMediaSampleRateHertz": { "type": "integer", "traits": { "smithy.api#range": { "min": 8000, "max": 48000 } } }, "com.amazonaws.connecthealth#MedicalScribeOutputStream": { "type": "union", "members": { "transcriptEvent": { "target": "com.amazonaws.connecthealth#MedicalScribeTranscriptEvent", "traits": { "smithy.api#documentation": "

" } }, "internalFailureException": { "target": "com.amazonaws.connecthealth#InternalServerException", "traits": { "smithy.api#documentation": "

" } }, "validationException": { "target": "com.amazonaws.connecthealth#ValidationException", "traits": { "smithy.api#documentation": "

" } }, "periodontalChartEvent": { "target": "com.amazonaws.connecthealth#MedicalScribePeriodontalChartEvent", "traits": { "smithy.api#documentation": "

Real-time extraction is in preview release for Amazon Connect Health and is subject to change. To request access to this feature, contact your AWS account team.

A snapshot of the periodontal chart. Amazon Connect Health sends this event only when real-time extraction is enabled for the account and periodontal charting is dictated during the session.

" } }, "checklistEvent": { "target": "com.amazonaws.connecthealth#MedicalScribeChecklistEvent", "traits": { "smithy.api#documentation": "

Real-time extraction is in preview release for Amazon Connect Health and is subject to change. To request access to this feature, contact your AWS account team.

A snapshot of the session's checklist. Amazon Connect Health sends this event only when real-time extraction is enabled for the account and the session uses a supported note template.

" } } }, "traits": { "smithy.api#documentation": "

The output stream of a listening session. It carries transcript events, periodontal chart events, checklist events, and errors.

", "smithy.api#streaming": {} } }, "com.amazonaws.connecthealth#MedicalScribeParticipantRole": { "type": "enum", "members": { "PATIENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PATIENT" } }, "CLINICIAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLINICIAN" } } } }, "com.amazonaws.connecthealth#MedicalScribePeriodontalChartEvent": { "type": "structure", "members": { "snapshotVersion": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The version of this snapshot. Versions increase within a session and can skip values. Keep the snapshot with the highest version and ignore any event whose version is not higher, including after you reconnect to the session. Versions of checklist events and periodontal chart events are independent.

", "smithy.api#required": {} } }, "teeth": { "target": "com.amazonaws.connecthealth#PeriodontalToothList", "traits": { "smithy.api#documentation": "

The teeth that have a recorded value or are marked missing, in ascending toothNumber order.

", "smithy.api#required": {} } }, "reviewItems": { "target": "com.amazonaws.connecthealth#PeriodontalReviewList", "traits": { "smithy.api#documentation": "

Items that need the clinician's confirmation.

" } } }, "traits": { "smithy.api#documentation": "

Real-time extraction is in preview release for Amazon Connect Health and is subject to change. To request access to this feature, contact your AWS account team.

The periodontal chart as of this point in the session. Each event carries every tooth charted so far, not only the teeth that changed.

" } }, "com.amazonaws.connecthealth#MedicalScribePostStreamActionSettings": { "type": "structure", "members": { "outputS3Uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "clinicalNoteGenerationSettings": { "target": "com.amazonaws.connecthealth#ClinicalNoteGenerationSettings", "traits": { "smithy.api#documentation": "

Settings for clinical note generation

", "smithy.api#required": {} } }, "medicalCodeGenerationSettings": { "target": "com.amazonaws.connecthealth#MedicalCodeGenerationSettings", "traits": { "smithy.api#documentation": "

Settings for medical code generation. Medical code generation is in preview release and is subject to change.

" } } }, "traits": { "smithy.api#documentation": "

Settings for actions to perform after the audio stream ends

" } }, "com.amazonaws.connecthealth#MedicalScribePostStreamActionSettingsResponse": { "type": "structure", "members": { "outputS3Uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "clinicalNoteGenerationSettings": { "target": "com.amazonaws.connecthealth#ClinicalNoteGenerationSettingsResponse", "traits": { "smithy.api#documentation": "

Settings for clinical note generation

", "smithy.api#required": {} } }, "medicalCodeGenerationSettings": { "target": "com.amazonaws.connecthealth#MedicalCodeGenerationSettingsResponse", "traits": { "smithy.api#documentation": "

Settings for medical code generation. Returned only if you specified medicalCodeGenerationSettings when you started the session.

" } } }, "traits": { "smithy.api#documentation": "

Response containing settings for post-stream actions

" } }, "com.amazonaws.connecthealth#MedicalScribePostStreamActionsResult": { "type": "structure", "members": { "clinicalNoteGenerationResult": { "target": "com.amazonaws.connecthealth#ClinicalNoteGenerationResult", "traits": { "smithy.api#documentation": "

Results of clinical note generation

" } }, "medicalCodeGenerationResult": { "target": "com.amazonaws.connecthealth#MedicalCodeGenerationResult", "traits": { "smithy.api#documentation": "

Results of medical code generation. Returned if medical code generation runs for the session. Not returned if you set enabled to false in medicalCodeGenerationSettings.

" } } }, "traits": { "smithy.api#documentation": "

Results of post-stream actions performed after the audio stream ended

" } }, "com.amazonaws.connecthealth#MedicalScribeSessionControlEvent": { "type": "structure", "members": { "type": { "target": "com.amazonaws.connecthealth#MedicalScribeSessionControlEventType", "traits": { "smithy.api#documentation": "

The type of session control event

" } } }, "traits": { "smithy.api#documentation": "

An event for controlling the Medical Scribe session

" } }, "com.amazonaws.connecthealth#MedicalScribeSessionControlEventType": { "type": "enum", "members": { "END_OF_SESSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "END_OF_SESSION" } } } }, "com.amazonaws.connecthealth#MedicalScribeStreamStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "PAUSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } } } }, "com.amazonaws.connecthealth#MedicalScribeTranscriptEvent": { "type": "structure", "members": { "transcriptSegment": { "target": "com.amazonaws.connecthealth#MedicalScribeTranscriptSegment", "traits": { "smithy.api#documentation": "

A segment of the transcript

" } } }, "traits": { "smithy.api#documentation": "

An event containing transcript data from the Medical Scribe stream

" } }, "com.amazonaws.connecthealth#MedicalScribeTranscriptSegment": { "type": "structure", "members": { "segmentId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier for this segment

" } }, "audioBeginOffset": { "target": "com.amazonaws.connecthealth#AudioOffset", "traits": { "smithy.api#documentation": "

The offset from audio start when the audio for this segment begins

" } }, "audioEndOffset": { "target": "com.amazonaws.connecthealth#AudioOffset", "traits": { "smithy.api#documentation": "

The offset from audio start when the audio for this segment ends

" } }, "isPartial": { "target": "com.amazonaws.connecthealth#NonNullBoolean", "traits": { "smithy.api#documentation": "

Indicates whether this is a partial or final transcript

" } }, "channelId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The channel identifier for this segment

" } }, "content": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The transcript text content

" } } }, "traits": { "smithy.api#documentation": "

A segment of transcript text with timing and channel information

" } }, "com.amazonaws.connecthealth#NonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": "[\\s\\S]*\\S[\\s\\S]*" } }, "com.amazonaws.connecthealth#NonNullBoolean": { "type": "boolean" }, "com.amazonaws.connecthealth#NoteTemplateSettings": { "type": "union", "members": { "managedTemplate": { "target": "com.amazonaws.connecthealth#ManagedTemplate", "traits": { "smithy.api#documentation": "

" } }, "customTemplate": { "target": "com.amazonaws.connecthealth#CustomTemplate", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Settings for the note template to use for clinical note generation

" } }, "com.amazonaws.connecthealth#NoteTemplateSettingsResponse": { "type": "union", "members": { "managedTemplate": { "target": "com.amazonaws.connecthealth#ManagedTemplateResponse", "traits": { "smithy.api#documentation": "

" } }, "customTemplate": { "target": "com.amazonaws.connecthealth#CustomTemplateResponse", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Response containing note template settings

" } }, "com.amazonaws.connecthealth#OutputDataConfig": { "type": "structure", "members": { "s3OutputPath": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

S3 URI where the insights output will be stored.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration details for insights output.

" } }, "com.amazonaws.connecthealth#PatientInsightsEncounterContext": { "type": "structure", "members": { "encounterReason": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

Chief complaint for the visit

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9 .,-]+$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details for an encounter

" } }, "com.amazonaws.connecthealth#PatientInsightsPatientContext": { "type": "structure", "members": { "patientId": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

Unique identifier of the patient

", "smithy.api#required": {} } }, "dateOfBirth": { "target": "com.amazonaws.connecthealth#SensitiveIsoDateString", "traits": { "smithy.api#documentation": "

Date of birth of the patient.

" } }, "pronouns": { "target": "com.amazonaws.connecthealth#Pronouns", "traits": { "smithy.api#documentation": "

Pronouns preferred by the patient.

" } } }, "traits": { "smithy.api#documentation": "

Details for a patient

" } }, "com.amazonaws.connecthealth#PatientStatus": { "type": "enum", "members": { "NEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NEW" } }, "ESTABLISHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ESTABLISHED" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#PeriodontalGrade": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 3 } } }, "com.amazonaws.connecthealth#PeriodontalProbingDepthMillimeters": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 15 } } }, "com.amazonaws.connecthealth#PeriodontalRecessionMillimeters": { "type": "integer", "traits": { "smithy.api#range": { "min": -5, "max": 15 } } }, "com.amazonaws.connecthealth#PeriodontalReview": { "type": "structure", "members": { "reason": { "target": "com.amazonaws.connecthealth#PeriodontalReviewReason", "traits": { "smithy.api#documentation": "

The reason for review. The following values are valid:

", "smithy.api#required": {} } }, "toothNumber": { "target": "com.amazonaws.connecthealth#PeriodontalToothNumber", "traits": { "smithy.api#documentation": "

The tooth that the item refers to.

" } }, "sites": { "target": "com.amazonaws.connecthealth#PeriodontalSiteNameList", "traits": { "smithy.api#documentation": "

The probing sites of that tooth that the item refers to.

" } } }, "traits": { "smithy.api#documentation": "

An item of the periodontal chart that needs the clinician's confirmation.

", "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#PeriodontalReviewList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#PeriodontalReview" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.connecthealth#PeriodontalReviewReason": { "type": "enum", "members": { "SITE_NOT_CHARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SITE_NOT_CHARTED" } }, "VALUE_NOT_CHARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALUE_NOT_CHARTED" } }, "READING_COUNT_MISMATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READING_COUNT_MISMATCH" } }, "LINE_UNCLEAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINE_UNCLEAR" } }, "TOOTH_UNCLEAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOOTH_UNCLEAR" } }, "MISSING_TOOTH_CONFLICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_TOOTH_CONFLICT" } }, "MEASUREMENT_NOT_CHARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEASUREMENT_NOT_CHARTED" } }, "SESSION_ISSUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SESSION_ISSUE" } } } }, "com.amazonaws.connecthealth#PeriodontalSite": { "type": "structure", "members": { "site": { "target": "com.amazonaws.connecthealth#PeriodontalSiteName", "traits": { "smithy.api#documentation": "

The probing site. The following values are valid:

", "smithy.api#required": {} } }, "probingDepth": { "target": "com.amazonaws.connecthealth#PeriodontalProbingDepthMillimeters", "traits": { "smithy.api#documentation": "

The probing depth, in millimeters. The value ranges from 0 to 15.

" } }, "recession": { "target": "com.amazonaws.connecthealth#PeriodontalRecessionMillimeters", "traits": { "smithy.api#documentation": "

The gingival recession, in millimeters. The value ranges from -5 to 15. For example, -1 represents \"plus one.\"

" } }, "bleeding": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the site bled during probing.

" } }, "suppuration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether suppuration was present at the site.

" } } }, "traits": { "smithy.api#documentation": "

The measurements at one probing site of a tooth.

", "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#PeriodontalSiteList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#PeriodontalSite" }, "traits": { "smithy.api#length": { "max": 6 } } }, "com.amazonaws.connecthealth#PeriodontalSiteName": { "type": "enum", "members": { "DISTOBUCCAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DB" } }, "BUCCAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "B" } }, "MESIOBUCCAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MB" } }, "DISTOLINGUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DL" } }, "LINGUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "L" } }, "MESIOLINGUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ML" } } } }, "com.amazonaws.connecthealth#PeriodontalSiteNameList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#PeriodontalSiteName" }, "traits": { "smithy.api#length": { "max": 6 } } }, "com.amazonaws.connecthealth#PeriodontalTooth": { "type": "structure", "members": { "toothNumber": { "target": "com.amazonaws.connecthealth#PeriodontalToothNumber", "traits": { "smithy.api#documentation": "

The tooth number in the Universal Numbering System. The value ranges from 1 to 32.

", "smithy.api#required": {} } }, "missing": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the tooth is missing.

", "smithy.api#required": {} } }, "mobility": { "target": "com.amazonaws.connecthealth#PeriodontalGrade", "traits": { "smithy.api#documentation": "

The tooth mobility grade. The value ranges from 0 to 3.

" } }, "furcation": { "target": "com.amazonaws.connecthealth#PeriodontalGrade", "traits": { "smithy.api#documentation": "

The furcation involvement class. The value ranges from 0 to 3.

" } }, "sites": { "target": "com.amazonaws.connecthealth#PeriodontalSiteList", "traits": { "smithy.api#documentation": "

The probing sites that have a recorded measurement, in the order MB, B, DB, ML, L, DL.

" } } }, "traits": { "smithy.api#documentation": "

The chart for one tooth.

", "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#PeriodontalToothList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#PeriodontalTooth" }, "traits": { "smithy.api#length": { "max": 32 } } }, "com.amazonaws.connecthealth#PeriodontalToothNumber": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 32 } } }, "com.amazonaws.connecthealth#PostStreamArtifactGenerationStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIPPED" } } } }, "com.amazonaws.connecthealth#Pronouns": { "type": "enum", "members": { "HE_HIM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HE_HIM" } }, "SHE_HER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHE_HER" } }, "THEY_THEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THEY_THEM" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#ProviderRole": { "type": "enum", "members": { "CLINICIAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLINICIAN" } } } }, "com.amazonaws.connecthealth#RequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connecthealth#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

This error is thrown when the requested resource is not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.connecthealth#S3Source": { "type": "structure", "members": { "uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The S3 URI.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

S3 uri for input data source

" } }, "com.amazonaws.connecthealth#S3Sources": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#S3Source" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.connecthealth#S3Uri": { "type": "string", "traits": { "smithy.api#documentation": "An Amazon S3 location as an s3:// URI, for example s3://amzn-s3-demo-bucket/prefix/.", "smithy.api#length": { "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" } }, "com.amazonaws.connecthealth#ScribeSessionId": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" } }, "com.amazonaws.connecthealth#SensitiveIsoDateString": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#SensitiveMarkdownString": { "type": "string", "traits": { "smithy.api#pattern": "^[\\p{L}\\p{N}\\s\\*_\\-#\\[\\]\\(\\)\\.,:;!?'\"`<>~/|+=&%@\\\\{}^]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#SensitiveNonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": "[\\s\\S]*\\S[\\s\\S]*", "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#SensitiveNonNegativeInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 }, "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#SensitiveSectionHeaderString": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9_]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The request exceeds a service quota.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.connecthealth#Sex": { "type": "enum", "members": { "MALE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MALE" } }, "FEMALE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FEMALE" } }, "NON_BINARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NON_BINARY" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.connecthealth#Specialty": { "type": "enum", "members": { "PRIMARY_CARE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIMARY_CARE" } } } }, "com.amazonaws.connecthealth#StartMedicalCodingJob": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#StartMedicalCodingJobRequest" }, "output": { "target": "com.amazonaws.connecthealth#StartMedicalCodingJobResponse" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#ConflictException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "resources": { "required": { "DomainResource": {}, "MedicalCodingJobResource": {} } } }, "smithy.api#documentation": "

Starts an asynchronous job that generates medical codes (ICD-10 and CPT) for clinical text. Call GetMedicalCodingJob to check the status of the job. When the job succeeds, Amazon Connect Health writes the results to the output Amazon S3 location.

To tailor the codes to your organization, specify an ACTIVE medical coding dataset in the Domain. If you don't specify a dataset, the job uses the general medical coding knowledge base.

Medical coding jobs are in preview release and are subject to change.

", "smithy.api#endpoint": { "hostPrefix": "runtime." }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/domain/{domainId}/medical-coding-job" } } }, "com.amazonaws.connecthealth#StartMedicalCodingJobRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "text": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

The clinical text to generate medical codes for, such as a clinical note.

", "smithy.api#required": {} } }, "patientContext": { "target": "com.amazonaws.connecthealth#MedicalCodesPatientContext", "traits": { "smithy.api#documentation": "

Patient context for the job. Providing this information can improve the accuracy of the medical codes.

" } }, "encounterContext": { "target": "com.amazonaws.connecthealth#MedicalCodesEncounterContext", "traits": { "smithy.api#documentation": "

Encounter context for the job. Providing this information can improve the accuracy of the medical codes.

" } }, "outputDataConfig": { "target": "com.amazonaws.connecthealth#MedicalCodingOutputDataConfig", "traits": { "smithy.api#documentation": "

The output configuration for the job.

", "smithy.api#required": {} } }, "datasetId": { "target": "com.amazonaws.connecthealth#DatasetId", "traits": { "smithy.api#documentation": "

The unique identifier of an ACTIVE medical coding dataset in the Domain to code against. If you don't specify a dataset, the job uses the general medical coding knowledge base.

" } }, "clientToken": { "target": "com.amazonaws.connecthealth#NonEmptyString", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#StartMedicalCodingJobResponse": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.connecthealth#MedicalCodingJobArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the medical coding job.

", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.connecthealth#JobId", "traits": { "smithy.api#documentation": "

The unique identifier of the medical coding job.

", "smithy.api#required": {} } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the medical coding job was created.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#StartMedicalScribeListeningSession": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#StartMedicalScribeListeningSessionInput" }, "output": { "target": "com.amazonaws.connecthealth#StartMedicalScribeListeningSessionOutput" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "smithy.api#documentation": "

Starts a new Medical Scribe listening session for real-time audio transcription

", "smithy.api#endpoint": { "hostPrefix": "streaming." }, "smithy.api#http": { "uri": "/medical-scribe-stream/", "method": "POST" } } }, "com.amazonaws.connecthealth#StartMedicalScribeListeningSessionInput": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.connecthealth#ScribeSessionId", "traits": { "smithy.api#documentation": "

The Session identifier

", "smithy.api#httpHeader": "x-amzn-medscribe-session-id", "smithy.api#required": {} } }, "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The Domain identifier

", "smithy.api#httpHeader": "x-amzn-medscribe-domain-id", "smithy.api#required": {} } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The Subscription identifier

", "smithy.api#httpHeader": "x-amzn-medscribe-subscription-id", "smithy.api#required": {} } }, "languageCode": { "target": "com.amazonaws.connecthealth#MedicalScribeLanguageCode", "traits": { "smithy.api#documentation": "

The Language Code for the audio in the session

", "smithy.api#httpHeader": "x-amzn-medscribe-language-code", "smithy.api#required": {} } }, "mediaSampleRateHertz": { "target": "com.amazonaws.connecthealth#MedicalScribeMediaSampleRateHertz", "traits": { "smithy.api#documentation": "

The sample rate of the input audio

", "smithy.api#httpHeader": "x-amzn-medscribe-sample-rate", "smithy.api#required": {} } }, "mediaEncoding": { "target": "com.amazonaws.connecthealth#MedicalScribeMediaEncoding", "traits": { "smithy.api#documentation": "

The encoding for the input audio

", "smithy.api#httpHeader": "x-amzn-medscribe-media-encoding", "smithy.api#required": {} } }, "inputStream": { "target": "com.amazonaws.connecthealth#MedicalScribeInputStream", "traits": { "smithy.api#documentation": "

", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#StartMedicalScribeListeningSessionOutput": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.connecthealth#ScribeSessionId", "traits": { "smithy.api#documentation": "

The Session identifier

", "smithy.api#httpHeader": "x-amzn-medscribe-session-id" } }, "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The Domain identifier

", "smithy.api#httpHeader": "x-amzn-medscribe-domain-id" } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The Subscription identifier

", "smithy.api#httpHeader": "x-amzn-medscribe-subscription-id" } }, "requestId": { "target": "com.amazonaws.connecthealth#RequestId", "traits": { "smithy.api#documentation": "

The Request identifier

", "smithy.api#httpHeader": "x-amzn-request-id" } }, "languageCode": { "target": "com.amazonaws.connecthealth#MedicalScribeLanguageCode", "traits": { "smithy.api#documentation": "

The Language Code for the audio in the session

", "smithy.api#httpHeader": "x-amzn-medscribe-language-code" } }, "mediaSampleRateHertz": { "target": "com.amazonaws.connecthealth#MedicalScribeMediaSampleRateHertz", "traits": { "smithy.api#documentation": "

The sample rate of the input audio

", "smithy.api#httpHeader": "x-amzn-medscribe-sample-rate" } }, "mediaEncoding": { "target": "com.amazonaws.connecthealth#MedicalScribeMediaEncoding", "traits": { "smithy.api#documentation": "

The encoding for the input audio

", "smithy.api#httpHeader": "x-amzn-medscribe-media-encoding" } }, "responseStream": { "target": "com.amazonaws.connecthealth#MedicalScribeOutputStream", "traits": { "smithy.api#documentation": "

The output stream that contains transcript events, periodontal chart events, checklist events, and errors.

", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#StartPatientInsightsJob": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#StartPatientInsightsJobRequest" }, "output": { "target": "com.amazonaws.connecthealth#StartPatientInsightsJobResponse" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#ConflictException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "resources": { "required": { "DomainResource": {}, "PatientInsightsJobResource": {} } } }, "smithy.api#documentation": "

Starts a new patient insights job.

", "smithy.api#endpoint": { "hostPrefix": "runtime." }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/domain/{domainId}/patient-insights-job" } } }, "com.amazonaws.connecthealth#StartPatientInsightsJobRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "patientContext": { "target": "com.amazonaws.connecthealth#PatientInsightsPatientContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "insightsContext": { "target": "com.amazonaws.connecthealth#InsightsContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "encounterContext": { "target": "com.amazonaws.connecthealth#PatientInsightsEncounterContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "userContext": { "target": "com.amazonaws.connecthealth#UserContext", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "inputDataConfig": { "target": "com.amazonaws.connecthealth#InputDataConfig", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "outputDataConfig": { "target": "com.amazonaws.connecthealth#OutputDataConfig", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.connecthealth#NonEmptyString", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#StartPatientInsightsJobResponse": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.connecthealth#JobArn", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.connecthealth#JobId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Date and time the patient insights job was submitted.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#SubmitFeedback": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#SubmitFeedbackRequest" }, "output": { "target": "com.amazonaws.connecthealth#SubmitFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.connecthealth#AccessDeniedException" }, { "target": "com.amazonaws.connecthealth#InternalServerException" }, { "target": "com.amazonaws.connecthealth#ResourceNotFoundException" }, { "target": "com.amazonaws.connecthealth#ThrottlingException" }, { "target": "com.amazonaws.connecthealth#ValidationException" } ], "traits": { "aws.api#dataPlane": {}, "aws.iam#iamAction": { "resources": { "required": { "DomainResource": {} } } }, "smithy.api#documentation": "

Submits feedback on a clinical document or a set of medical codes that Amazon Connect Health generated.

", "smithy.api#endpoint": { "hostPrefix": "runtime." }, "smithy.api#http": { "code": 202, "method": "POST", "uri": "/domain/{domainId}/feedback" } } }, "com.amazonaws.connecthealth#SubmitFeedbackRequest": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

The unique identifier of the parent Domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "artifactSourceId": { "target": "com.amazonaws.connecthealth#ArtifactSourceId", "traits": { "smithy.api#documentation": "

The identifier of the artifact source. For a clinical document, this is the session ID. For a set of medical codes, this is the medical coding job ID.

", "smithy.api#required": {} } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

The unique identifier of the Subscription.

" } }, "artifactType": { "target": "com.amazonaws.connecthealth#FeedbackArtifactType", "traits": { "smithy.api#documentation": "

The type of artifact that you submit feedback for. The following values are valid:

", "smithy.api#required": {} } }, "signedArtifactS3Uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) URI of the final artifact that the clinician signed.

", "smithy.api#required": {} } }, "generatedArtifactS3Uri": { "target": "com.amazonaws.connecthealth#S3Uri", "traits": { "smithy.api#documentation": "

The Amazon S3 URI of the clinical document or set of medical codes that Amazon Connect Health generated.

" } }, "comments": { "target": "com.amazonaws.connecthealth#FeedbackComments", "traits": { "smithy.api#documentation": "

Optional comments about the feedback.

" } }, "clientToken": { "target": "com.amazonaws.connecthealth#IdempotencyToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#SubmitFeedbackResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connecthealth#SubscriptionArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain/(hai-|dom-)[a-z0-9]+/subscription/sub-[a-zA-Z0-9]{21}$" } }, "com.amazonaws.connecthealth#SubscriptionDescription": { "type": "structure", "members": { "domainId": { "target": "com.amazonaws.connecthealth#DomainId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "domainId" } }, "subscriptionId": { "target": "com.amazonaws.connecthealth#SubscriptionId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "subscriptionId" } }, "arn": { "target": "com.amazonaws.connecthealth#SubscriptionArn", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.connecthealth#SubscriptionStatus", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "activatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

" } }, "deactivatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Complete subscription resource data.

" } }, "com.amazonaws.connecthealth#SubscriptionId": { "type": "string", "traits": { "smithy.api#length": { "min": 25, "max": 25 }, "smithy.api#pattern": "^sub-[a-zA-Z0-9]{21}$" } }, "com.amazonaws.connecthealth#SubscriptionList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#SubscriptionDescription" } }, "com.amazonaws.connecthealth#SubscriptionStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.connecthealth#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.connecthealth#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.connecthealth#TagMap": { "type": "map", "key": { "target": "com.amazonaws.connecthealth#TagKey" }, "value": { "target": "com.amazonaws.connecthealth#TagValue" } }, "com.amazonaws.connecthealth#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#TagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "traits": { "aws.iam#actionPermissionDescription": "Grants permission to add the specified tags to the specified resource", "aws.iam#conditionKeys": [ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], "smithy.api#documentation": "

Associates the specified tags with the specified resource

", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.connecthealth#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the resource to tag

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.connecthealth#TagMap", "traits": { "smithy.api#documentation": "

The tags to add to the resource

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.connecthealth#TemplateInstructions": { "type": "list", "member": { "target": "com.amazonaws.connecthealth#TemplateSectionInstruction" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.connecthealth#TemplateSectionInstruction": { "type": "structure", "members": { "sectionHeader": { "target": "com.amazonaws.connecthealth#SensitiveSectionHeaderString", "traits": { "smithy.api#documentation": "

The header for this section of the template

", "smithy.api#required": {} } }, "sectionInstruction": { "target": "com.amazonaws.connecthealth#SensitiveMarkdownString", "traits": { "smithy.api#documentation": "

The instruction for generating this section

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Instructions for generating a specific section of a clinical note

" } }, "com.amazonaws.connecthealth#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

This error is thrown when the client exceeds the allowed request rate.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.connecthealth#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.connecthealth#UntagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "traits": { "aws.iam#actionPermissionDescription": "Grants permission to remove the specified tags from the specified resource", "aws.iam#conditionKeys": [ "aws:TagKeys" ], "smithy.api#documentation": "

Removes the specified tags from the specified resource

", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.connecthealth#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the resource to untag

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.connecthealth#TagKeyList", "traits": { "smithy.api#documentation": "

The tag keys to remove from the resource

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connecthealth#Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "(s3://|http(s*)://).+" } }, "com.amazonaws.connecthealth#UserContext": { "type": "structure", "members": { "role": { "target": "com.amazonaws.connecthealth#ProviderRole", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "userId": { "target": "com.amazonaws.connecthealth#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

Unique identifier of the user

", "smithy.api#required": {} } }, "specialty": { "target": "com.amazonaws.connecthealth#Specialty", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Details for user initiating insights job

" } }, "com.amazonaws.connecthealth#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

This error is thrown when the client supplies invalid input to the API.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.connecthealth#WebAppConfiguration": { "type": "structure", "members": { "ehrRole": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

ARN of the IAM role used for EHR operations.

", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/.+$", "smithy.api#required": {} } }, "idcApplicationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Identity Center application ID associated with this Domain.

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#required": {} } }, "idcRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The AWS region where Identity Center is configured.

", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration for the Domain web application, including Identity Center settings. If provided, all fields are required.

" } }, "com.amazonaws.connecthealth#WebAppUrl": { "type": "string" } } }