POST api/v1/{practiceId}/clinical/patient/{patientId}/metrics/capture

Capture clinical metrics for provided patient

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.ClinicalMetricVo
NameDescriptionTypeAdditional information
TestDate

Date when metric was taken

 date

None.
Group

"Urine Dipstick"/General/whatever

 string

None.
Name

temperature, pulse, etc

 string

None.
Value

38, 180/60, etc

 string

None.
Unit

C, mmHg, bpm, etc

 string

None.
Type

Optional use: "fasting" "not fasting"

 string

None.
DatePrecision

string

None.
Interpretation

string

None.
OtherPerformer

string

None.
PathLab

string

None.
PathLOINC

string

None.
PathResultId

globally unique identifier

None.
ReferenceId

globally unique identifier

None.
Source

string

None.
Tag

string

None.
Notes

string

None.
NextScreeningDate

date

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "TestDate": "2025-11-19T22:47:42Z",
    "Group": "sample string 2",
    "Name": "sample string 3",
    "Value": "sample string 4",
    "Unit": "sample string 5",
    "Type": "sample string 6",
    "DatePrecision": "sample string 7",
    "Interpretation": "sample string 8",
    "OtherPerformer": "sample string 9",
    "PathLab": "sample string 10",
    "PathLOINC": "sample string 11",
    "PathResultId": "be298179-2e67-4bf3-b517-a78717e3df64",
    "ReferenceId": "bd163d41-bee2-44b9-a817-d4bfa35e529a",
    "Source": "sample string 13",
    "Tag": "sample string 14",
    "Notes": "sample string 15",
    "NextScreeningDate": "2025-11-19T22:47:42Z"
  },
  {
    "TestDate": "2025-11-19T22:47:42Z",
    "Group": "sample string 2",
    "Name": "sample string 3",
    "Value": "sample string 4",
    "Unit": "sample string 5",
    "Type": "sample string 6",
    "DatePrecision": "sample string 7",
    "Interpretation": "sample string 8",
    "OtherPerformer": "sample string 9",
    "PathLab": "sample string 10",
    "PathLOINC": "sample string 11",
    "PathResultId": "be298179-2e67-4bf3-b517-a78717e3df64",
    "ReferenceId": "bd163d41-bee2-44b9-a817-d4bfa35e529a",
    "Source": "sample string 13",
    "Tag": "sample string 14",
    "Notes": "sample string 15",
    "NextScreeningDate": "2025-11-19T22:47:42Z"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfClinicalMetric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
  <ClinicalMetric>
    <DatePrecision>sample string 7</DatePrecision>
    <Group>sample string 2</Group>
    <Interpretation>sample string 8</Interpretation>
    <Name>sample string 3</Name>
    <NextScreeningDate>2025-11-19T22:47:42.6383254+02:00</NextScreeningDate>
    <Notes>sample string 15</Notes>
    <OtherPerformer>sample string 9</OtherPerformer>
    <PathLOINC>sample string 11</PathLOINC>
    <PathLab>sample string 10</PathLab>
    <PathResultId>be298179-2e67-4bf3-b517-a78717e3df64</PathResultId>
    <ReferenceId>bd163d41-bee2-44b9-a817-d4bfa35e529a</ReferenceId>
    <Source>sample string 13</Source>
    <Tag>sample string 14</Tag>
    <TestDate>2025-11-19T22:47:42.6383254+02:00</TestDate>
    <Type>sample string 6</Type>
    <Unit>sample string 5</Unit>
    <Value>sample string 4</Value>
  </ClinicalMetric>
  <ClinicalMetric>
    <DatePrecision>sample string 7</DatePrecision>
    <Group>sample string 2</Group>
    <Interpretation>sample string 8</Interpretation>
    <Name>sample string 3</Name>
    <NextScreeningDate>2025-11-19T22:47:42.6383254+02:00</NextScreeningDate>
    <Notes>sample string 15</Notes>
    <OtherPerformer>sample string 9</OtherPerformer>
    <PathLOINC>sample string 11</PathLOINC>
    <PathLab>sample string 10</PathLab>
    <PathResultId>be298179-2e67-4bf3-b517-a78717e3df64</PathResultId>
    <ReferenceId>bd163d41-bee2-44b9-a817-d4bfa35e529a</ReferenceId>
    <Source>sample string 13</Source>
    <Tag>sample string 14</Tag>
    <TestDate>2025-11-19T22:47:42.6383254+02:00</TestDate>
    <Type>sample string 6</Type>
    <Unit>sample string 5</Unit>
    <Value>sample string 4</Value>
  </ClinicalMetric>
</ArrayOfClinicalMetric>

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 'ClinicalMetricVo[]'.

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": "1351d111-d8ce-4d41-880b-f8b209cb6cc8",
  "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>1351d111-d8ce-4d41-880b-f8b209cb6cc8</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>