Class ClinicalNoteGenerationSettings

java.lang.Object
software.amazon.awssdk.services.transcribestreaming.model.ClinicalNoteGenerationSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClinicalNoteGenerationSettings.Builder,ClinicalNoteGenerationSettings>
@Generated("software.amazon.awssdk:codegen") public final class ClinicalNoteGenerationSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClinicalNoteGenerationSettings.Builder,ClinicalNoteGenerationSettings>

The output configuration for aggregated transcript and clinical note generation.

See Also:

  • Method Details

    • outputBucketName

      public final String outputBucketName()

      The name of the Amazon S3 bucket where you want the output of Amazon Web Services HealthScribe post-stream analytics stored. Don't include the S3:// prefix of the specified bucket.

      HealthScribe outputs transcript and clinical note files under the prefix: S3://$output-bucket-name/healthscribe-streaming/session-id/post-stream-analytics/clinical-notes

      The role ResourceAccessRoleArn specified in the MedicalScribeConfigurationEvent must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console . See also Permissions Required for IAM User Roles .

      Returns:
      The name of the Amazon S3 bucket where you want the output of Amazon Web Services HealthScribe post-stream analytics stored. Don't include the S3:// prefix of the specified bucket.

      HealthScribe outputs transcript and clinical note files under the prefix: S3://$output-bucket-name/healthscribe-streaming/session-id/post-stream-analytics/clinical-notes

      The role ResourceAccessRoleArn specified in the MedicalScribeConfigurationEvent must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console . See also Permissions Required for IAM User Roles .

    • noteTemplate

      public final MedicalScribeNoteTemplate noteTemplate()

      Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL.

      • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.

      • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan.

      • BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.

      • SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.

      • DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.

      • BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      • PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      If the service returns an enum value that is not available in the current SDK version, noteTemplate will return MedicalScribeNoteTemplate.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from noteTemplateAsString().

      Returns:
      Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL.

      • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.

      • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan.

      • BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.

      • SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.

      • DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.

      • BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      • PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      See Also:

    • noteTemplateAsString

      public final String noteTemplateAsString()

      Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL.

      • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.

      • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan.

      • BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.

      • SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.

      • DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.

      • BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      • PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      If the service returns an enum value that is not available in the current SDK version, noteTemplate will return MedicalScribeNoteTemplate.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from noteTemplateAsString().

      Returns:
      Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL.

      • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.

      • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan.

      • BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.

      • SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.

      • DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.

      • BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      • PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.

      See Also:

    • toBuilder

      public ClinicalNoteGenerationSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClinicalNoteGenerationSettings.Builder,ClinicalNoteGenerationSettings>
      Returns:
      a builder for type T

    • builder

      public static ClinicalNoteGenerationSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClinicalNoteGenerationSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.