OB Episode

The OB Episode is a mechanism to track OB enrollments and information about clinical outcomes. Enrollment, EDD, and Delivery reports organize information captured in the OB episode. OB episode information is updated as the pregnancy progresses.

SOCIAL HISTORY
Both the social history and OB/GYN history sections contain custom questions, where each question follows its own format. Both sections can contain global or local questions defined by the practice. 
•  'inputtype' is the input type of the question. 
•  'text' is the patient-facing name of the question. 
• 'fields' contains the answer to the question being asked. It always contains DEFAULT, which is the answer to the question.  
• 'dropdownvalues' (which only exists if inputtype = DROPDOWN) lists the possible answers to this question. 
•  'clinicalelementid' is the unique global social history question identifier.  
•  'localclinicalelementid' is the unique practice-specific social history question identifier. Only one or the other will exist for each question, identifying whether it's a global or practice-defined question. You can use this field to tie the same question across multiple forms, and to perform global optimizations.

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

Get patient's list of OB episodes

GET
/v1/{practiceid}/chart/{patientid}/obepisodes
Retrieves a list of OB Episodes for a specific patient
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
departmentid integer Department ID
showclosed boolean Designates whether we will also show closed obepisodes. The default value is false.

Output Parameters

Expand all
closeddatetime string The date when the OB episode was closed.
closereason string The reason for the clinical episode's closure. Options include: Pregnancy Completed, Patient Transferred, Closed by AthenaNet etc...
createdby string The username of the user who created this OB episode.
createddatetime string The date/time this OB episode was created.
deliverydate string The actual delivery date.
edddate string The estimated delivery date.
initialexamdate string The initial exam date.
lastmodifiedby string The username of the user who last modified this OB episode. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.
lastmodifieddatetime string The date this OB episode was last modified
obepisodeid integer The ID of the OB episode
outcome array An array of outcomes, where each outcome is associated with a different fetus.
primaryproviderid integer Primary provider that is associated with this patient. This is the patient's current provider, and not necessarily the one that was associated with the clinical episode.
status string The status of this OB episode (OPEN, CLOSED, DELETED, etc...)
Example Code

Create new OB episode for the patient

POST
/v1/{practiceid}/chart/{patientid}/obepisodes
BETA: Creates a new record of OB Episode for a specific patient
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
Content-Type string Content type of the payload

Output Parameters

Expand all
obepisodeid integer The ID of the ob episode.
Example Code

Get specific OB episode details

GET
/v1/{practiceid}/chart/{patientid}/obepisodes/{obepisodeid}
Retrieves details of a specific 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
showhiddenproblems boolean Designates whether we will also show hidden problems. The default value is false.
showeddcalculationsdays boolean Designates whether we will also show eddcalucation days. The default value is false.

Output Parameters

Expand all
deliveryinformation object Delivery information.
dischargeinformation object Discharge information.
eddcalculation object Expected delivery date information.
eighteentotwentyweekeddupdate object Information from the 18-20 week update.
episodecreatedby string The username of the user who created this OB episode.
episodecreateddate string The date/time this OB episode was created.
episodelastmodifiedby string The username of the user who last modified this OB episode. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.
episodelastmodifieddate string The date/time this OB episode was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.
episodeobclosedby string The username of the individual who closed this episode.
episodeobcloseddatetime string The date at which this episode was closed.
episodeobclosereason string The reason for the clinical episode's closure. Options include: Pregnancy Completed, Patient Transferred, Closed by AthenaNet etc...
geneticscreeningandinfectionhistory array Genetic screening and infection history information.
menstrualhistory object Menstrual history information.
obepisodeinformation object OB Episode information.
plansandeducation object Plans and education information.
pregnancyproblemlist object Pregnancy problem information.
prenatalflowsheet array Information from each encounter that has been captured in the prenatal flowsheet.
status string The status of this OB episode (OPEN, CLOSED, DELETED, etc...)
Example Code