Class InferenceRequestDetails

Details of an inference request.

Inheritance

System.Object

InferenceRequestDetails

Namespace: Monai.Deploy.InformaticsGateway.Api.Rest

Assembly: Monai.Deploy.InformaticsGateway.Api.dll

Syntax

public class InferenceRequestDetails

Remarks

type> is required.

PatientID> is required if type is DicomUid.

studies> is required if type is DicomPatientId.

accessionNumber> is required if type is AccessionNumber.

Examples

{
    ...
    "details" : {
        "type": "DICOM_UID",
        "studies": [ ... ]
    }
    ...
} or

{
    ...
    "details" : {
        "type": "DICOM_PATIENT_ID",
        "PatientID": "..."
    }
    ...
} or

{
    ...
    "details" : {
        "type": "ACCESSION_NUMBER",
        "accessionNumber": [ ... ]
    }
    ...
} or

{
    ...
    "details" : {
        "type": "FHIR_RESOURCE",
        "resources": [ ... ]
    }
    ...
}

Properties

AccessionNumber

Gets or sets Access Number that is used to query the data source. Used when Type is AccessionNumber.

Declaration

[JsonPropertyName("accessionNumber")]
public IList<string> AccessionNumber { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

FhirAcceptHeader

Gets the HTTP Accept Header used for sending a request.

Declaration

public string FhirAcceptHeader { get; }

Property Value

Type	Description
System.String

FhirFormat

Gets or set the data format used when storing FHIR resources. Defaults to JSON.

Declaration

[JsonPropertyName("fhirFormat")]
public FhirStorageFormat FhirFormat { get; set; }

Property Value

Type	Description
FhirStorageFormat

FhirVersion

Gets or set the data format used when storing FHIR resources. Defaults to R3.

Declaration

[JsonPropertyName("fhirVersion")]
public FhirVersion FhirVersion { get; set; }

Property Value

Type	Description
FhirVersion

PatientId

Gets or sets Patient ID that is used to query the data source. Used when Type is DicomPatientId.

Declaration

[JsonPropertyName("PatientID")]
public string PatientId { get; set; }

Property Value

Type	Description
System.String

Resources

Gets or sets a list of FHIR resources to be retrived.

Declaration

[JsonPropertyName("resources")]
public IList<FhirResource> Resources { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<FhirResource>

Studies

Gets or sets the DICOM studies to be retrieved. Used when Type is DicomUid.

Declaration

[JsonPropertyName("studies")]
public IList<RequestedStudy> Studies { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<RequestedStudy>

Type

Gets or sets the type of the inference request.

Declaration

[JsonConverter(typeof(JsonStringEnumMemberConverter))]
[JsonPropertyName("type")]
public InferenceRequestType Type { get; set; }

Property Value

Type	Description
InferenceRequestType