ActivateSubscription

$result = $client->activateSubscription([/* ... */]);
$promise = $client->activateSubscriptionAsync([/* ... */]);

Activates a Subscription to enable billing for a user.

Parameter Syntax

$result = $client->activateSubscription([
    'domainId' => '<string>', // REQUIRED
    'subscriptionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'subscription' => [
        'activatedAt' => <DateTime>,
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deactivatedAt' => <DateTime>,
        'domainId' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'status' => 'ACTIVE|INACTIVE|DELETED',
        'subscriptionId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ValidationException:

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

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates a new Domain for managing HealthAgent resources.

Parameter Syntax

$result = $client->createDomain([
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'webAppSetupConfiguration' => [
        'ehrRole' => '<string>', // REQUIRED
        'idcInstanceId' => '<string>', // REQUIRED
        'idcRegion' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'domainId' => '<string>',
    'encryptionContext' => [
        'encryptionType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
        'kmsKeyArn' => '<string>',
    ],
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'status' => 'ACTIVE|DELETING|DELETED',
    'webAppConfiguration' => [
        'ehrRole' => '<string>',
        'idcApplicationId' => '<string>',
        'idcRegion' => '<string>',
    ],
    'webAppUrl' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The request exceeds a service quota.

CreateSubscription

$result = $client->createSubscription([/* ... */]);
$promise = $client->createSubscriptionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createSubscription([
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'activatedAt' => <DateTime>,
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'deactivatedAt' => <DateTime>,
    'domainId' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'status' => 'ACTIVE|INACTIVE|DELETED',
    'subscriptionId' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ValidationException:

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

ServiceQuotaExceededException:

The request exceeds a service quota.

DeactivateSubscription

$result = $client->deactivateSubscription([/* ... */]);
$promise = $client->deactivateSubscriptionAsync([/* ... */]);

Deactivates a Subscription to stop billing for a user.

Parameter Syntax

$result = $client->deactivateSubscription([
    'domainId' => '<string>', // REQUIRED
    'subscriptionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'subscription' => [
        'activatedAt' => <DateTime>,
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deactivatedAt' => <DateTime>,
        'domainId' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'status' => 'ACTIVE|INACTIVE|DELETED',
        'subscriptionId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ValidationException:

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

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

Deletes a Domain and all associated resources.

Parameter Syntax

$result = $client->deleteDomain([
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'domainId' => '<string>',
    'status' => 'ACTIVE|DELETING|DELETED',
]

Result Details

Errors

ResourceNotFoundException:

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

GetDomain

$result = $client->getDomain([/* ... */]);
$promise = $client->getDomainAsync([/* ... */]);

Retrieves information about a Domain.

Parameter Syntax

$result = $client->getDomain([
    'domainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'domainId' => '<string>',
    'encryptionContext' => [
        'encryptionType' => 'AWS_OWNED_KEY|CUSTOMER_MANAGED_KEY',
        'kmsKeyArn' => '<string>',
    ],
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'status' => 'ACTIVE|DELETING|DELETED',
    'tags' => ['<string>', ...],
    'webAppConfiguration' => [
        'ehrRole' => '<string>',
        'idcApplicationId' => '<string>',
        'idcRegion' => '<string>',
    ],
    'webAppUrl' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

GetMedicalScribeListeningSession

$result = $client->getMedicalScribeListeningSession([/* ... */]);
$promise = $client->getMedicalScribeListeningSessionAsync([/* ... */]);

Retrieves details about an existing Medical Scribe listening session

Parameter Syntax

$result = $client->getMedicalScribeListeningSession([
    'domainId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
    'subscriptionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'medicalScribeListeningSessionDetails' => [
        'channelDefinitions' => [
            [
                'channelId' => <integer>,
                'participantRole' => 'PATIENT|CLINICIAN',
            ],
            // ...
        ],
        'domainId' => '<string>',
        'encounterContextProvided' => true || false,
        'languageCode' => 'en-US',
        'mediaEncoding' => 'pcm|flac',
        'mediaSampleRateHertz' => <integer>,
        'postStreamActionResult' => [
            'clinicalNoteGenerationResult' => [
                'afterVisitSummaryResult' => [
                    'failureReason' => '<string>',
                    'outputLocation' => '<string>',
                    'status' => 'IN_PROGRESS|FAILED|COMPLETED',
                ],
                'noteResult' => [
                    'failureReason' => '<string>',
                    'outputLocation' => '<string>',
                    'status' => 'IN_PROGRESS|FAILED|COMPLETED',
                ],
                'transcriptResult' => [
                    'failureReason' => '<string>',
                    'outputLocation' => '<string>',
                    'status' => 'IN_PROGRESS|FAILED|COMPLETED',
                ],
            ],
        ],
        'postStreamActionSettings' => [
            'clinicalNoteGenerationSettings' => [
                'noteTemplateSettings' => [
                    'customTemplate' => [
                        'templateType' => 'HISTORY_AND_PHYSICAL|GIRPP|DAP|SIRP|BIRP|BEHAVIORAL_SOAP',
                    ],
                    'managedTemplate' => [
                        'templateType' => 'HISTORY_AND_PHYSICAL|GIRPP|DAP|SIRP|BIRP|BEHAVIORAL_SOAP|PHYSICAL_SOAP',
                    ],
                ],
            ],
            'outputS3Uri' => '<string>',
        ],
        'sessionId' => '<string>',
        'streamCreationTime' => <DateTime>,
        'streamEndTime' => <DateTime>,
        'streamStatus' => 'IN_PROGRESS|PAUSED|FAILED|COMPLETED',
        'subscriptionId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ThrottlingException:

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

ServiceQuotaExceededException:

The request exceeds a service quota.

GetPatientInsightsJob

$result = $client->getPatientInsightsJob([/* ... */]);
$promise = $client->getPatientInsightsJobAsync([/* ... */]);

Get details of a started patient insights job.

Parameter Syntax

$result = $client->getPatientInsightsJob([
    'domainId' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'encounterContext' => [
        'encounterReason' => '<string>',
    ],
    'inputDataConfig' => [
        'fhirServer' => [
            'fhirEndpoint' => '<string>',
            'oauthToken' => '<string>',
        ],
        's3Sources' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
    ],
    'insightsContext' => [
        'insightsType' => 'PRE_VISIT',
    ],
    'insightsOutput' => [
        'uri' => '<string>',
    ],
    'jobArn' => '<string>',
    'jobId' => '<string>',
    'jobStatus' => 'SUBMITTED|IN_PROGRESS|FAILED|SUCCEEDED',
    'outputDataConfig' => [
        's3OutputPath' => '<string>',
    ],
    'patientContext' => [
        'dateOfBirth' => '<string>',
        'patientId' => '<string>',
        'pronouns' => 'HE_HIM|SHE_HER|THEY_THEM',
    ],
    'statusDetails' => '<string>',
    'updatedTime' => <DateTime>,
    'userContext' => [
        'role' => 'CLINICIAN',
        'specialty' => 'PRIMARY_CARE',
        'userId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ValidationException:

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

ThrottlingException:

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

GetSubscription

$result = $client->getSubscription([/* ... */]);
$promise = $client->getSubscriptionAsync([/* ... */]);

Retrieves information about a Subscription.

Parameter Syntax

$result = $client->getSubscription([
    'domainId' => '<string>', // REQUIRED
    'subscriptionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'subscription' => [
        'activatedAt' => <DateTime>,
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deactivatedAt' => <DateTime>,
        'domainId' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'status' => 'ACTIVE|INACTIVE|DELETED',
        'subscriptionId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ValidationException:

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

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Lists Domains for a given account.

Parameter Syntax

$result = $client->listDomains([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|DELETING|DELETED',
]);

Parameter Details

Result Syntax

[
    'domains' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'domainId' => '<string>',
            'name' => '<string>',
            'status' => 'ACTIVE|DELETING|DELETED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListSubscriptions

$result = $client->listSubscriptions([/* ... */]);
$promise = $client->listSubscriptionsAsync([/* ... */]);

Lists all Subscriptions within a Domain.

Parameter Syntax

$result = $client->listSubscriptions([
    'domainId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'subscriptions' => [
        [
            'activatedAt' => <DateTime>,
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deactivatedAt' => <DateTime>,
            'domainId' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'status' => 'ACTIVE|INACTIVE|DELETED',
            'subscriptionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ValidationException:

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

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags associated with the specified resource

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

StartPatientInsightsJob

$result = $client->startPatientInsightsJob([/* ... */]);
$promise = $client->startPatientInsightsJobAsync([/* ... */]);

Starts a new patient insights job.

Parameter Syntax

$result = $client->startPatientInsightsJob([
    'clientToken' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'encounterContext' => [ // REQUIRED
        'encounterReason' => '<string>', // REQUIRED
    ],
    'inputDataConfig' => [ // REQUIRED
        'fhirServer' => [
            'fhirEndpoint' => '<string>', // REQUIRED
            'oauthToken' => '<string>',
        ],
        's3Sources' => [
            [
                'uri' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'insightsContext' => [ // REQUIRED
        'insightsType' => 'PRE_VISIT', // REQUIRED
    ],
    'outputDataConfig' => [ // REQUIRED
        's3OutputPath' => '<string>', // REQUIRED
    ],
    'patientContext' => [ // REQUIRED
        'dateOfBirth' => '<string>',
        'patientId' => '<string>', // REQUIRED
        'pronouns' => 'HE_HIM|SHE_HER|THEY_THEM',
    ],
    'userContext' => [ // REQUIRED
        'role' => 'CLINICIAN', // REQUIRED
        'specialty' => 'PRIMARY_CARE',
        'userId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'jobArn' => '<string>',
    'jobId' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

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

AccessDeniedException:

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

ValidationException:

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

ThrottlingException:

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

ConflictException:

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates the specified tags with the specified resource

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified resource

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.