OB Delivery Information

The OB Delivery Information feature allows the user to retrieve the delivery information for an OB Episode. The OB Delivery Outcomes Reference allows the user to view the list of configured outcomes for OB delivery. The OB Delivery Sites Reference allows the user to view the list of configured delivery sites for an OB Delivery. The OB Delivery Types Reference feature allows the user to view the list of configured delivery types for an OB Delivery.

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

Endpoints

Update delivery information for OB episode

PUT
/v1/{practiceid}/chart/{patientid}/obepisodes/{obepisodeid}/deliveryinformation
BETA: Modifies the delivery information 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
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
anesthesia string What, if any, anesthesia was used during labor and delivery.
comments string Any notes on the delivery.
deliveredby string The name of the provider who delivered the baby.
deliverydate string Date of delivery of termination or pregnancy.
deliverysiteid integer The location (site) of the delivery. Use GET /chart/configuration/obdeliverysites to get the list of valid site IDs. If the location is not listed then use deliverysiteother. Please note that both cannot be specified.
deliverysiteother string A freetext field recording the location of the delivery. Cannot be specified along with deliverysiteid.
dischargedate string The date the mother was discharged.
fetusdata array The data about the fetuses delivered. The number of items in this array must reflect the number of fetuses in the OB Episode Information section. The input generally reflects the fetusdata output of GET /chart/{patientid}/obepisodes/{obepisodeid} with a couple of exceptions. This uses birthweightlbs and birthweightoz instead of grams. It also uses ID numbers for deliverytype, ethnicity, outcome, and race. See the documentation for those individual inputs for more information. If you update the information for one fetus you must update the information for all fetuses.
incisiontype string The type of incision.
labor string The type of labor.
laborlengthhrs number Length of labor in hours.
postpartumcomplications string Select any postpartum complications.
pretermlabor boolean Boolean to indicate if the labor was preterm.
tubalsterilization boolean Boolean to indicate tubal sterlization.
weeksgestation number The gestation time in the format weeks.days (ex: 35.2 is 35 weeks and 2 days.)

Output Parameters

Expand all
success string True if the put was successful, otherwise false.
Example Code

Get reference list for OB delivery outcomes

GET
/v1/{practiceid}/chart/reference/obdeliveryoutcomes
BETA: Retrieve a list of outcomes for an OB Delivery
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

Output Parameters

Expand all
name string A descriptive name for the gestation outcome.
outcomeid integer The ID of the gestation outcome.
Example Code

Get reference list for OB delivery sites

GET
/v1/{practiceid}/chart/configuration/obdeliverysites
BETA: Retrieve a list of valid delivery sites for an OB Delivery
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
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
deliverysiteid integer The ID of the delivery site.
name string The name of the delivery site.
Example Code

Get reference list of OB delivery types

GET
/v1/{practiceid}/chart/configuration/obdeliverytypes
BETA: Retrieves a list of valid delivery types for an OB Delivery
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
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
deliverytypeid integer The ID of the delivery type.
name string The description of the delivery type.
Example Code