POST api/v{version}/laboratory/{laboratoryId}/clinicalDecisionSupport

Request Information

URI Parameters

NameDescriptionTypeAdditional information
laboratoryId

integer

Required

version

string

None.

Body Parameters

ClinicalDecisionSupportMessageModel
NameDescriptionTypeAdditional information
PatientID

string

String length: inclusive between 0 and 15

MPI

string

Required

String length: inclusive between 1 and 50

FirstName

string

Required

String length: inclusive between 1 and 50

LastName

string

Required

String length: inclusive between 1 and 50

EventDate

date

None.

CDSAlertMessageID

string

Required

String length: inclusive between 0 and 50

AlertName

string

String length: inclusive between 0 and 100

AlertDisplay

string

String length: inclusive between 0 and 500

AlertCategory

string

String length: inclusive between 0 and 100

Severity

string

String length: inclusive between 0 and 50

AlertSrc

string

String length: inclusive between 0 and 50

AlertMsg

string

String length: inclusive between 0 and 500

CodeType

string

String length: inclusive between 0 and 10

CodeValue

string

String length: inclusive between 0 and 20

CodeDesc

string

String length: inclusive between 0 and 500

Provider

string

String length: inclusive between 0 and 100

PlaceOfService

string

String length: inclusive between 0 and 50

SeverityLevel

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "patientID": "sample string 1",
  "mpi": "sample string 2",
  "firstName": "sample string 3",
  "lastName": "sample string 4",
  "eventDate": "2024-10-22T09:23:42.9261224-07:00",
  "cdsAlertMessageID": "sample string 5",
  "alertName": "sample string 6",
  "alertDisplay": "sample string 7",
  "alertCategory": "sample string 8",
  "severity": "sample string 9",
  "alertSrc": "sample string 10",
  "alertMsg": "sample string 11",
  "codeType": "sample string 12",
  "codeValue": "sample string 13",
  "codeDesc": "sample string 14",
  "provider": "sample string 15",
  "placeOfService": "sample string 16",
  "severityLevel": 17
}

application/xml, text/xml

Sample:
<ClinicalDecisionSupportMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
  <AlertCategory>sample string 8</AlertCategory>
  <AlertDisplay>sample string 7</AlertDisplay>
  <AlertMsg>sample string 11</AlertMsg>
  <AlertName>sample string 6</AlertName>
  <AlertSrc>sample string 10</AlertSrc>
  <CDSAlertMessageID>sample string 5</CDSAlertMessageID>
  <CodeDesc>sample string 14</CodeDesc>
  <CodeType>sample string 12</CodeType>
  <CodeValue>sample string 13</CodeValue>
  <EventDate>2024-10-22T09:23:42.9261224-07:00</EventDate>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <MPI>sample string 2</MPI>
  <PatientID>sample string 1</PatientID>
  <PlaceOfService>sample string 16</PlaceOfService>
  <Provider>sample string 15</Provider>
  <Severity>sample string 9</Severity>
  <SeverityLevel>17</SeverityLevel>
</ClinicalDecisionSupportMessageModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfIEnumerableOfClinicalDecisionSupportMessageListItem
NameDescriptionTypeAdditional information
Data

Collection of ClinicalDecisionSupportMessageListItem

None.

StatusCode

Gets or sets the status code.

HttpStatusCode

None.

StatusDescription

Gets or sets the status description.

string

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "data": [
    {
      "clinicalDecisionSupportMessageID": 1,
      "laboratoryID": 2,
      "alertMessageID": "sample string 3",
      "medicaidID": "sample string 4",
      "mpi": "sample string 5",
      "firstName": "sample string 6",
      "lastName": "sample string 7",
      "subjectID": 8,
      "eventDate": "2024-10-22T09:23:42.9735506-07:00",
      "alertName": "sample string 9",
      "alertDisplay": "sample string 10",
      "alertCategory": "sample string 11",
      "severity": "sample string 12",
      "alertSource": "sample string 13",
      "alertMessage": "sample string 14",
      "codeType": "sample string 15",
      "codeValue": "sample string 16",
      "codeDescription": "sample string 17",
      "patientName": "sample string 18",
      "dismissDate": "2024-10-22T09:23:42.9735506-07:00",
      "provider": "sample string 19",
      "placeOfService": "sample string 20",
      "severityLevel": 21,
      "creationDate": "2024-10-22T09:23:42.9735506-07:00"
    },
    {
      "clinicalDecisionSupportMessageID": 1,
      "laboratoryID": 2,
      "alertMessageID": "sample string 3",
      "medicaidID": "sample string 4",
      "mpi": "sample string 5",
      "firstName": "sample string 6",
      "lastName": "sample string 7",
      "subjectID": 8,
      "eventDate": "2024-10-22T09:23:42.9735506-07:00",
      "alertName": "sample string 9",
      "alertDisplay": "sample string 10",
      "alertCategory": "sample string 11",
      "severity": "sample string 12",
      "alertSource": "sample string 13",
      "alertMessage": "sample string 14",
      "codeType": "sample string 15",
      "codeValue": "sample string 16",
      "codeDescription": "sample string 17",
      "patientName": "sample string 18",
      "dismissDate": "2024-10-22T09:23:42.9735506-07:00",
      "provider": "sample string 19",
      "placeOfService": "sample string 20",
      "severityLevel": 21,
      "creationDate": "2024-10-22T09:23:42.9735506-07:00"
    }
  ],
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfClinicalDecisionSupportMessageListItemuFpbgzW1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <StatusCode>Continue</StatusCode>
  <StatusDescription>sample string 1</StatusDescription>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DomainObjects">
    <d2p1:ClinicalDecisionSupportMessageListItem>
      <d2p1:AlertCategory>sample string 11</d2p1:AlertCategory>
      <d2p1:AlertDisplay>sample string 10</d2p1:AlertDisplay>
      <d2p1:AlertMessage>sample string 14</d2p1:AlertMessage>
      <d2p1:AlertMessageID>sample string 3</d2p1:AlertMessageID>
      <d2p1:AlertName>sample string 9</d2p1:AlertName>
      <d2p1:AlertSource>sample string 13</d2p1:AlertSource>
      <d2p1:ClinicalDecisionSupportMessageID>1</d2p1:ClinicalDecisionSupportMessageID>
      <d2p1:CodeDescription>sample string 17</d2p1:CodeDescription>
      <d2p1:CodeType>sample string 15</d2p1:CodeType>
      <d2p1:CodeValue>sample string 16</d2p1:CodeValue>
      <d2p1:CreationDate>2024-10-22T09:23:42.9735506-07:00</d2p1:CreationDate>
      <d2p1:DismissDate>2024-10-22T09:23:42.9735506-07:00</d2p1:DismissDate>
      <d2p1:EventDate>2024-10-22T09:23:42.9735506-07:00</d2p1:EventDate>
      <d2p1:FirstName>sample string 6</d2p1:FirstName>
      <d2p1:LaboratoryID>2</d2p1:LaboratoryID>
      <d2p1:LastName>sample string 7</d2p1:LastName>
      <d2p1:MPI>sample string 5</d2p1:MPI>
      <d2p1:MedicaidID>sample string 4</d2p1:MedicaidID>
      <d2p1:PatientName>sample string 18</d2p1:PatientName>
      <d2p1:PlaceOfService>sample string 20</d2p1:PlaceOfService>
      <d2p1:Provider>sample string 19</d2p1:Provider>
      <d2p1:Severity>sample string 12</d2p1:Severity>
      <d2p1:SeverityLevel>21</d2p1:SeverityLevel>
      <d2p1:SubjectID>8</d2p1:SubjectID>
    </d2p1:ClinicalDecisionSupportMessageListItem>
    <d2p1:ClinicalDecisionSupportMessageListItem>
      <d2p1:AlertCategory>sample string 11</d2p1:AlertCategory>
      <d2p1:AlertDisplay>sample string 10</d2p1:AlertDisplay>
      <d2p1:AlertMessage>sample string 14</d2p1:AlertMessage>
      <d2p1:AlertMessageID>sample string 3</d2p1:AlertMessageID>
      <d2p1:AlertName>sample string 9</d2p1:AlertName>
      <d2p1:AlertSource>sample string 13</d2p1:AlertSource>
      <d2p1:ClinicalDecisionSupportMessageID>1</d2p1:ClinicalDecisionSupportMessageID>
      <d2p1:CodeDescription>sample string 17</d2p1:CodeDescription>
      <d2p1:CodeType>sample string 15</d2p1:CodeType>
      <d2p1:CodeValue>sample string 16</d2p1:CodeValue>
      <d2p1:CreationDate>2024-10-22T09:23:42.9735506-07:00</d2p1:CreationDate>
      <d2p1:DismissDate>2024-10-22T09:23:42.9735506-07:00</d2p1:DismissDate>
      <d2p1:EventDate>2024-10-22T09:23:42.9735506-07:00</d2p1:EventDate>
      <d2p1:FirstName>sample string 6</d2p1:FirstName>
      <d2p1:LaboratoryID>2</d2p1:LaboratoryID>
      <d2p1:LastName>sample string 7</d2p1:LastName>
      <d2p1:MPI>sample string 5</d2p1:MPI>
      <d2p1:MedicaidID>sample string 4</d2p1:MedicaidID>
      <d2p1:PatientName>sample string 18</d2p1:PatientName>
      <d2p1:PlaceOfService>sample string 20</d2p1:PlaceOfService>
      <d2p1:Provider>sample string 19</d2p1:Provider>
      <d2p1:Severity>sample string 12</d2p1:Severity>
      <d2p1:SeverityLevel>21</d2p1:SeverityLevel>
      <d2p1:SubjectID>8</d2p1:SubjectID>
    </d2p1:ClinicalDecisionSupportMessageListItem>
  </Data>
</ResponseOfArrayOfClinicalDecisionSupportMessageListItemuFpbgzW1>