ConnectHealth / Client / start_patient_insights_job

start_patient_insights_job

ConnectHealth.Client.start_patient_insights_job(**kwargs)

Starts a new patient insights job.

See also: AWS API Documentation

Request Syntax

response = client.start_patient_insights_job(
    domainId='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'
    },
    clientToken='string'
)
Parameters:

  • domainId (string) – [REQUIRED]

  • patientContext (dict) –

    [REQUIRED]

    • patientId (string) – [REQUIRED]

      Unique identifier of the patient

    • dateOfBirth (string) –

      Date of birth of the patient.

    • pronouns (string) –

      Pronouns preferred by the patient.

  • insightsContext (dict) –

    [REQUIRED]

    • insightsType (string) – [REQUIRED]

  • encounterContext (dict) –

    [REQUIRED]

    • encounterReason (string) – [REQUIRED]

      Chief complaint for the visit

  • userContext (dict) –

    [REQUIRED]

    • role (string) – [REQUIRED]

    • userId (string) – [REQUIRED]

      Unique identifier of the user

    • specialty (string) –

  • inputDataConfig (dict) –

    [REQUIRED]

    • fhirServer (dict) –

      FHIR server configuration to retrieve patient data.

      • fhirEndpoint (string) – [REQUIRED]

        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) – [REQUIRED]

          The S3 URI.

  • outputDataConfig (dict) –

    [REQUIRED]

    • s3OutputPath (string) – [REQUIRED]

      S3 URI where the insights output will be stored.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'jobArn': 'string',
    'jobId': 'string',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • jobArn (string) –

    • jobId (string) –

    • creationTime (datetime) –

      Date and time the patient insights job was submitted.

Exceptions