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

Endpoints

Primary

GET

Get patient's list of OB
episodes

POST

Create new OB episode for the
patient

GET

Get specific OB episode
details

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

❙ Request Body

Expand all

departmentid integer The department ID

numberofgestations string Used to track multiple gestation pregnancies. If more than one fetus is present, additional columns are inserted into the flowsheet to track findings specific to each fetus: presentation, fetal heart rate, and fetal movement.

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.

anesthesia string Whether Anesthesia was used. Options include: General, Local, etc...

comments string Any notes that are related to the delivery

deliveredby string Username of provider who delivered.

deliverydate string The delivery date.

deliverysite string Site of delivery.

dischargedate string The date of discharge.

fetusdata array An array of outcomes, where each outcome is associated with a different fetus.

admittedtonicu string Admitted to NICU. Options are true or false.

birthweightingrams string The birthweight in grams.

birthweightlbs string The pound portion of the birthweight of the fetus. E.g. If the weight is 8 pounds and 5 ounces, this field would be equal to 8.

birthweightoz string The number of ounces of the birthweight that is remaining after the number of pounds of birthweight has already been expressed. E.g. If the weight is 8 pounds and 5 ounces, this field would be equal to 5.

circumcisionyn string Whether the baby was circumcised. Options are true or false.

deliverytype string The type of delivery. Options are user entered fields that vary by practice.

ethnicity string The ethnicity of the baby.

fetusid string The athena ID of the fetus.

firstname string First name of baby.

gestationlastmodifiedby string The username of the user who last modified the gestation. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

gestationlastmodifieddate string The date/time the gestation was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

gestationoutcomelastmodifiedby string The username of the user who last modified the gestation outcome. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

gestationoutcomelastmodifieddate string The date/time the gestation outcome was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

lastname string Last name of baby.

living string Whether the fetus lived.

outcome string The outcome of the gestation. Use 'GET /chart/reference/obdeliveryoutcomes' for the full list of outcomes.

outcomeid integer The outcome ID

pediatriccomplications string Description of any complications the fetus might have experienced.

race string The name of the primary race of the baby.

racecodes array The list of races for the baby using the 2.16.840.1.113883.5.104 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html

sex string The sex of the fetus.

incisiontype string One of (Low Transverse, Low Vertical, Classical).

labor string The type of labor. For example: Spontaneous, Induced etc...

laborlengthhrs string Hours of labor involved in delivery.

postpartumcomplications string one of (None, Hemorrhage, Infection, Hypertension, Other)

pretermlabor string Whether this pregnancy had preterm labor signs. Options are Y or N.

tubalsterilization string Whether Tubal Sterilization was used

weeksgestation 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.

dischargeinformation object Discharge information.

eddcalculation object Expected delivery date information.

initialeddconfirmedby string Username of individual who confirmed initial EDD, which the can be set manually or calculated based on other populated fields.

initialeddconfirmeddate string The date on which the initial EDD was set.

initialedddate string Expected delivery date at the initial exam.

initialexam object Information about the initial exam

initialexamdate string Date of initial exam.

initialultrasounddate string Date of first ultrasound.

lastmenstrualperiodinfo object Last menstrual period information.

ultrasounddaysgestation integer Fetus age in days.

ultrasoundweeksgestation integer Fetus age in weeks.

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.

frequencyq string Length of duration for patient's typical monthly period.

hcgplusdate string Date of positive Human Chorionic Gonadotropin pregnancy test.

lastmenstrualperiodinfo object Last menstrual period information.

menarcheonsetage string Age at onset of initial menstrual period.

mensesmonthly string Whether the patient has a monthly period or not.

onbcpconception string Specify if the patient was on birth control pills at conception.

priormenses string Date of patient's prior period.

obepisodeinformation object OB Episode information.

plansandeducation object Plans and education information.

firsttrimester array Plans and education for the first trimester

discussedby string Username of person who discussed the item with the patient.

discusseddate string The date of the discussion.

discussionitem string The item discussed.

discussionitemlastmodifiedby string The username of the user who last modified the discussion item. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionitemlastmodifieddate string The date/time the discussion item was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionlastmodifiedby string The username of the user who last modified the discussion. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionlastmodifieddate string The date/time the discussion was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

note string The notes taken on the discussion.

secondtrimester array Plans and education for the second trimester

discussedby string Username of person who discussed the item with the patient.

discusseddate string The date of the discussion.

discussionitem string The item discussed.

discussionitemlastmodifiedby string The username of the user who last modified the discussion item. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionitemlastmodifieddate string The date/time the discussion item was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionlastmodifiedby string The username of the user who last modified the discussion. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionlastmodifieddate string The date/time the discussion was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

note string The notes taken on the discussion.

thirdtrimester array Plans and education for the third trimester

discussedby string Username of person who discussed the item with the patient.

discusseddate string The date of the discussion.

discussionitem string The item discussed.

discussionitemlastmodifiedby string The username of the user who last modified the discussion item. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionitemlastmodifieddate string The date/time the discussion item was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionlastmodifiedby string The username of the user who last modified the discussion. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

discussionlastmodifieddate string The date/time the discussion was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

note string The notes taken on the discussion.

pregnancyproblemlist object Pregnancy problem information.

listnote string Pregnancy problems note

problems array Array of all pregnancy problems

enddate string The end date for the pregnancy problem.

hidden string Designates whether or not the problem was hidden from the chart.

lastmodifiedby string The username of the user who last modified this problem. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

lastmodifieddate string The date/time this problem was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

note string Notes about the pregnancy problem.

problemname string Problem name. For example, Gestational Diabetes.

resolution string The plan for the resolution of the pregnancy problem.

snomedcode string The snomed code for the pregnancy problem.

startdate string The start date for the pregnancy problem.

prenatalflowsheet array Information from each encounter that has been captured in the prenatal flowsheet.

albumin string Observations of patient's albumin. Options for albumin values are: None, Trace, 1+,2+,3+,4+

bishopscore string Observations of a score that assists in predicting the likelihood that labor will need to be induced.

blood string Observations of patient's blood values (neg,Trace,1+,2+,3+)

bloodpressure array Information about the patient's blood pressure

cervixexam object Information about cervix exams.

comments string Comments for the encounter

edema string Options for patient's edema values (none, trace, 1+,2+,3+,4+)

estimatedfetalweight string Observations of the estimated weight of fetus.

fetalheartrate array Observations of information about the fetal heart rate.

fetalmovement array Observations of fetal movement. Options include: Yes,No,Decreased,Increased

flowsheetdate string Date for this entry in the prenatal flowsheet

flowsheetid string ID for this prenatal flowsheet.

fundus object Observations of information about the fundus. Units are 'wks' or 'cm'.

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 include: none, trace, 1+,2+,3+,4+.

ketones string Observations of ketones. Options include: neg,small,moderate,large,trace

leukocytes string Observations of Patient's leukocytes. Options include: none, trace, 1+,2+,3+

modifiedbishopscore string 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 are Positive or Negative for each observation.

patientreportofpain string 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 include: Vertex, Breach,Transverse,Cephalic,Oblique

pretermlaborsigns string Options for preterm labor signs are: None,backpain,bleeding, cramping,uterine contractions,other,pressure,braxton hicks

protein string Observations of patient's protein. Options include: neg,trace,1+,2+,3+,4+

providerid string Provider id.

specificgravityofurine string Observations of the specific gravity of patient's urine.

weight array Observations of patient's weight.

status string The status of this OB episode (OPEN, CLOSED, DELETED, etc...)

Example Code