POST api/v2/{providerId}/clinical/patient/{patientId}/note

Capture patient file notes to be shown on patient timeline

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

from where to import

 globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

note object

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientFileNoteVo
NameDescriptionTypeAdditional information
PatientFileNoteId

globally unique identifier

None.
PracticeId

globally unique identifier

None.
PatientId

globally unique identifier

None.
ParentReferenceId

globally unique identifier

None.
Note

string

None.
Type

string

None.
Format

string

None.
CapturedDate

date

None.

Request Formats

application/json, text/json

Sample: 
{
  "PatientFileNoteId": "a5277e75-df46-4c2c-8131-e643868b3a74",
  "PracticeId": "004e44ac-d568-4953-9fe7-f54a4e81b1ab",
  "PatientId": "580d0ce1-1480-4b19-8b88-ee92bc6e25f9",
  "ParentReferenceId": "b11199f8-2763-4cbd-93a1-e5900249b8cc",
  "Note": "sample string 4",
  "Type": "sample string 5",
  "Format": "sample string 6",
  "CapturedDate": "2025-06-18T16:43:36Z"
}

application/xml, text/xml

Sample: 
<PatientFileNoteVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <CapturedDate>2025-06-18T16:43:36.7021349+02:00</CapturedDate>
  <Format>sample string 6</Format>
  <Note>sample string 4</Note>
  <ParentReferenceId>b11199f8-2763-4cbd-93a1-e5900249b8cc</ParentReferenceId>
  <PatientFileNoteId>a5277e75-df46-4c2c-8131-e643868b3a74</PatientFileNoteId>
  <PatientId>580d0ce1-1480-4b19-8b88-ee92bc6e25f9</PatientId>
  <PracticeId>004e44ac-d568-4953-9fe7-f54a4e81b1ab</PracticeId>
  <Type>sample string 5</Type>
</PatientFileNoteVo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'PatientFileNoteVo'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "bf90ed0b-912e-4cbe-a83a-940fdbc92d40",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>bf90ed0b-912e-4cbe-a83a-940fdbc92d40</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>