POST api/v1/{practiceid}/clinical/patientclinicalnotes/{patientId}/revise

Revise patient clinical notes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Clinical.Interface.Commands.RevisePatientClinicalNotes
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
PatientClinicalNotes

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientClinicalNotesVo

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PracticeId": "1fcae90c-4fd7-4b6d-8e8a-1ba4b3b7076a",
  "PatientClinicalNotes": {
    "PatientClinicalNotesId": "ef4d0c1b-ccbb-4405-a149-425f94bc3fb7",
    "Patient": {
      "PatientId": "40a85f73-b084-44c7-b59c-b9cc1ec2c78d",
      "PatientXRef": "sample string 2",
      "PracticeId": "7e78b82a-ba42-4a12-ada7-1ac61d18f624",
      "FileNo": "sample string 4",
      "KnownAs": "sample string 5",
      "Occupation": "sample string 6",
      "Employer": "sample string 7",
      "PreferredLanguage": "sample string 8",
      "MaritalStatus": "sample string 9",
      "PatientDetails": {
        "Title": "sample string 1",
        "FirstName": "sample string 2",
        "Surname": "sample string 3",
        "DateOfBirth": "2025-11-23T12:38:58Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "be790757-2cdd-46d7-b281-eaffa879deb8",
        "AccountNo": "sample string 2",
        "IsCashAccount": true,
        "MedicalAidName": "sample string 4",
        "MedicalAidPlan": "sample string 5",
        "MedicalAidPlanOption": "sample string 6",
        "MedicalAidMembershipNumber": "sample string 7",
        "MedicalAidDependentCode": "sample string 8",
        "MedicalAidMainMemberDetails": {
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "Surname": "sample string 3",
          "DateOfBirth": "2025-11-23T12:38:58Z",
          "IdentityNo": "sample string 5",
          "Gender": "sample string 6",
          "ContactNo": "sample string 7",
          "EmailAddress": "sample string 8"
        },
        "MedicalAidRoutingCode": "sample string 9",
        "MedicalAidOptionCode": "sample string 10",
        "MedicalAidSchemeCode": "sample string 11",
        "MedicalAidPlanCode": "sample string 12"
      },
      "PhysicalAddress": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Line3": "sample string 3",
        "Code": "sample string 4"
      },
      "PostalAddress": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Line3": "sample string 3",
        "Code": "sample string 4"
      },
      "Deceased": true
    },
    "PracticeId": "b03eee9f-7a4d-456b-b6b0-549351f3bdfc",
    "Note": "sample string 3",
    "IsImportant": true,
    "Type": "sample string 5",
    "Format": "sample string 6",
    "CapturedDate": "2025-11-23T12:38:58Z"
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 2"
}

application/xml, text/xml

Sample: 
<RevisePatientClinicalNotes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 2</OriginatedSystem>
  <PatientClinicalNotes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
    <d2p1:CapturedDate>2025-11-23T12:38:58.7861343+02:00</d2p1:CapturedDate>
    <d2p1:Format>sample string 6</d2p1:Format>
    <d2p1:IsImportant>true</d2p1:IsImportant>
    <d2p1:Note>sample string 3</d2p1:Note>
    <d2p1:Patient xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <d3p1:Deceased>true</d3p1:Deceased>
      <d3p1:Employer>sample string 7</d3p1:Employer>
      <d3p1:FileNo>sample string 4</d3p1:FileNo>
      <d3p1:KnownAs>sample string 5</d3p1:KnownAs>
      <d3p1:MaritalStatus>sample string 9</d3p1:MaritalStatus>
      <d3p1:Occupation>sample string 6</d3p1:Occupation>
      <d3p1:PatientAccountDetails>
        <d3p1:AccountId>be790757-2cdd-46d7-b281-eaffa879deb8</d3p1:AccountId>
        <d3p1:AccountNo>sample string 2</d3p1:AccountNo>
        <d3p1:IsCashAccount>true</d3p1:IsCashAccount>
        <d3p1:MedicalAidDependentCode>sample string 8</d3p1:MedicalAidDependentCode>
        <d3p1:MedicalAidMainMemberDetails>
          <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
          <d3p1:DateOfBirth>2025-11-23T12:38:58.7861343+02:00</d3p1:DateOfBirth>
          <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
          <d3p1:FirstName>sample string 2</d3p1:FirstName>
          <d3p1:Gender>sample string 6</d3p1:Gender>
          <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
          <d3p1:Surname>sample string 3</d3p1:Surname>
          <d3p1:Title>sample string 1</d3p1:Title>
        </d3p1:MedicalAidMainMemberDetails>
        <d3p1:MedicalAidMembershipNumber>sample string 7</d3p1:MedicalAidMembershipNumber>
        <d3p1:MedicalAidName>sample string 4</d3p1:MedicalAidName>
        <d3p1:MedicalAidOptionCode>sample string 10</d3p1:MedicalAidOptionCode>
        <d3p1:MedicalAidPlan>sample string 5</d3p1:MedicalAidPlan>
        <d3p1:MedicalAidPlanCode>sample string 12</d3p1:MedicalAidPlanCode>
        <d3p1:MedicalAidPlanOption>sample string 6</d3p1:MedicalAidPlanOption>
        <d3p1:MedicalAidRoutingCode>sample string 9</d3p1:MedicalAidRoutingCode>
        <d3p1:MedicalAidSchemeCode>sample string 11</d3p1:MedicalAidSchemeCode>
      </d3p1:PatientAccountDetails>
      <d3p1:PatientDetails>
        <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
        <d3p1:DateOfBirth>2025-11-23T12:38:58.7861343+02:00</d3p1:DateOfBirth>
        <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
        <d3p1:FirstName>sample string 2</d3p1:FirstName>
        <d3p1:Gender>sample string 6</d3p1:Gender>
        <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
        <d3p1:Surname>sample string 3</d3p1:Surname>
        <d3p1:Title>sample string 1</d3p1:Title>
      </d3p1:PatientDetails>
      <d3p1:PatientId>40a85f73-b084-44c7-b59c-b9cc1ec2c78d</d3p1:PatientId>
      <d3p1:PatientXRef>sample string 2</d3p1:PatientXRef>
      <d3p1:PhysicalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PhysicalAddress>
      <d3p1:PostalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PostalAddress>
      <d3p1:PracticeId>7e78b82a-ba42-4a12-ada7-1ac61d18f624</d3p1:PracticeId>
      <d3p1:PreferredLanguage>sample string 8</d3p1:PreferredLanguage>
    </d2p1:Patient>
    <d2p1:PatientClinicalNotesId>ef4d0c1b-ccbb-4405-a149-425f94bc3fb7</d2p1:PatientClinicalNotesId>
    <d2p1:PracticeId>b03eee9f-7a4d-456b-b6b0-549351f3bdfc</d2p1:PracticeId>
    <d2p1:Type>sample string 5</d2p1:Type>
  </PatientClinicalNotes>
  <PracticeId>1fcae90c-4fd7-4b6d-8e8a-1ba4b3b7076a</PracticeId>
</RevisePatientClinicalNotes>

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 'RevisePatientClinicalNotes'.

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": "bf6d4f8a-1c41-4a9e-b1d4-401a02d0ecf4",
  "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>bf6d4f8a-1c41-4a9e-b1d4-401a02d0ecf4</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>