ConnectHealth / Client / get_patient_insights_job

get_patient_insights_job

ConnectHealth.Client.get_patient_insights_job(**kwargs)

Get details of a started patient insights job.

See also: AWS API Documentation

Request Syntax

response = client.get_patient_insights_job(
    domainId='string',
    jobId='string'
)
Parameters:

  • domainId (string) – [REQUIRED]

  • jobId (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'jobArn': 'string',
    'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
    'creationTime': datetime(2015, 1, 1),
    'updatedTime': datetime(2015, 1, 1),
    'insightsOutput': {
        'uri': 'string'
    },
    'statusDetails': 'string',
    'patientContext': {
        'patientId': 'string',
        'dateOfBirth': 'string',
        'pronouns': 'HE_HIM'|'SHE_HER'|'THEY_THEM'
    },
    'insightsContext': {
        'insightsType': 'PRE_VISIT'
    },
    'encounterContext': {
        'encounterReason': 'string'
    },
    'userContext': {
        'role': 'CLINICIAN',
        'userId': 'string',
        'specialty': 'PRIMARY_CARE'
    },
    'inputDataConfig': {
        'fhirServer': {
            'fhirEndpoint': 'string',
            'oauthToken': 'string'
        },
        's3Sources': [
            {
                'uri': 'string'
            },
        ]
    },
    'outputDataConfig': {
        's3OutputPath': 'string'
    }
}

Response Structure

  • (dict) –

    • jobId (string) –

    • jobArn (string) –

    • jobStatus (string) –

    • creationTime (datetime) –

      Date and time the patient insights job was submitted.

    • updatedTime (datetime) –

      Date and time the patient insights job was last updated.

    • insightsOutput (dict) –

      • uri (string) –

    • statusDetails (string) –

      Contains information about the status of a job.

    • patientContext (dict) –

      • patientId (string) –

        Unique identifier of the patient

      • dateOfBirth (string) –

        Date of birth of the patient.

      • pronouns (string) –

        Pronouns preferred by the patient.

    • insightsContext (dict) –

      • insightsType (string) –

    • encounterContext (dict) –

      • encounterReason (string) –

        Chief complaint for the visit

    • userContext (dict) –

      • role (string) –

      • userId (string) –

        Unique identifier of the user

      • specialty (string) –

    • inputDataConfig (dict) –

      • fhirServer (dict) –

        FHIR server configuration to retrieve patient data.

        • fhirEndpoint (string) –

          FHIR server endpoint URL for accessing patient data.

        • oauthToken (string) –

          OAuth token for authenticating with the FHIR server.

      • s3Sources (list) –

        List of S3 sources containing patient data.

        • (dict) –

          S3 uri for input data source

          • uri (string) –

            The S3 URI.

    • outputDataConfig (dict) –

      • s3OutputPath (string) –

        S3 URI where the insights output will be stored.

Exceptions