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
- Primary
- Reference
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
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 allOutput 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
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
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
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