[Azure AI - Health Insights] - Typespec revision for Health Insights API V3 (Radiology Insights)

specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp

@@ -30,19 +30,19 @@ A given identifier for the patient. Has to be unique across all patients in a si
   @doc("""
 Patient structured information, including demographics and known structured clinical information.
 """)
-  info?: PatientInfo;
+  details?: PatientDetails;
 
   @doc("Patient encounters/visits.")
-  encounters?: Array<Encounter>;
+  encounters?: Array<PatientEncounter>;
 
   @doc("Patient unstructured clinical data, given as documents.")
   patientDocuments?: Array<PatientDocument>;
 }
 
 @doc("Patient structured information, including demographics and known structured clinical information.")
-model PatientInfo {
+model PatientDetails {
   @doc("The patient's sex.")
-  sex?: PatientInfoSex;
+  sex?: PatientSex;
 
   @doc("The patient's date of birth.")
   birthDate?: plainDate;
@@ -53,7 +53,7 @@ model PatientInfo {
 
 #suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
 @doc("The patient's sex.")
-enum PatientInfoSex {
+enum PatientSex {
   Female: "female",
   Male: "male",
   Unspecified: "unspecified",
@@ -111,7 +111,7 @@ model PatientDocument {
   language?: string;
 
   @doc("The date and time when the document was created.")
-  createdDateTime?: utcDateTime;
+  createdAt?: utcDateTime;
 
   @doc("Document author(s)")
   authors?: Array<DocumentAuthor>;
@@ -137,7 +137,7 @@ model DocumentAdministrativeMetadata {
 }
 
 @doc("visit/encounter information")
-model Encounter {
+model PatientEncounter {
   @doc("The id of the visit.")
   id: string;
 

specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp

@@ -5,45 +5,45 @@ using TypeSpec.Rest;
 
 namespace AzureHealthInsights;
 
-/**
- * Provides status details for long running operations.
- * @template TStatusResult The type of the operation status result.
- * @template TStatusError The type of the operation status error. If not provided, the default error is used.
- */
-@doc("Provides status details for long running operations.")
-model HealthInsightsOperationStatus<
-  TStatusResult = never,
-  TStatusError = Foundations.Error
-> {
-  @key("operationId")
-  @doc("The unique ID of the operation.")
-  @visibility("read")
-  id: Azure.Core.uuid;
-
-  @doc("The status of the operation")
-  @visibility("read")
-  @lroStatus
-  status: JobStatus;
-
-  @doc("The date and time when the processing job was created.")
-  @visibility("read")
-  createdDateTime?: utcDateTime;
-
-  @doc("The date and time when the processing job is set to expire.")
-  @visibility("read")
-  expirationDateTime?: utcDateTime;
-
-  @doc("The date and time when the processing job was last updated.")
-  @visibility("read")
-  lastUpdateDateTime?: utcDateTime;
-
-  @doc("Error object that describes the error when status is \"Failed\".")
-  error?: TStatusError;
-
-  @doc("The result of the operation.")
-  @lroResult
-  result?: TStatusResult;
-}
+// /**
+//  * Provides status details for long running operations.
+//  * @template TStatusResult The type of the operation status result.
+//  * @template TStatusError The type of the operation status error. If not provided, the default error is used.
+//  */
+// @doc("Provides status details for long running operations.")
+// model HealthInsightsOperationStatus<
+//   TStatusResult = never,
+//   TStatusError = Foundations.Error
+// > {
+//   @key("operationId")
+//   @doc("The unique ID of the operation.")
+//   @visibility("read")
+//   id: Azure.Core.uuid;
+
+//   @doc("The status of the operation")
+//   @visibility("read")
+//   @lroStatus
+//   status: JobStatus;
+
+//   @doc("The date and time when the processing job was created.")
+//   @visibility("read")
+//   createdDateTime?: utcDateTime;
+
+//   @doc("The date and time when the processing job is set to expire.")
+//   @visibility("read")
+//   expirationDateTime?: utcDateTime;
+
+//   @doc("The date and time when the processing job was last updated.")
+//   @visibility("read")
+//   lastUpdateDateTime?: utcDateTime;
+
+//   @doc("Error object that describes the error when status is \"Failed\".")
+//   error?: TStatusError;
+
+//   @doc("The result of the operation.")
+//   @lroResult
+//   result?: TStatusResult;
+// }
 ////////////////// Inference //////////////////
 @doc("An inference made by the model regarding a patient.")
 model Inference {

specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp

@@ -1,7 +1,49 @@
+using TypeSpec.Http;
 using TypeSpec.Rest;
+using Azure.Core;
 
 namespace AzureHealthInsights;
 
+/**
+ * Provides HealthInsights resource details for long running operations.
+ * @template TRequest The type of the operation request data.
+ * @template TResult The type of the operation result.
+ * @template TStatusError The type of the operation status error. If not provided, the default error is used.
+ */
+// @TypeSpec.Versioning.added(AzureHealthInsights.ApiVersion.v2024_04_01)
+@doc("Provides status details for long running operations.")
+model HealthInsightsJobBase {
+  @key("id")
+  @doc("The unique ID of the job.")
+  @visibility("read")
+  @maxLength(36)
+  @minLength(3)
+  @pattern("^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$")
+  @path
+  id: string;
+
+  @doc("The status of the job.")
+  @visibility("read")
+  @lroStatus
+  status: JobStatus;
+
+  @doc("The date and time when the processing job was created.")
+  @visibility("read")
+  createdAt?: utcDateTime;
+
+  @doc("The date and time when the processing job is set to expire.")
+  @visibility("read")
+  expiresAt?: utcDateTime;
+
+  @doc("The date and time when the processing job was last updated.")
+  @visibility("read")
+  updatedAt?: utcDateTime;
+
+  @doc("Error object that describes the error when status is \"Failed\".")
+  @visibility("read")
+  error?: Foundations.Error;
+}
+
 @doc("ConditionStage")
 model ConditionStage {
   @doc("""

specification/ai/HealthInsights/HealthInsights.Common/primitives.tsp

@@ -4,52 +4,52 @@ using Azure.Core.Traits;
 
 namespace AzureHealthInsights;
 
-#suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "This is a template"
-@doc("Long running RPC operation template")
-op HealthInsightsLongRunningRpcOperation<
-  TParams extends TypeSpec.Reflection.Model,
-  TResponse extends TypeSpec.Reflection.Model,
-  TModelResult extends TypeSpec.Reflection.Model,
-  Traits extends TypeSpec.Reflection.Model = {}
-> is Azure.Core.RpcOperation<
-  TParams & RepeatabilityRequestHeaders,
-  Foundations.AcceptedResponse<HealthInsightsLongRunningStatusLocation<TResponse> &
-    Foundations.RetryAfterHeader> &
-    RepeatabilityResponseHeaders &
-    HealthInsightsOperationStatus<TModelResult>,
-  Traits
->;
+// #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "This is a template"
+// @doc("Long running RPC operation template")
+// op HealthInsightsLongRunningRpcOperation<
+//   TParams extends TypeSpec.Reflection.Model,
+//   TResponse extends TypeSpec.Reflection.Model,
+//   TModelResult extends TypeSpec.Reflection.Model,
+//   Traits extends TypeSpec.Reflection.Model = {}
+// > is Azure.Core.RpcOperation<
+//   TParams & RepeatabilityRequestHeaders,
+//   Foundations.AcceptedResponse<HealthInsightsLongRunningStatusLocation<TResponse> &
+//     Foundations.RetryAfterHeader> &
+//     RepeatabilityResponseHeaders &
+//     HealthInsightsOperationStatus<TModelResult>,
+//   Traits
+// >;
 
-#suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "This is a template"
-@doc("Long running Pool operation template")
-op HealthInsightsLongRunningPollOperation<TResult extends TypeSpec.Reflection.Model> is Azure.Core.RpcOperation<
-  {
-    @doc("A processing job identifier.")
-    @path("id")
-    id: Azure.Core.uuid;
-  },
-  TResult,
-  HealthInsightsRetryAfterTrait
->;
+// #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "This is a template"
+// @doc("Long running Pool operation template")
+// op HealthInsightsLongRunningPollOperation<TResult extends TypeSpec.Reflection.Model> is Azure.Core.RpcOperation<
+//   {
+//     @doc("A processing job identifier.")
+//     @path("id")
+//     id: Azure.Core.uuid;
+//   },
+//   TResult,
+//   HealthInsightsRetryAfterTrait
+// >;
 
-/**
- * Metadata for long running operation status monitor locations.
- * @template TStatusResult The type of the operation status result.
- */
-@doc("Metadata for long running operation status monitor locations")
-model HealthInsightsLongRunningStatusLocation<TStatusResult = never> {
-  @pollingLocation
-  @doc("The location for monitoring the operation state.")
-  @TypeSpec.Http.header("Operation-Location")
-  operationLocation: HealthInsightsResourceLocation<HealthInsightsOperationStatus<TStatusResult>>;
-}
+// /**
+//  * Metadata for long running operation status monitor locations.
+//  * @template TStatusResult The type of the operation status result.
+//  */
+// @doc("Metadata for long running operation status monitor locations")
+// model HealthInsightsLongRunningStatusLocation<TStatusResult = never> {
+//   @pollingLocation
+//   @doc("The location for monitoring the operation state.")
+//   @TypeSpec.Http.header("Operation-Location")
+//   operationLocation: HealthInsightsResourceLocation<HealthInsightsOperationStatus<TStatusResult>>;
+// }
 
-/**
- * A URL that points to a resource.
- * @template TResource The type of resource that the URL points to.
- */
-@doc("The location of an instance of {name}", TResource)
-scalar HealthInsightsResourceLocation<TResource extends {}> extends url;
+// /**
+//  * A URL that points to a resource.
+//  * @template TResource The type of resource that the URL points to.
+//  */
+// @doc("The location of an instance of {name}", TResource)
+// scalar HealthInsightsResourceLocation<TResource extends {}> extends url;
 
 @trait("HealthInsightsRetryAfterTrait")
 @doc("Health Insights retry after trait")
@@ -60,3 +60,38 @@ model HealthInsightsRetryAfterTrait {
     response: Foundations.RetryAfterHeader;
   };
 }
+@doc("Provides the 'x-ms-request-id' header to enable request correlation in responses.")
+@trait("RequestIdResponseHeader")
+model RequestIdResponseHeaderTrait {
+  @doc("An opaque, globally-unique, server-generated string identifier for the request.")
+  requestId: {
+    @traitLocation(TraitLocation.Response)
+    response: RequestIdResponseHeader;
+  };
+}
+
+alias ExpandQueryParams = QueryParametersTrait<{
+  @doc("A comma separated list of related properties to be included in line with the job.")
+  @query({
+    format: "csv",
+  })
+  expand?: ExpandQueryParamsType;
+}>;
+
+@doc("Supported properties to be included in line with the job.")
+enum ExpandQueryParamsType {
+  @doc("Use this value to expand the job with jobData property.")
+  JobData: "jobData",
+}
+
+alias ServiceTraits = NoRepeatableRequests &
+  NoConditionalRequests &
+  NoClientRequestId &
+  HealthInsightsRetryAfterTrait &
+  RequestIdResponseHeaderTrait &
+  ExpandQueryParams;
+
+alias HealthInsightsOperations = ResourceOperations<
+  ServiceTraits,
+  Azure.Core.Foundations.ErrorResponse
+>;