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

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

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

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