GET Population Radiology Results

Developer Tools

GET api/v1/{EMRSystem}/Population/RadiologyResults

Returns the Radiology Results of all statuses for all patients for a given date range and filtered, optionally, by Locations (facilities).

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

Released

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

LocationList

Gets or sets the location list.

string

None

IncludeBody

Gets or sets a value indicating whether to include the body of the report or not.

boolean

None

UserId

Gets or sets the user identifier.

string

Required

FromDateTime

Gets or sets from date time.

date

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Gets or sets to date time.

date

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a List of population based radiology results.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

ResultId

Gets or sets the result identifier.

string

None.

ResultDateTime

Gets or sets the result date/time.

date

None.

BeginExamDateTime

Gets or sets the exam begin date/time.

date

None.

EndExamDateTime

Gets or sets the exam begin date/time.

date

None.

ResultStatus

Gets or sets the result status.

CodedObjectViewModel

None.

OrderId

Gets or sets the order identifier.

string

None.

ExamAccessionNumber

Gets or sets the exam accession number.

string

None.

ExamType

Gets or sets the exam type.

RadiologyExamTypeViewModel

None.

ReadingRadiologists

Gets or sets the reading radiologists.

Collection of ProviderViewModel

None.

Reports

Gets or sets the radiology reports.

Collection of RadiologyReportViewModel

None.

Patient

Gets or sets the patient.

BasePatientViewModel

None.

Encounter

Gets or sets the encounter.

EncounterViewModel

None.

CreatedUpdatedDateTime

Gets or sets the exam laterality.

date

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.PopulationRadiologyResultResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

Http Status Code 500 – Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 – Indicates that a request made to the underlying EMR server could not be completed.

 
Response Formats
Sample Message
Download Json Schema
[
  {
    "ResultId": "sample string 1",
    "ResultDateTime": "2018-02-15T14:55:15.2938497Z",
    "BeginExamDateTime": "2018-02-15T14:55:15.2938497Z",
    "EndExamDateTime": "2018-02-15T14:55:15.2938497Z",
    "ResultStatus": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "OrderId": "sample string 2",
    "ExamAccessionNumber": "sample string 3",
    "ExamType": {
      "ExamTypeId": "sample string 1",
      "ExamTypeName": "sample string 2",
      "CPT": "sample string 3"
    },
    "ReadingRadiologists": [
      {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      }
    ],
    "Reports": [
      {
        "ReportId": "sample string 1",
        "ReportType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "DocumentPointer": "sample string 2",
        "Storage": "sample string 3",
        "Format": "sample string 4",
        "Body": "sample string 5",
        "BodyLength": "sample string 6"
      },
      {
        "ReportId": "sample string 1",
        "ReportType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "DocumentPointer": "sample string 2",
        "Storage": "sample string 3",
        "Format": "sample string 4",
        "Body": "sample string 5",
        "BodyLength": "sample string 6"
      }
    ],
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "sample string 7",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2018-02-15T14:55:15.2938497Z",
      "DischargeDateTime": "2018-02-15T14:55:15.2938497Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    },
    "CreatedUpdatedDateTime": "2018-02-15T14:55:15.2938497Z"
  },
  {
    "ResultId": "sample string 1",
    "ResultDateTime": "2018-02-15T14:55:15.2938497Z",
    "BeginExamDateTime": "2018-02-15T14:55:15.2938497Z",
    "EndExamDateTime": "2018-02-15T14:55:15.2938497Z",
    "ResultStatus": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "OrderId": "sample string 2",
    "ExamAccessionNumber": "sample string 3",
    "ExamType": {
      "ExamTypeId": "sample string 1",
      "ExamTypeName": "sample string 2",
      "CPT": "sample string 3"
    },
    "ReadingRadiologists": [
      {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      }
    ],
    "Reports": [
      {
        "ReportId": "sample string 1",
        "ReportType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "DocumentPointer": "sample string 2",
        "Storage": "sample string 3",
        "Format": "sample string 4",
        "Body": "sample string 5",
        "BodyLength": "sample string 6"
      },
      {
        "ReportId": "sample string 1",
        "ReportType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "DocumentPointer": "sample string 2",
        "Storage": "sample string 3",
        "Format": "sample string 4",
        "Body": "sample string 5",
        "BodyLength": "sample string 6"
      }
    ],
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "sample string 7",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2018-02-15T14:55:15.2938497Z",
      "DischargeDateTime": "2018-02-15T14:55:15.2938497Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    },
    "CreatedUpdatedDateTime": "2018-02-15T14:55:15.2938497Z"
  }
]
Sample Message
<ArrayOfPopulationRadiologyResultResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <PopulationRadiologyResultResponseViewModel>
    <BeginExamDateTime>2018-02-15T08:55:15.2938497-06:00</BeginExamDateTime>
    <CreatedUpdatedDateTime>2018-02-15T08:55:15.2938497-06:00</CreatedUpdatedDateTime>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-15T08:55:15.2938497-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-15T08:55:15.2938497-06:00</d3p1:EncounterDateTime>
      <d3p1:EncounterId>sample string 1</d3p1:EncounterId>
      <d3p1:EncounterType>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:EncounterType>
      <d3p1:FinancialNumber>sample string 2</d3p1:FinancialNumber>
      <d3p1:Location>
        <d3p1:Bed>sample string 1</d3p1:Bed>
        <d3p1:Hospital>sample string 3</d3p1:Hospital>
        <d3p1:Room>sample string 4</d3p1:Room>
        <d3p1:Unit>sample string 2</d3p1:Unit>
      </d3p1:Location>
      <d3p1:PatientClass>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:PatientClass>
    </Encounter>
    <EndExamDateTime>2018-02-15T08:55:15.2938497-06:00</EndExamDateTime>
    <ExamAccessionNumber>sample string 3</ExamAccessionNumber>
    <ExamType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:CPT>sample string 3</d3p1:CPT>
      <d3p1:ExamTypeId>sample string 1</d3p1:ExamTypeId>
      <d3p1:ExamTypeName>sample string 2</d3p1:ExamTypeName>
    </ExamType>
    <OrderId>sample string 2</OrderId>
    <Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
      <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:Gender>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Gender>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MRN>sample string 6</d3p1:MRN>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PatientId>sample string 1</d3p1:PatientId>
    </Patient>
    <ReadingRadiologists xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderViewModel>
        <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
        <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
      </d3p1:ProviderViewModel>
      <d3p1:ProviderViewModel>
        <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
        <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
      </d3p1:ProviderViewModel>
    </ReadingRadiologists>
    <Reports xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:RadiologyReportViewModel>
        <d3p1:Body>sample string 5</d3p1:Body>
        <d3p1:BodyLength>sample string 6</d3p1:BodyLength>
        <d3p1:DocumentPointer>sample string 2</d3p1:DocumentPointer>
        <d3p1:Format>sample string 4</d3p1:Format>
        <d3p1:ReportId>sample string 1</d3p1:ReportId>
        <d3p1:ReportType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:ReportType>
        <d3p1:Storage>sample string 3</d3p1:Storage>
      </d3p1:RadiologyReportViewModel>
      <d3p1:RadiologyReportViewModel>
        <d3p1:Body>sample string 5</d3p1:Body>
        <d3p1:BodyLength>sample string 6</d3p1:BodyLength>
        <d3p1:DocumentPointer>sample string 2</d3p1:DocumentPointer>
        <d3p1:Format>sample string 4</d3p1:Format>
        <d3p1:ReportId>sample string 1</d3p1:ReportId>
        <d3p1:ReportType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:ReportType>
        <d3p1:Storage>sample string 3</d3p1:Storage>
      </d3p1:RadiologyReportViewModel>
    </Reports>
    <ResultDateTime>2018-02-15T08:55:15.2938497-06:00</ResultDateTime>
    <ResultId>sample string 1</ResultId>
    <ResultStatus xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ResultStatus>
  </PopulationRadiologyResultResponseViewModel>
  <PopulationRadiologyResultResponseViewModel>
    <BeginExamDateTime>2018-02-15T08:55:15.2938497-06:00</BeginExamDateTime>
    <CreatedUpdatedDateTime>2018-02-15T08:55:15.2938497-06:00</CreatedUpdatedDateTime>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-15T08:55:15.2938497-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-15T08:55:15.2938497-06:00</d3p1:EncounterDateTime>
      <d3p1:EncounterId>sample string 1</d3p1:EncounterId>
      <d3p1:EncounterType>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:EncounterType>
      <d3p1:FinancialNumber>sample string 2</d3p1:FinancialNumber>
      <d3p1:Location>
        <d3p1:Bed>sample string 1</d3p1:Bed>
        <d3p1:Hospital>sample string 3</d3p1:Hospital>
        <d3p1:Room>sample string 4</d3p1:Room>
        <d3p1:Unit>sample string 2</d3p1:Unit>
      </d3p1:Location>
      <d3p1:PatientClass>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:PatientClass>
    </Encounter>
    <EndExamDateTime>2018-02-15T08:55:15.2938497-06:00</EndExamDateTime>
    <ExamAccessionNumber>sample string 3</ExamAccessionNumber>
    <ExamType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:CPT>sample string 3</d3p1:CPT>
      <d3p1:ExamTypeId>sample string 1</d3p1:ExamTypeId>
      <d3p1:ExamTypeName>sample string 2</d3p1:ExamTypeName>
    </ExamType>
    <OrderId>sample string 2</OrderId>
    <Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
      <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:Gender>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Gender>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MRN>sample string 6</d3p1:MRN>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PatientId>sample string 1</d3p1:PatientId>
    </Patient>
    <ReadingRadiologists xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderViewModel>
        <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
        <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
      </d3p1:ProviderViewModel>
      <d3p1:ProviderViewModel>
        <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
        <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
      </d3p1:ProviderViewModel>
    </ReadingRadiologists>
    <Reports xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:RadiologyReportViewModel>
        <d3p1:Body>sample string 5</d3p1:Body>
        <d3p1:BodyLength>sample string 6</d3p1:BodyLength>
        <d3p1:DocumentPointer>sample string 2</d3p1:DocumentPointer>
        <d3p1:Format>sample string 4</d3p1:Format>
        <d3p1:ReportId>sample string 1</d3p1:ReportId>
        <d3p1:ReportType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:ReportType>
        <d3p1:Storage>sample string 3</d3p1:Storage>
      </d3p1:RadiologyReportViewModel>
      <d3p1:RadiologyReportViewModel>
        <d3p1:Body>sample string 5</d3p1:Body>
        <d3p1:BodyLength>sample string 6</d3p1:BodyLength>
        <d3p1:DocumentPointer>sample string 2</d3p1:DocumentPointer>
        <d3p1:Format>sample string 4</d3p1:Format>
        <d3p1:ReportId>sample string 1</d3p1:ReportId>
        <d3p1:ReportType>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:ReportType>
        <d3p1:Storage>sample string 3</d3p1:Storage>
      </d3p1:RadiologyReportViewModel>
    </Reports>
    <ResultDateTime>2018-02-15T08:55:15.2938497-06:00</ResultDateTime>
    <ResultId>sample string 1</ResultId>
    <ResultStatus xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ResultStatus>
  </PopulationRadiologyResultResponseViewModel>
</ArrayOfPopulationRadiologyResultResponseViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?