OB Flowsheet

The OB Flowsheet feature allows the user to create, modify or delete a prenatal flowsheet for a given OB Episode. The OB Flowsheet Reference allows the user to view the list of configured fields for an OB Episode.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Add prenatal flowsheet to OB episode

POST
/v1/{practiceid}/chart/{patientid}/obepisodes/{obepisodeid}/flowsheets
BETA: Adds a prenatal flowsheet for a given OB Episode
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
obepisodeid integer obepisodeid
Content-Type string Content type of the payload

❙ Request Body

Expand all
albumin integer Observations of patient's albumin. Options for albumin values can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
bishopscore integer Observations of a score that assists in predicting the likelihood that labor will need to be induced.
blood integer Observations of patient's blood values. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
bloodpressure array A JSON array of information about the patient's blood pressure
cervixexam object Information about cervix exams.
comments string Comments for the encounter
departmentid integer ID of the department the patient was seen in.
edema string Patient's edema values. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
encounterdate string Date in which the patient was seen.
estimatedfetalweight string Observations of the estimated weight of fetus. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
fetalheartrate array A JSON array of observations of information about the fetal heart rate.
fetalmovement array A JSON array of observations of fetal movement. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
fundus object Observations of information about the fundus.
gestationage string This is a string that includes the number of weeks from the beginning of the gestation followed by a period, followed by the number of days of the gestation. For example, a string that says 2.3 means 2 weeks and 3 days, or a total of 17 days. There can be multiple observations of this field.
glucose string Observations of patient's glucose. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
ketones string Observations of ketones. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
leukocytes string Observations of Patient's leukocytes. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
modifiedbishopscore integer Observations of a score that assists in predicting the likelihood that labor will need to be induced, but weights the solution for a number of other factors (such as the existence of pre-eclampsia) that aren't captured by the Bishop Score.
nitrite string Observations of patient's nitrites. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
patientreportofpain integer Patient report of pain. This is a string, but it's typically reported on a scale from 1 to 10
phofurine string Observations of PH of patient's urine.
presentation array Observations of presentation. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
pretermlaborsigns string Options for preterm labor can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
protein integer Observations of patient's protein. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
provider string Name of the rendering provider. If not supplied, this will default to the username of the providerid supplied.
providerid integer ID of the rendering provider
specificgravityofurine string Observations of the specific gravity of patient's urine.
weight array A JSON array of observations of patient's weight.

Output Parameters

Expand all
error string The error message if the transaction failed
success string Flag representing if the transaction was successful or not
Example Code

Update flowsheet of OB episode

PUT
/v1/{practiceid}/chart/{patientid}/obepisodes/{obepisodeid}/flowsheets/{flowsheetid}
BETA: Modifies a specified prenatal flowsheet for a given OB Episode
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
flowsheetid integer flowsheetid
patientid integer patientid
obepisodeid integer obepisodeid
Content-Type string Content type of the payload

❙ Request Body

Expand all
albumin integer Observations of patient's albumin. Options for albumin values can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
bishopscore integer Observations of a score that assists in predicting the likelihood that labor will need to be induced.
blood integer Observations of patient's blood values. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
bloodpressure array A JSON array of information about the patient's blood pressure
cervixexam object Information about cervix exams.
comments string Comments for the encounter
edema string Patient's edema values. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
estimatedfetalweight string Observations of the estimated weight of fetus. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
fetalheartrate array A JSON array of observations of information about the fetal heart rate.
fetalmovement array A JSON array of observations of fetal movement. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
fundus object Observations of information about the fundus.
gestationage string This is a string that includes the number of weeks from the beginning of the gestation followed by a period, followed by the number of days of the gestation. For example, a string that says 2.3 means 2 weeks and 3 days, or a total of 17 days. There can be multiple observations of this field.
glucose string Observations of patient's glucose. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
ketones string Observations of ketones. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
leukocytes string Observations of Patient's leukocytes. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
modifiedbishopscore integer Observations of a score that assists in predicting the likelihood that labor will need to be induced, but weights the solution for a number of other factors (such as the existence of pre-eclampsia) that aren't captured by the Bishop Score.
nitrite string Observations of patient's nitrites. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
patientreportofpain integer Patient report of pain. This is a string, but it's typically reported on a scale from 1 to 10
phofurine string Observations of PH of patient's urine.
presentation array Observations of presentation. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
pretermlaborsigns string Options for preterm labor can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
protein integer Observations of patient's protein. Options can be found via GET /chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
specificgravityofurine string Observations of the specific gravity of patient's urine.
weight array A JSON array of observations of patient's weight.

Output Parameters

Expand all
error string The error message if the transaction failed
success string Flag representing if the transaction was successful or not
Example Code

Delete flowsheet of OB episode

DELETE
/v1/{practiceid}/chart/{patientid}/obepisodes/{obepisodeid}/flowsheets/{flowsheetid}
BETA: Deletes a specified prenatal flowsheet for a given OB Episode
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
flowsheetid integer flowsheetid
patientid integer patientid
obepisodeid integer obepisodeid

Output Parameters

Expand all
success string Returns a boolean true if successfully deleted the prenatal flowsheet.
Example Code

Get reference field-list for prenatal flowsheet

GET
/v1/{practiceid}/chart/{patientid}/obepisodes/{obepisodeid}/flowsheet/configuration
BETA: Retrieves the valid fields for a prenatal flowsheet in an OB Episode
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
obepisodeid integer obepisodeid

Output Parameters

Expand all
name string The name of the field.
parentfield string The name of the field that this field is nested under, if this field should be nested in an object.
units string Contains which units are currently configured if the field can be configured to use specific units.
validoptions array The list of valid inputs if this field only accepts certain values.
Example Code