{ "version": "2.0", "metadata": { "apiVersion": "2025-01-29", "auth": [ "aws.auth#sigv4" ], "endpointPrefix": "health-agent", "protocol": "rest-json", "protocolSettings": { "h2": "eventstream" }, "protocols": [ "rest-json" ], "serviceFullName": "Connect Health", "serviceId": "ConnectHealth", "signatureVersion": "v4", "signingName": "health-agent", "uid": "connecthealth-2025-01-29" }, "operations": { "ActivateSubscription": { "name": "ActivateSubscription", "http": { "method": "POST", "requestUri": "\/domains\/{domainId}\/subscriptions\/{subscriptionId}\/activate", "responseCode": 200 }, "input": { "shape": "ActivateSubscriptionInput" }, "output": { "shape": "ActivateSubscriptionOutput" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ] }, "CreateDomain": { "name": "CreateDomain", "http": { "method": "POST", "requestUri": "\/domain", "responseCode": 201 }, "input": { "shape": "CreateDomainInput" }, "output": { "shape": "CreateDomainOutput" }, "errors": [ { "shape": "ServiceQuotaExceededException" } ], "idempotent": true }, "CreateSubscription": { "name": "CreateSubscription", "http": { "method": "POST", "requestUri": "\/domains\/{domainId}\/subscriptions", "responseCode": 201 }, "input": { "shape": "CreateSubscriptionInput" }, "output": { "shape": "CreateSubscriptionOutput" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ServiceQuotaExceededException" } ] }, "DeactivateSubscription": { "name": "DeactivateSubscription", "http": { "method": "POST", "requestUri": "\/domains\/{domainId}\/subscriptions\/{subscriptionId}\/deactivate", "responseCode": 200 }, "input": { "shape": "DeactivateSubscriptionInput" }, "output": { "shape": "DeactivateSubscriptionOutput" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "idempotent": true }, "DeleteDomain": { "name": "DeleteDomain", "http": { "method": "DELETE", "requestUri": "\/domain\/{domainId}", "responseCode": 200 }, "input": { "shape": "DeleteDomainInput" }, "output": { "shape": "DeleteDomainOutput" }, "errors": [ { "shape": "ResourceNotFoundException" } ], "idempotent": true }, "GetDomain": { "name": "GetDomain", "http": { "method": "GET", "requestUri": "\/domain\/{domainId}", "responseCode": 200 }, "input": { "shape": "GetDomainInput" }, "output": { "shape": "GetDomainOutput" }, "errors": [ { "shape": "ResourceNotFoundException" } ], "readonly": true }, "GetMedicalScribeListeningSession": { "name": "GetMedicalScribeListeningSession", "http": { "method": "GET", "requestUri": "\/medical-scribe-stream\/domain\/{domainId}\/subscription\/{subscriptionId}\/session\/{sessionId}", "responseCode": 200 }, "input": { "shape": "GetMedicalScribeListeningSessionInput" }, "output": { "shape": "GetMedicalScribeListeningSessionOutput" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "ServiceQuotaExceededException" } ], "endpoint": { "hostPrefix": "streaming." }, "readonly": true }, "GetPatientInsightsJob": { "name": "GetPatientInsightsJob", "http": { "method": "GET", "requestUri": "\/domain\/{domainId}\/patient-insights-job\/{jobId}", "responseCode": 200 }, "input": { "shape": "GetPatientInsightsJobRequest" }, "output": { "shape": "GetPatientInsightsJobResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ThrottlingException" } ], "endpoint": { "hostPrefix": "runtime." }, "readonly": true }, "GetSubscription": { "name": "GetSubscription", "http": { "method": "GET", "requestUri": "\/domains\/{domainId}\/subscriptions\/{subscriptionId}", "responseCode": 200 }, "input": { "shape": "GetSubscriptionInput" }, "output": { "shape": "GetSubscriptionOutput" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "readonly": true }, "ListDomains": { "name": "ListDomains", "http": { "method": "GET", "requestUri": "\/domain", "responseCode": 200 }, "input": { "shape": "ListDomainsInput" }, "output": { "shape": "ListDomainsOutput" }, "readonly": true }, "ListSubscriptions": { "name": "ListSubscriptions", "http": { "method": "GET", "requestUri": "\/domains\/{domainId}\/subscriptions", "responseCode": 200 }, "input": { "shape": "ListSubscriptionsInput" }, "output": { "shape": "ListSubscriptionsOutput" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "readonly": true }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "\/tags\/{resourceArn}", "responseCode": 200 }, "input": { "shape": "ListTagsForResourceInput" }, "output": { "shape": "ListTagsForResourceOutput" }, "readonly": true }, "StartPatientInsightsJob": { "name": "StartPatientInsightsJob", "http": { "method": "POST", "requestUri": "\/domain\/{domainId}\/patient-insights-job", "responseCode": 200 }, "input": { "shape": "StartPatientInsightsJobRequest" }, "output": { "shape": "StartPatientInsightsJobResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ThrottlingException" }, { "shape": "ConflictException" } ], "endpoint": { "hostPrefix": "runtime." } }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "\/tags\/{resourceArn}", "responseCode": 204 }, "input": { "shape": "TagResourceInput" }, "idempotent": true }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "\/tags\/{resourceArn}", "responseCode": 204 }, "input": { "shape": "UntagResourceInput" }, "idempotent": true } }, "shapes": { "AccessDeniedException": { "type": "structure", "members": { "message": { "shape": "String" } }, "error": { "httpStatusCode": 401, "senderFault": true }, "exception": true }, "ActivateSubscriptionInput": { "type": "structure", "required": [ "domainId", "subscriptionId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" }, "subscriptionId": { "shape": "SubscriptionId", "location": "uri", "locationName": "subscriptionId" } } }, "ActivateSubscriptionOutput": { "type": "structure", "members": { "subscription": { "shape": "SubscriptionDescription" } } }, "ArtifactDetails": { "type": "structure", "members": { "outputLocation": { "shape": "Uri" }, "status": { "shape": "PostStreamArtifactGenerationStatus" }, "failureReason": { "shape": "ErrorMessage" } } }, "AudioChunk": { "type": "blob" }, "AudioOffset": { "type": "double", "box": true }, "ClinicalNoteGenerationResult": { "type": "structure", "members": { "noteResult": { "shape": "ArtifactDetails" }, "transcriptResult": { "shape": "ArtifactDetails" }, "afterVisitSummaryResult": { "shape": "ArtifactDetails" } } }, "ClinicalNoteGenerationSettings": { "type": "structure", "required": [ "noteTemplateSettings" ], "members": { "noteTemplateSettings": { "shape": "NoteTemplateSettings" } } }, "ClinicalNoteGenerationSettingsResponse": { "type": "structure", "members": { "noteTemplateSettings": { "shape": "NoteTemplateSettingsResponse" } } }, "ConflictException": { "type": "structure", "members": { "message": { "shape": "String" } }, "error": { "httpStatusCode": 409, "senderFault": true }, "exception": true }, "CreateDomainInput": { "type": "structure", "required": [ "name" ], "members": { "name": { "shape": "DomainName" }, "kmsKeyArn": { "shape": "KmsKeyArn" }, "webAppSetupConfiguration": { "shape": "CreateWebAppConfiguration" }, "tags": { "shape": "TagMap" } } }, "CreateDomainOutput": { "type": "structure", "required": [ "domainId", "arn", "name", "status", "createdAt" ], "members": { "domainId": { "shape": "DomainId" }, "arn": { "shape": "DomainArn" }, "name": { "shape": "DomainName" }, "kmsKeyArn": { "shape": "KmsKeyArn" }, "encryptionContext": { "shape": "EncryptionContext" }, "status": { "shape": "DomainStatus" }, "webAppUrl": { "shape": "WebAppUrl" }, "webAppConfiguration": { "shape": "WebAppConfiguration" }, "createdAt": { "shape": "Timestamp" } } }, "CreateSubscriptionInput": { "type": "structure", "required": [ "domainId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" } } }, "CreateSubscriptionOutput": { "type": "structure", "required": [ "domainId", "subscriptionId", "arn", "status", "createdAt", "lastUpdatedAt" ], "members": { "domainId": { "shape": "DomainId" }, "subscriptionId": { "shape": "SubscriptionId" }, "arn": { "shape": "SubscriptionArn" }, "status": { "shape": "SubscriptionStatus" }, "createdAt": { "shape": "Timestamp" }, "lastUpdatedAt": { "shape": "Timestamp" }, "activatedAt": { "shape": "Timestamp" }, "deactivatedAt": { "shape": "Timestamp" } } }, "CreateWebAppConfiguration": { "type": "structure", "required": [ "ehrRole", "idcInstanceId", "idcRegion" ], "members": { "ehrRole": { "shape": "CreateWebAppConfigurationEhrRoleString" }, "idcInstanceId": { "shape": "CreateWebAppConfigurationIdcInstanceIdString" }, "idcRegion": { "shape": "CreateWebAppConfigurationIdcRegionString" } } }, "CreateWebAppConfigurationEhrRoleString": { "type": "string", "max": 2048, "min": 1, "pattern": "arn:aws:iam::[0-9]{12}:role\/.+" }, "CreateWebAppConfigurationIdcInstanceIdString": { "type": "string", "max": 256, "min": 1 }, "CreateWebAppConfigurationIdcRegionString": { "type": "string", "max": 64, "min": 1 }, "CustomTemplate": { "type": "structure", "required": [ "templateType", "templateInstructions" ], "members": { "templateType": { "shape": "CustomTemplateBase" }, "templateInstructions": { "shape": "TemplateInstructions" } } }, "CustomTemplateBase": { "type": "string", "enum": [ "HISTORY_AND_PHYSICAL", "GIRPP", "DAP", "SIRP", "BIRP", "BEHAVIORAL_SOAP" ] }, "CustomTemplateResponse": { "type": "structure", "members": { "templateType": { "shape": "CustomTemplateBase" } } }, "DeactivateSubscriptionInput": { "type": "structure", "required": [ "domainId", "subscriptionId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" }, "subscriptionId": { "shape": "SubscriptionId", "location": "uri", "locationName": "subscriptionId" } } }, "DeactivateSubscriptionOutput": { "type": "structure", "members": { "subscription": { "shape": "SubscriptionDescription" } } }, "DeleteDomainInput": { "type": "structure", "required": [ "domainId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" } } }, "DeleteDomainOutput": { "type": "structure", "required": [ "domainId", "arn", "status" ], "members": { "domainId": { "shape": "DomainId" }, "arn": { "shape": "DomainArn" }, "status": { "shape": "DomainStatus" } } }, "DomainArn": { "type": "string", "pattern": "arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain\/(hai-|dom-)[a-z0-9]+" }, "DomainId": { "type": "string", "max": 25, "min": 20, "pattern": "(hai-|dom-)[a-z0-9]+" }, "DomainName": { "type": "string", "max": 64, "min": 1 }, "DomainStatus": { "type": "string", "enum": [ "ACTIVE", "DELETING", "DELETED" ] }, "DomainSummary": { "type": "structure", "required": [ "domainId", "arn", "name", "status", "createdAt" ], "members": { "domainId": { "shape": "DomainId" }, "arn": { "shape": "DomainArn" }, "name": { "shape": "DomainName" }, "status": { "shape": "DomainStatus" }, "createdAt": { "shape": "Timestamp" } } }, "DomainSummaryList": { "type": "list", "member": { "shape": "DomainSummary" } }, "EncounterContext": { "type": "structure", "members": { "unstructuredContext": { "shape": "SensitiveMarkdownString" } } }, "EncryptionContext": { "type": "structure", "required": [ "encryptionType" ], "members": { "encryptionType": { "shape": "EncryptionType" }, "kmsKeyArn": { "shape": "KmsKeyArn" } } }, "EncryptionType": { "type": "string", "enum": [ "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY" ] }, "ErrorMessage": { "type": "string", "max": 2048, "min": 1, "pattern": "[\\s\\S]*" }, "FHIRServer": { "type": "structure", "required": [ "fhirEndpoint" ], "members": { "fhirEndpoint": { "shape": "FHIRServerFhirEndpointString" }, "oauthToken": { "shape": "SensitiveNonEmptyString" } } }, "FHIRServerFhirEndpointString": { "type": "string", "pattern": "https?:\/\/[a-zA-Z0-9\\-._~:\/?#\\[\\]@!$&'()*+,;=%]+" }, "GetDomainInput": { "type": "structure", "required": [ "domainId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" } } }, "GetDomainOutput": { "type": "structure", "required": [ "domainId", "arn", "name", "status", "createdAt" ], "members": { "domainId": { "shape": "DomainId" }, "arn": { "shape": "DomainArn" }, "name": { "shape": "DomainName" }, "kmsKeyArn": { "shape": "KmsKeyArn" }, "encryptionContext": { "shape": "EncryptionContext" }, "status": { "shape": "DomainStatus" }, "webAppUrl": { "shape": "WebAppUrl" }, "webAppConfiguration": { "shape": "WebAppConfiguration" }, "createdAt": { "shape": "Timestamp" }, "tags": { "shape": "TagMap" } } }, "GetMedicalScribeListeningSessionInput": { "type": "structure", "required": [ "sessionId", "domainId", "subscriptionId" ], "members": { "sessionId": { "shape": "SessionId", "location": "uri", "locationName": "sessionId" }, "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" }, "subscriptionId": { "shape": "SubscriptionId", "location": "uri", "locationName": "subscriptionId" } } }, "GetMedicalScribeListeningSessionOutput": { "type": "structure", "members": { "medicalScribeListeningSessionDetails": { "shape": "MedicalScribeListeningSessionDetails" } } }, "GetPatientInsightsJobRequest": { "type": "structure", "required": [ "domainId", "jobId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" }, "jobId": { "shape": "JobId", "location": "uri", "locationName": "jobId" } } }, "GetPatientInsightsJobResponse": { "type": "structure", "required": [ "jobId", "jobArn", "jobStatus", "patientContext", "insightsContext", "encounterContext", "userContext", "inputDataConfig", "outputDataConfig" ], "members": { "jobId": { "shape": "JobId" }, "jobArn": { "shape": "JobArn" }, "jobStatus": { "shape": "JobStatus" }, "creationTime": { "shape": "SyntheticTimestamp_date_time" }, "updatedTime": { "shape": "SyntheticTimestamp_date_time" }, "insightsOutput": { "shape": "InsightsOutput" }, "statusDetails": { "shape": "NonEmptyString" }, "patientContext": { "shape": "PatientInsightsPatientContext" }, "insightsContext": { "shape": "InsightsContext" }, "encounterContext": { "shape": "PatientInsightsEncounterContext" }, "userContext": { "shape": "UserContext" }, "inputDataConfig": { "shape": "InputDataConfig" }, "outputDataConfig": { "shape": "OutputDataConfig" } } }, "GetSubscriptionInput": { "type": "structure", "required": [ "domainId", "subscriptionId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" }, "subscriptionId": { "shape": "SubscriptionId", "location": "uri", "locationName": "subscriptionId" } } }, "GetSubscriptionOutput": { "type": "structure", "members": { "subscription": { "shape": "SubscriptionDescription" } } }, "InputDataConfig": { "type": "structure", "members": { "fhirServer": { "shape": "FHIRServer" }, "s3Sources": { "shape": "S3Sources" } } }, "InsightsContext": { "type": "structure", "required": [ "insightsType" ], "members": { "insightsType": { "shape": "InsightsType" } } }, "InsightsOutput": { "type": "structure", "required": [ "uri" ], "members": { "uri": { "shape": "S3Uri" } } }, "InsightsType": { "type": "string", "enum": [ "PRE_VISIT" ] }, "InternalServerException": { "type": "structure", "members": { "message": { "shape": "String" } }, "error": { "httpStatusCode": 500 }, "exception": true, "fault": true, "retryable": { "throttling": false } }, "JobArn": { "type": "string", "max": 200, "min": 20, "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_\/.]+" }, "JobId": { "type": "string", "max": 36, "min": 1 }, "JobStatus": { "type": "string", "enum": [ "SUBMITTED", "IN_PROGRESS", "FAILED", "SUCCEEDED" ] }, "KmsKeyArn": { "type": "string", "pattern": "arn:aws:kms:[a-z0-9-]+:[0-9]{12}:key\/[a-f0-9-]+" }, "ListDomainsInput": { "type": "structure", "members": { "status": { "shape": "DomainStatus", "location": "querystring", "locationName": "status" }, "maxResults": { "shape": "ListDomainsInputMaxResultsInteger", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "String", "location": "querystring", "locationName": "nextToken" } } }, "ListDomainsInputMaxResultsInteger": { "type": "integer", "box": true, "max": 100, "min": 1 }, "ListDomainsOutput": { "type": "structure", "required": [ "domains" ], "members": { "domains": { "shape": "DomainSummaryList" }, "nextToken": { "shape": "String" } } }, "ListSubscriptionsInput": { "type": "structure", "required": [ "domainId" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" }, "maxResults": { "shape": "ListSubscriptionsInputMaxResultsInteger", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "String", "location": "querystring", "locationName": "nextToken" } } }, "ListSubscriptionsInputMaxResultsInteger": { "type": "integer", "box": true, "max": 100, "min": 1 }, "ListSubscriptionsOutput": { "type": "structure", "required": [ "subscriptions" ], "members": { "subscriptions": { "shape": "SubscriptionList" }, "nextToken": { "shape": "String" } } }, "ListTagsForResourceInput": { "type": "structure", "required": [ "resourceArn" ], "members": { "resourceArn": { "shape": "String", "location": "uri", "locationName": "resourceArn" } } }, "ListTagsForResourceOutput": { "type": "structure", "members": { "tags": { "shape": "TagMap" } } }, "ManagedNoteTemplate": { "type": "string", "enum": [ "HISTORY_AND_PHYSICAL", "GIRPP", "DAP", "SIRP", "BIRP", "BEHAVIORAL_SOAP", "PHYSICAL_SOAP" ] }, "ManagedTemplate": { "type": "structure", "required": [ "templateType" ], "members": { "templateType": { "shape": "ManagedNoteTemplate" } } }, "ManagedTemplateResponse": { "type": "structure", "members": { "templateType": { "shape": "ManagedNoteTemplate" } } }, "MedicalScribeAudioEvent": { "type": "structure", "required": [ "audioChunk" ], "members": { "audioChunk": { "shape": "AudioChunk" } }, "event": true }, "MedicalScribeChannelDefinition": { "type": "structure", "required": [ "channelId", "participantRole" ], "members": { "channelId": { "shape": "MedicalScribeChannelId" }, "participantRole": { "shape": "MedicalScribeParticipantRole" } } }, "MedicalScribeChannelDefinitions": { "type": "list", "member": { "shape": "MedicalScribeChannelDefinition" }, "max": 2, "min": 2 }, "MedicalScribeChannelId": { "type": "integer", "box": true, "max": 1, "min": 0 }, "MedicalScribeConfigurationEvent": { "type": "structure", "required": [ "postStreamActionSettings" ], "members": { "postStreamActionSettings": { "shape": "MedicalScribePostStreamActionSettings" }, "channelDefinitions": { "shape": "MedicalScribeChannelDefinitions" }, "encounterContext": { "shape": "EncounterContext" } }, "event": true }, "MedicalScribeInputStream": { "type": "structure", "members": { "audioEvent": { "shape": "MedicalScribeAudioEvent" }, "sessionControlEvent": { "shape": "MedicalScribeSessionControlEvent" }, "configurationEvent": { "shape": "MedicalScribeConfigurationEvent" } }, "eventstream": true }, "MedicalScribeLanguageCode": { "type": "string", "enum": [ "en-US" ] }, "MedicalScribeListeningSessionDetails": { "type": "structure", "members": { "sessionId": { "shape": "SessionId" }, "domainId": { "shape": "DomainId" }, "subscriptionId": { "shape": "SubscriptionId" }, "languageCode": { "shape": "MedicalScribeLanguageCode" }, "mediaSampleRateHertz": { "shape": "MedicalScribeMediaSampleRateHertz" }, "mediaEncoding": { "shape": "MedicalScribeMediaEncoding" }, "channelDefinitions": { "shape": "MedicalScribeChannelDefinitions" }, "postStreamActionSettings": { "shape": "MedicalScribePostStreamActionSettingsResponse" }, "postStreamActionResult": { "shape": "MedicalScribePostStreamActionsResult" }, "encounterContextProvided": { "shape": "NonNullBoolean" }, "streamStatus": { "shape": "MedicalScribeStreamStatus" }, "streamCreationTime": { "shape": "Timestamp" }, "streamEndTime": { "shape": "Timestamp" } } }, "MedicalScribeMediaEncoding": { "type": "string", "enum": [ "pcm", "flac" ] }, "MedicalScribeMediaSampleRateHertz": { "type": "integer", "box": true, "max": 48000, "min": 8000 }, "MedicalScribeOutputStream": { "type": "structure", "members": { "transcriptEvent": { "shape": "MedicalScribeTranscriptEvent" }, "internalFailureException": { "shape": "InternalServerException" }, "validationException": { "shape": "ValidationException" } }, "eventstream": true }, "MedicalScribeParticipantRole": { "type": "string", "enum": [ "PATIENT", "CLINICIAN" ] }, "MedicalScribePostStreamActionSettings": { "type": "structure", "required": [ "outputS3Uri", "clinicalNoteGenerationSettings" ], "members": { "outputS3Uri": { "shape": "S3Uri" }, "clinicalNoteGenerationSettings": { "shape": "ClinicalNoteGenerationSettings" } } }, "MedicalScribePostStreamActionSettingsResponse": { "type": "structure", "required": [ "outputS3Uri", "clinicalNoteGenerationSettings" ], "members": { "outputS3Uri": { "shape": "S3Uri" }, "clinicalNoteGenerationSettings": { "shape": "ClinicalNoteGenerationSettingsResponse" } } }, "MedicalScribePostStreamActionsResult": { "type": "structure", "members": { "clinicalNoteGenerationResult": { "shape": "ClinicalNoteGenerationResult" } } }, "MedicalScribeSessionControlEvent": { "type": "structure", "members": { "type": { "shape": "MedicalScribeSessionControlEventType" } }, "event": true }, "MedicalScribeSessionControlEventType": { "type": "string", "enum": [ "END_OF_SESSION" ] }, "MedicalScribeStreamStatus": { "type": "string", "enum": [ "IN_PROGRESS", "PAUSED", "FAILED", "COMPLETED" ] }, "MedicalScribeTranscriptEvent": { "type": "structure", "members": { "transcriptSegment": { "shape": "MedicalScribeTranscriptSegment" } }, "event": true }, "MedicalScribeTranscriptSegment": { "type": "structure", "members": { "segmentId": { "shape": "String" }, "audioBeginOffset": { "shape": "AudioOffset" }, "audioEndOffset": { "shape": "AudioOffset" }, "isPartial": { "shape": "NonNullBoolean" }, "channelId": { "shape": "String" }, "content": { "shape": "String" } } }, "NonEmptyString": { "type": "string", "pattern": ".*[\\s\\S]*\\S[\\s\\S]*.*" }, "NonNullBoolean": { "type": "boolean", "box": true }, "NoteTemplateSettings": { "type": "structure", "members": { "managedTemplate": { "shape": "ManagedTemplate" }, "customTemplate": { "shape": "CustomTemplate" } }, "union": true }, "NoteTemplateSettingsResponse": { "type": "structure", "members": { "managedTemplate": { "shape": "ManagedTemplateResponse" }, "customTemplate": { "shape": "CustomTemplateResponse" } }, "union": true }, "OutputDataConfig": { "type": "structure", "required": [ "s3OutputPath" ], "members": { "s3OutputPath": { "shape": "S3Uri" } } }, "PatientInsightsEncounterContext": { "type": "structure", "required": [ "encounterReason" ], "members": { "encounterReason": { "shape": "PatientInsightsEncounterContextEncounterReasonString" } } }, "PatientInsightsEncounterContextEncounterReasonString": { "type": "string", "max": 256, "min": 1, "pattern": "[a-zA-Z0-9 .,-]+", "sensitive": true }, "PatientInsightsPatientContext": { "type": "structure", "required": [ "patientId" ], "members": { "patientId": { "shape": "SensitiveNonEmptyString" }, "dateOfBirth": { "shape": "SensitiveIsoDateString" }, "pronouns": { "shape": "Pronouns" } } }, "PostStreamArtifactGenerationStatus": { "type": "string", "enum": [ "IN_PROGRESS", "FAILED", "COMPLETED" ] }, "Pronouns": { "type": "string", "enum": [ "HE_HIM", "SHE_HER", "THEY_THEM" ], "sensitive": true }, "ProviderRole": { "type": "string", "enum": [ "CLINICIAN" ] }, "RequestId": { "type": "string", "max": 256, "min": 1 }, "ResourceNotFoundException": { "type": "structure", "members": { "message": { "shape": "String" } }, "error": { "httpStatusCode": 404, "senderFault": true }, "exception": true }, "S3Source": { "type": "structure", "required": [ "uri" ], "members": { "uri": { "shape": "S3Uri" } } }, "S3Sources": { "type": "list", "member": { "shape": "S3Source" }, "max": 10, "min": 0 }, "S3Uri": { "type": "string", "max": 1024, "min": 0, "pattern": "s3:\/\/[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](\/.*)?" }, "SensitiveAlphanumericString": { "type": "string", "pattern": "[a-zA-Z0-9]+", "sensitive": true }, "SensitiveIsoDateString": { "type": "string", "pattern": "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])", "sensitive": true }, "SensitiveMarkdownString": { "type": "string", "pattern": "[a-zA-Z0-9\\s\\*_\\-#\\[\\]\\(\\)\\.,:;!?'\"`<>~\/]+", "sensitive": true }, "SensitiveNonEmptyString": { "type": "string", "pattern": ".*[\\s\\S]*\\S[\\s\\S]*.*", "sensitive": true }, "ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "shape": "String" } }, "error": { "httpStatusCode": 402, "senderFault": true }, "exception": true }, "SessionId": { "type": "string", "max": 36, "min": 36, "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}.*" }, "Specialty": { "type": "string", "enum": [ "PRIMARY_CARE" ] }, "StartMedicalScribeListeningSessionInput": { "type": "structure", "required": [ "sessionId", "domainId", "subscriptionId", "languageCode", "mediaSampleRateHertz", "mediaEncoding" ], "members": { "sessionId": { "shape": "SessionId", "location": "header", "locationName": "x-amzn-medscribe-session-id" }, "domainId": { "shape": "DomainId", "location": "header", "locationName": "x-amzn-medscribe-domain-id" }, "subscriptionId": { "shape": "SubscriptionId", "location": "header", "locationName": "x-amzn-medscribe-subscription-id" }, "languageCode": { "shape": "MedicalScribeLanguageCode", "location": "header", "locationName": "x-amzn-medscribe-language-code" }, "mediaSampleRateHertz": { "shape": "MedicalScribeMediaSampleRateHertz", "location": "header", "locationName": "x-amzn-medscribe-sample-rate" }, "mediaEncoding": { "shape": "MedicalScribeMediaEncoding", "location": "header", "locationName": "x-amzn-medscribe-media-encoding" }, "inputStream": { "shape": "MedicalScribeInputStream" } }, "payload": "inputStream" }, "StartMedicalScribeListeningSessionOutput": { "type": "structure", "members": { "sessionId": { "shape": "SessionId", "location": "header", "locationName": "x-amzn-medscribe-session-id" }, "domainId": { "shape": "DomainId", "location": "header", "locationName": "x-amzn-medscribe-domain-id" }, "subscriptionId": { "shape": "SubscriptionId", "location": "header", "locationName": "x-amzn-medscribe-subscription-id" }, "requestId": { "shape": "RequestId", "location": "header", "locationName": "x-amzn-request-id" }, "languageCode": { "shape": "MedicalScribeLanguageCode", "location": "header", "locationName": "x-amzn-medscribe-language-code" }, "mediaSampleRateHertz": { "shape": "MedicalScribeMediaSampleRateHertz", "location": "header", "locationName": "x-amzn-medscribe-sample-rate" }, "mediaEncoding": { "shape": "MedicalScribeMediaEncoding", "location": "header", "locationName": "x-amzn-medscribe-media-encoding" }, "responseStream": { "shape": "MedicalScribeOutputStream" } }, "payload": "responseStream" }, "StartPatientInsightsJobRequest": { "type": "structure", "required": [ "domainId", "patientContext", "insightsContext", "encounterContext", "userContext", "inputDataConfig", "outputDataConfig" ], "members": { "domainId": { "shape": "DomainId", "location": "uri", "locationName": "domainId" }, "patientContext": { "shape": "PatientInsightsPatientContext" }, "insightsContext": { "shape": "InsightsContext" }, "encounterContext": { "shape": "PatientInsightsEncounterContext" }, "userContext": { "shape": "UserContext" }, "inputDataConfig": { "shape": "InputDataConfig" }, "outputDataConfig": { "shape": "OutputDataConfig" }, "clientToken": { "shape": "NonEmptyString", "idempotencyToken": true } } }, "StartPatientInsightsJobResponse": { "type": "structure", "required": [ "jobArn", "jobId" ], "members": { "jobArn": { "shape": "JobArn" }, "jobId": { "shape": "JobId" }, "creationTime": { "shape": "SyntheticTimestamp_date_time" } } }, "String": { "type": "string" }, "SubscriptionArn": { "type": "string", "pattern": "arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain\/(hai-|dom-)[a-z0-9]+\/subscription\/sub-[a-zA-Z0-9]{21}" }, "SubscriptionDescription": { "type": "structure", "required": [ "domainId", "subscriptionId", "arn", "status", "createdAt", "lastUpdatedAt" ], "members": { "domainId": { "shape": "DomainId" }, "subscriptionId": { "shape": "SubscriptionId" }, "arn": { "shape": "SubscriptionArn" }, "status": { "shape": "SubscriptionStatus" }, "createdAt": { "shape": "Timestamp" }, "lastUpdatedAt": { "shape": "Timestamp" }, "activatedAt": { "shape": "Timestamp" }, "deactivatedAt": { "shape": "Timestamp" } } }, "SubscriptionId": { "type": "string", "max": 25, "min": 25, "pattern": "sub-[a-zA-Z0-9]{21}" }, "SubscriptionList": { "type": "list", "member": { "shape": "SubscriptionDescription" } }, "SubscriptionStatus": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "DELETED" ] }, "SyntheticTimestamp_date_time": { "type": "timestamp", "timestampFormat": "iso8601" }, "TagKey": { "type": "string", "max": 128, "min": 1 }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 50, "min": 1 }, "TagMap": { "type": "map", "key": { "shape": "TagKey" }, "value": { "shape": "TagValue" } }, "TagResourceInput": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "shape": "String", "location": "uri", "locationName": "resourceArn" }, "tags": { "shape": "TagMap" } } }, "TagValue": { "type": "string", "max": 256, "min": 0 }, "TemplateInstructions": { "type": "list", "member": { "shape": "TemplateSectionInstruction" }, "max": 20, "min": 1 }, "TemplateSectionInstruction": { "type": "structure", "required": [ "sectionHeader", "sectionInstruction" ], "members": { "sectionHeader": { "shape": "SensitiveAlphanumericString" }, "sectionInstruction": { "shape": "SensitiveMarkdownString" } } }, "ThrottlingException": { "type": "structure", "members": { "message": { "shape": "String" } }, "error": { "httpStatusCode": 429, "senderFault": true }, "exception": true, "retryable": { "throttling": true } }, "Timestamp": { "type": "timestamp" }, "UntagResourceInput": { "type": "structure", "required": [ "resourceArn", "tagKeys" ], "members": { "resourceArn": { "shape": "String", "location": "uri", "locationName": "resourceArn" }, "tagKeys": { "shape": "TagKeyList", "location": "querystring", "locationName": "tagKeys" } } }, "Uri": { "type": "string", "min": 1, "pattern": ".*(s3:\/\/|http(s*):\/\/).+.*" }, "UserContext": { "type": "structure", "required": [ "role", "userId" ], "members": { "role": { "shape": "ProviderRole" }, "userId": { "shape": "SensitiveNonEmptyString" }, "specialty": { "shape": "Specialty" } } }, "ValidationException": { "type": "structure", "members": { "message": { "shape": "String" } }, "error": { "httpStatusCode": 400, "senderFault": true }, "exception": true }, "WebAppConfiguration": { "type": "structure", "required": [ "ehrRole", "idcApplicationId", "idcRegion" ], "members": { "ehrRole": { "shape": "WebAppConfigurationEhrRoleString" }, "idcApplicationId": { "shape": "WebAppConfigurationIdcApplicationIdString" }, "idcRegion": { "shape": "WebAppConfigurationIdcRegionString" } } }, "WebAppConfigurationEhrRoleString": { "type": "string", "max": 2048, "min": 1, "pattern": "arn:aws:iam::[0-9]{12}:role\/.+" }, "WebAppConfigurationIdcApplicationIdString": { "type": "string", "max": 256, "min": 1 }, "WebAppConfigurationIdcRegionString": { "type": "string", "max": 64, "min": 1 }, "WebAppUrl": { "type": "string" } } }