POST api/NextGen/AddSoapNotes

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
personId	string	None.
encounterId	string	None.
request	SoapNotesDto	None.
ProviderReference	string	None.

Request Formats

application/json, text/json

Sample:

{
  "personId": "sample string 1",
  "encounterId": "sample string 2",
  "request": {
    "historyOfPresentIllnessNarrative": "sample string 1",
    "historiesNarrative": "sample string 2",
    "reviewOfSystemsNarrative": "sample string 3",
    "physicalExamNarrative": "sample string 4",
    "assessmentNarrative": "sample string 5",
    "planNarrative": "sample string 6",
    "diagnosticsInterpretationNarrative": "sample string 7",
    "previousDiagnosticsNarrative": "sample string 8",
    "proceduresNarrative": "sample string 9"
  },
  "providerReference": "sample string 3"
}

application/csp-report

Sample:

{"personId":"sample string 1","encounterId":"sample string 2","request":{"historyOfPresentIllnessNarrative":"sample string 1","historiesNarrative":"sample string 2","reviewOfSystemsNarrative":"sample string 3","physicalExamNarrative":"sample string 4","assessmentNarrative":"sample string 5","planNarrative":"sample string 6","diagnosticsInterpretationNarrative":"sample string 7","previousDiagnosticsNarrative":"sample string 8","proceduresNarrative":"sample string 9"},"providerReference":"sample string 3"}

application/xml, text/xml

Sample:

<NextGenSoapNotesRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.DTO">
  <EncounterId>sample string 2</EncounterId>
  <PersonId>sample string 1</PersonId>
  <ProviderReference>sample string 3</ProviderReference>
  <Request xmlns:d2p1="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.ScribeSwiftDTO">
    <d2p1:AssessmentNarrative>sample string 5</d2p1:AssessmentNarrative>
    <d2p1:DiagnosticsInterpretationNarrative>sample string 7</d2p1:DiagnosticsInterpretationNarrative>
    <d2p1:HistoriesNarrative>sample string 2</d2p1:HistoriesNarrative>
    <d2p1:HistoryOfPresentIllnessNarrative>sample string 1</d2p1:HistoryOfPresentIllnessNarrative>
    <d2p1:PhysicalExamNarrative>sample string 4</d2p1:PhysicalExamNarrative>
    <d2p1:PlanNarrative>sample string 6</d2p1:PlanNarrative>
    <d2p1:PreviousDiagnosticsNarrative>sample string 8</d2p1:PreviousDiagnosticsNarrative>
    <d2p1:ProceduresNarrative>sample string 9</d2p1:ProceduresNarrative>
    <d2p1:ReviewOfSystemsNarrative>sample string 3</d2p1:ReviewOfSystemsNarrative>
  </Request>
</NextGenSoapNotesRequestDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NextGenSoapNotesRequestDTO'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.