GET Intake Outputs Discovery

GET api/v1/{EMRSystem}/IntakeOutputs/Discovery

Returns a list of valid IntakeOutputs types for a given EMR installation.

HTTP Method

GET

Applicable Emissary Products

Analytics
Interactive

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Epic

Released

Meditech

In Dev

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

UserId

Gets or sets the user identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing collection of Intake Categories and Output Categories.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

IntakeCategories

Gets or sets the intake categories.

Collection of IntakeCategoryViewModel

None.

OutputCategories

Gets or sets the output categories.

Collection of OutputCategoryViewModel

None.

 
Response Codes

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

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
{
  "IntakeCategories": [
    {
      "IntakeCategoryId": "sample string 1",
      "IntakeCategoryDesc": "sample string 2",
      "IntakeCategoryDisplaySeq": "sample string 3",
      "IntakeComponents": [
        {
          "IntakeComponentId": "sample string 1",
          "IntakeComponentDesc": "sample string 2",
          "IntakeComponentDisplaySeq": "sample string 3",
          "IntakeAccumulationInd": true
        },
        {
          "IntakeComponentId": "sample string 1",
          "IntakeComponentDesc": "sample string 2",
          "IntakeComponentDisplaySeq": "sample string 3",
          "IntakeAccumulationInd": true
        }
      ]
    },
    {
      "IntakeCategoryId": "sample string 1",
      "IntakeCategoryDesc": "sample string 2",
      "IntakeCategoryDisplaySeq": "sample string 3",
      "IntakeComponents": [
        {
          "IntakeComponentId": "sample string 1",
          "IntakeComponentDesc": "sample string 2",
          "IntakeComponentDisplaySeq": "sample string 3",
          "IntakeAccumulationInd": true
        },
        {
          "IntakeComponentId": "sample string 1",
          "IntakeComponentDesc": "sample string 2",
          "IntakeComponentDisplaySeq": "sample string 3",
          "IntakeAccumulationInd": true
        }
      ]
    }
  ],
  "OutputCategories": [
    {
      "OutputCategoryId": "sample string 1",
      "OutputCategoryDesc": "sample string 2",
      "OutputCategoryDisplaySeq": "sample string 3",
      "OutputComponents": [
        {
          "OutputComponentId": "sample string 1",
          "OutputComponentDesc": "sample string 2",
          "OutputComponentDisplaySeq": "sample string 3",
          "OutputAccumulationInd": true
        },
        {
          "OutputComponentId": "sample string 1",
          "OutputComponentDesc": "sample string 2",
          "OutputComponentDisplaySeq": "sample string 3",
          "OutputAccumulationInd": true
        }
      ]
    },
    {
      "OutputCategoryId": "sample string 1",
      "OutputCategoryDesc": "sample string 2",
      "OutputCategoryDisplaySeq": "sample string 3",
      "OutputComponents": [
        {
          "OutputComponentId": "sample string 1",
          "OutputComponentDesc": "sample string 2",
          "OutputComponentDisplaySeq": "sample string 3",
          "OutputAccumulationInd": true
        },
        {
          "OutputComponentId": "sample string 1",
          "OutputComponentDesc": "sample string 2",
          "OutputComponentDisplaySeq": "sample string 3",
          "OutputAccumulationInd": true
        }
      ]
    }
  ]
}
Sample Message
<IntakeOutputsDiscoveryResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <IntakeCategories xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:IntakeCategoryViewModel>
      <d2p1:IntakeCategoryDesc>sample string 2</d2p1:IntakeCategoryDesc>
      <d2p1:IntakeCategoryDisplaySeq>sample string 3</d2p1:IntakeCategoryDisplaySeq>
      <d2p1:IntakeCategoryId>sample string 1</d2p1:IntakeCategoryId>
      <d2p1:IntakeComponents>
        <d2p1:IntakeComponentViewModel>
          <d2p1:IntakeAccumulationInd>true</d2p1:IntakeAccumulationInd>
          <d2p1:IntakeComponentDesc>sample string 2</d2p1:IntakeComponentDesc>
          <d2p1:IntakeComponentDisplaySeq>sample string 3</d2p1:IntakeComponentDisplaySeq>
          <d2p1:IntakeComponentId>sample string 1</d2p1:IntakeComponentId>
        </d2p1:IntakeComponentViewModel>
        <d2p1:IntakeComponentViewModel>
          <d2p1:IntakeAccumulationInd>true</d2p1:IntakeAccumulationInd>
          <d2p1:IntakeComponentDesc>sample string 2</d2p1:IntakeComponentDesc>
          <d2p1:IntakeComponentDisplaySeq>sample string 3</d2p1:IntakeComponentDisplaySeq>
          <d2p1:IntakeComponentId>sample string 1</d2p1:IntakeComponentId>
        </d2p1:IntakeComponentViewModel>
      </d2p1:IntakeComponents>
    </d2p1:IntakeCategoryViewModel>
    <d2p1:IntakeCategoryViewModel>
      <d2p1:IntakeCategoryDesc>sample string 2</d2p1:IntakeCategoryDesc>
      <d2p1:IntakeCategoryDisplaySeq>sample string 3</d2p1:IntakeCategoryDisplaySeq>
      <d2p1:IntakeCategoryId>sample string 1</d2p1:IntakeCategoryId>
      <d2p1:IntakeComponents>
        <d2p1:IntakeComponentViewModel>
          <d2p1:IntakeAccumulationInd>true</d2p1:IntakeAccumulationInd>
          <d2p1:IntakeComponentDesc>sample string 2</d2p1:IntakeComponentDesc>
          <d2p1:IntakeComponentDisplaySeq>sample string 3</d2p1:IntakeComponentDisplaySeq>
          <d2p1:IntakeComponentId>sample string 1</d2p1:IntakeComponentId>
        </d2p1:IntakeComponentViewModel>
        <d2p1:IntakeComponentViewModel>
          <d2p1:IntakeAccumulationInd>true</d2p1:IntakeAccumulationInd>
          <d2p1:IntakeComponentDesc>sample string 2</d2p1:IntakeComponentDesc>
          <d2p1:IntakeComponentDisplaySeq>sample string 3</d2p1:IntakeComponentDisplaySeq>
          <d2p1:IntakeComponentId>sample string 1</d2p1:IntakeComponentId>
        </d2p1:IntakeComponentViewModel>
      </d2p1:IntakeComponents>
    </d2p1:IntakeCategoryViewModel>
  </IntakeCategories>
  <OutputCategories xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:OutputCategoryViewModel>
      <d2p1:OutputCategoryDesc>sample string 2</d2p1:OutputCategoryDesc>
      <d2p1:OutputCategoryDisplaySeq>sample string 3</d2p1:OutputCategoryDisplaySeq>
      <d2p1:OutputCategoryId>sample string 1</d2p1:OutputCategoryId>
      <d2p1:OutputComponents>
        <d2p1:OutputComponentViewModel>
          <d2p1:OutputAccumulationInd>true</d2p1:OutputAccumulationInd>
          <d2p1:OutputComponentDesc>sample string 2</d2p1:OutputComponentDesc>
          <d2p1:OutputComponentDisplaySeq>sample string 3</d2p1:OutputComponentDisplaySeq>
          <d2p1:OutputComponentId>sample string 1</d2p1:OutputComponentId>
        </d2p1:OutputComponentViewModel>
        <d2p1:OutputComponentViewModel>
          <d2p1:OutputAccumulationInd>true</d2p1:OutputAccumulationInd>
          <d2p1:OutputComponentDesc>sample string 2</d2p1:OutputComponentDesc>
          <d2p1:OutputComponentDisplaySeq>sample string 3</d2p1:OutputComponentDisplaySeq>
          <d2p1:OutputComponentId>sample string 1</d2p1:OutputComponentId>
        </d2p1:OutputComponentViewModel>
      </d2p1:OutputComponents>
    </d2p1:OutputCategoryViewModel>
    <d2p1:OutputCategoryViewModel>
      <d2p1:OutputCategoryDesc>sample string 2</d2p1:OutputCategoryDesc>
      <d2p1:OutputCategoryDisplaySeq>sample string 3</d2p1:OutputCategoryDisplaySeq>
      <d2p1:OutputCategoryId>sample string 1</d2p1:OutputCategoryId>
      <d2p1:OutputComponents>
        <d2p1:OutputComponentViewModel>
          <d2p1:OutputAccumulationInd>true</d2p1:OutputAccumulationInd>
          <d2p1:OutputComponentDesc>sample string 2</d2p1:OutputComponentDesc>
          <d2p1:OutputComponentDisplaySeq>sample string 3</d2p1:OutputComponentDisplaySeq>
          <d2p1:OutputComponentId>sample string 1</d2p1:OutputComponentId>
        </d2p1:OutputComponentViewModel>
        <d2p1:OutputComponentViewModel>
          <d2p1:OutputAccumulationInd>true</d2p1:OutputAccumulationInd>
          <d2p1:OutputComponentDesc>sample string 2</d2p1:OutputComponentDesc>
          <d2p1:OutputComponentDisplaySeq>sample string 3</d2p1:OutputComponentDisplaySeq>
          <d2p1:OutputComponentId>sample string 1</d2p1:OutputComponentId>
        </d2p1:OutputComponentViewModel>
      </d2p1:OutputComponents>
    </d2p1:OutputCategoryViewModel>
  </OutputCategories>
</IntakeOutputsDiscoveryResponseViewModel>

Submit a Comment

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

 

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