POST api/v1/{providerId}/clinical/patient/configuration/{patientId}/revise

Add/Update patient configration

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientConfigurationVo
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
PatientId

globally unique identifier

None.
CapturedDate

date

None.
Configuration

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "PracticeId": "2c399adb-6f80-4526-8e18-4e39a0365b80",
  "PatientId": "518d326b-cb6b-4701-9009-ff7bdb53810d",
  "CapturedDate": "2025-04-17T15:32:12Z",
  "Configuration": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<PatientConfigurationVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/patient/v1/PatientConfigurationVo/">
  <CapturedDate>2025-04-17T15:32:12.8874322+02:00</CapturedDate>
  <Configuration xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Configuration>
  <PatientId>518d326b-cb6b-4701-9009-ff7bdb53810d</PatientId>
  <PracticeId>2c399adb-6f80-4526-8e18-4e39a0365b80</PracticeId>
</PatientConfigurationVo>

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

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": "4bdd11f0-4182-4a8c-a354-8436c00d9b89",
  "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>4bdd11f0-4182-4a8c-a354-8436c00d9b89</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>