POST api/v2/{providerId}/clinical/patient/genericinformation/{patientId}/revise

Add/Update patient file generic information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientFileGenericInformationVo
NameDescriptionTypeAdditional information
PatientFileGenericInformationId

globally unique identifier

None.
CapturedDate

date

None.
PracticeId

globally unique identifier

None.
PatientId

globally unique identifier

None.
Category

string

None.
Answers

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestionAnswer

None.

Request Formats

application/json, text/json

Sample: 
{
  "PatientFileGenericInformationId": "0dca084d-2ad1-4a40-8f80-4a26f3e4a3c7",
  "CapturedDate": "2025-04-10T16:53:29Z",
  "PracticeId": "9d0f1310-3fc3-4476-8b57-3dcea3c8dde8",
  "PatientId": "c9370c14-e04d-4e50-9eda-19958878042c",
  "Category": "sample string 5",
  "Answers": [
    {
      "QuestionKey": "sample string 1",
      "SymptomId": "sample string 2",
      "NoteValue": "sample string 3",
      "AnswerValue": "sample string 4",
      "Section": "sample string 5",
      "Notes": "sample string 6"
    },
    {
      "QuestionKey": "sample string 1",
      "SymptomId": "sample string 2",
      "NoteValue": "sample string 3",
      "AnswerValue": "sample string 4",
      "Section": "sample string 5",
      "Notes": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample: 
<PatientFileGenericInformationVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/clinical/v1/PatientFileGenericInformationVo/">
  <Answers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
    <d2p1:SymptomQuestionAnswer>
      <d2p1:AnswerValue>sample string 4</d2p1:AnswerValue>
      <d2p1:NoteValue>sample string 3</d2p1:NoteValue>
      <d2p1:Notes>sample string 6</d2p1:Notes>
      <d2p1:QuestionKey>sample string 1</d2p1:QuestionKey>
      <d2p1:Section>sample string 5</d2p1:Section>
      <d2p1:SymptomId>sample string 2</d2p1:SymptomId>
    </d2p1:SymptomQuestionAnswer>
    <d2p1:SymptomQuestionAnswer>
      <d2p1:AnswerValue>sample string 4</d2p1:AnswerValue>
      <d2p1:NoteValue>sample string 3</d2p1:NoteValue>
      <d2p1:Notes>sample string 6</d2p1:Notes>
      <d2p1:QuestionKey>sample string 1</d2p1:QuestionKey>
      <d2p1:Section>sample string 5</d2p1:Section>
      <d2p1:SymptomId>sample string 2</d2p1:SymptomId>
    </d2p1:SymptomQuestionAnswer>
  </Answers>
  <CapturedDate>2025-04-10T16:53:29.8659553+02:00</CapturedDate>
  <Category>sample string 5</Category>
  <PatientFileGenericInformationId>0dca084d-2ad1-4a40-8f80-4a26f3e4a3c7</PatientFileGenericInformationId>
  <PatientId>c9370c14-e04d-4e50-9eda-19958878042c</PatientId>
  <PracticeId>9d0f1310-3fc3-4476-8b57-3dcea3c8dde8</PracticeId>
</PatientFileGenericInformationVo>

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

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": "7e68f0ea-2269-4236-a566-e530e8fa3fe2",
  "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>7e68f0ea-2269-4236-a566-e530e8fa3fe2</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>