/
QIVF API - reference to required fields

MellowoodMedical Online Help

QIVF API - reference to required fields

Suggested workflow

When the cycle lab data is entered, the QIVF submission should be checked on that individual patient , to fix any errors there may be in the data entry. they can then change the patient approval to ‘yes’ - the form will not submit without doing this, but it should only be changed to yes once you are happy it is ready to submit.

Then , at regular intervals of your choice , someone should submit forms in a batch using the QIVF manager .

Instructions are below - please note that some field still need to manually entered for quality purposes.


To access a QIVF form for an individual patient from the treatment cycle

  • Open the form by clicking the QIVF button on the QIVF tab

image-20240611-122252.png
  • Click collect

image-20240611-122355.png
  • Review the validation rules and amend any fields required. See below table for the items that you will need to enter manually.

 

image-20240611-122521.png

 

You should ALWAYS review the information in the form, even when there are no validation rules, to ensure it is correct - see the comments in the table below.

Once you are ready to submit the form, change field 7 to ‘yes’ (it will always default to no) - you will have to manually update to ‘yes’ once you are happy that the information in the form is correct and you are ready to submit. All validation issues should have been resolved before you select ‘yes’.

image-20240611-122559.png

Click save and close - if you haven’t selected yes in field 7 before you do this , the form will not be submitted.

 

image-20240611-122733.png

 

You will then go to QIVF Manager to submit this form

QIVF Manager

  • Go to Extra>QIVF Manager

  • Choose the appropriate action and start date range from the drop down menus.

  • Click Collect

image-20240612-095549.png
  • Any validation errors need to be resolved before Export to QIVF.

  • Forms with validation errors are indicated in the ‘Status’ column.

  • Double click on a cycle to open it and resolve the errors.

  • Remember that forms will not be able to be exported unless the patient consent in field 7 is noted as ‘yes’

Once you are ready to submit the forms to QIVF click ‘Export’

Table of QIVF fields

QIVF Form field

Allowed values

QIVF comment

Related IDEAS field

  1. The woman's social security number (SSN)

YYMMDD-1234

The full personal identity number must be filled in, ten digits. For foreign patients, who do not have the last four digits, use the code system you usually use. However, it must be made clear that it is patients abroad.

Type of social security number for the woman.
Enter if Swedish social security number, other (=foreign)
or
anonymous = the patient does not want to be included in the quality register
with identified data.
Data can still be sent to the quality register, but enter only those first four digits,
i.e. year and month.
1 = Swedish.
2 = Other.
3 = Anonymous.

 

image-20240611-101046.png

this must be completed in Demographic details for it to autocomplete in the form

  1. Type of social security number, female

  1. Swedish,

  2. Other

  3. anonymously

 

This will complete as option 1. Swedish in the form - if this is not the case you will have manually edit in the form

3. Partner's social security number

YYYYMMDD-1234

The full personal identity number must be filled in, 12 digits. For foreign patients, who do not have the last four digits, use the code system you usually use. However, it must be made clear that these are foreign patients. For patients who wish to remain anonymous, data must be submitted, but provide ID

only by year and month.

 

image-20240611-101046.png

this must be completed in Demographic details for it to autocomplete in the form

 4.   Type of social security number, partner

1 Swedish
2 Other
3 anonymously
4 Missing partner
9 not relevant

No. 1: for foreign personal identity number

No. 4: used for all single people doing treatment

Option 'not relevant' is used, for example, in egg freezing (own or donor).   Thus used in cycles that are not intended to go to pregnancy. New option 2018. 'Partner missing" refers to e.g. IVF or AID, single women.

This will complete as option 1. Swedish if there is a partner - if this is not the case you will have manually edit in the form

5.  Intends to give birth in Sweden

1 Yes
2 No
9 Unknown

 

This should be manually completed in the form

6.  Previously given birth

0 = No.

1 = Yes.

Specified regardless of the partner.   No further comment.

This should be manually completed in the form

  1. Patient approval

0 = No.
1 = Yes.

 

This will autocomplete as ‘no’.

you will have to manually update to ‘yes’ once you are happy that the information in the form is correct and you are ready to submit. All validation issues should have been resolved before you select. ‘yes’

  1. ID cycle

Digit

Unique number for  each treatment,  fresh as well as  frozen, cancelled as well as completed.   

this is the Tx number of the cycle - you can manually complete this , but there is no validation associated with it and will not stop you submitting the form

  1. Date start of treatment

YYYY-MM-DD

  • Fresh, stimulated cycle = stimulation start with gonadotropin

*Fresh, natural cycle: = SM. .

*Freeze stimulated cycle = start date regardless of the hormone preparation.

*Freeze natural cycle = SM.   If SM unknown, the thaw date minus 14 days is entered as the start date.

*AID/AIH = given as thawing cycles

Treatment Plan Start Date

 

image-20240611-101617.png

 

10. Type of Embryo transfer

1 = Fresh.
2 = Frozen.

Refers to all planned IVF.   To be completed regardless of ET  or not.

This completes automatically - related to treatment type

11.  Planned treatment

  1. IVF

  2. ICSI

  3. Combination

  4. AID (Donor insemination)

  5. -

  6. Husband's insemination

  7. Embryo donation

Indicated in "fresh treatments", treatment with freeze-thawed oocytes or recipient cycle for egg donation.

*To be completed also for  cycles broken prior to egg aspiration.

*Combination can e.g. be 50/50 or 30/70.

*Converted (ovulation induction/AIH) converted  to IVF  should be written as "IVF"

In the database there is also a historical option (5-Receive treatment egg donation).  Not to be reported Option 5,  remains for the time being due to historical data,

these will autocomplete - you should review for accuracy every time

either field 11 or field 12 should be completed NOT both

12.  Other type of treatment

  1. Egg donor

  2. Own egg freezing oncological

  3. Embryofreeze, oncology

  4. Own egg freeze social

  5. Own egg freeze, other medical

  6. Own egg freeze before sex change

  7. Fertilisation of  donated eggs with planned total freezing of embryos ( NEW)

Applies only to cycles that are not intended to go to ET for the person in question in this cycle.

No. 1: Egg donor = stimulation prior to egg donation.

No 2: Egg freezing  own (oncological,  social  or  other medical or before sex change) = unfertilized eggs frozen for personal use  No. 3: Embryo freezer oncologic = embryos frozen for personal use e.g. for cytostatic treatment

No 7: Egg receiving cycle where no fresh ET is planned.  Applies to both fresh donor eggs  and freeze-thawed  donor eggs  . As the start of the cycle, write the estimated day of conception (day 0) minus 14 days.

these will autocomplete - you should review for accuracy every time

either field 11 or field 12 should be completed NOT both

13. Stimulation

Stimulated

  1. Stimulated (historical not specified)

  2. Unstimulated

  3. Antagonist

  4. Agonist

Stimulation refers to all types of stimulation (CC, GnRH, FSH, hMG, hCG, E2 before freeze cycle).

Point 2: Unstimulated = natural cycle.

Mellowood to review - what field does this come from?

14. Egg origin

  1. Own

  2. Donated

Applies to all started cycles, fresh and freeze

 

image-20240611-103409.png

 

15. Freeze-thawed oocytes

0 = No.
1 = Yes.

Applies to all started cycles, fresh and freeze

Manually review

16. In vitro maturation

0 = No.
1 = Yes.

 

Manually review

17. Sperm Origin

  1. Own

  2. Donated

Applies to all started cycles, fresh and freeze

Autocompletes from Gametes tab / semen source

image-20240611-103425.png

 

18. Freeze-thawed sperm

0 = No.
1 = Yes.

Applies to all started cycles, fresh and freeze

Autocompletes from Gametes tab / semen source/use frozen semen check box

 19. Sperm Access

  1. Ejaculated

  2. Epididymis

  3. Testis

  4. Retrograde ejaculation

To be completed also for cycles that do not go to egg aspiration and also for freezing cycles where embryos have been thawed but not ET. If multiple types of sperm access were used in the cycle, indicate the one used for ET.

Retrograde ejaculation = sperm extracted from your bladder.

Currently this should be manually complete

Future - Mapping of these fields to the IDEAS options will mean that Autocompletes from Gametes tab / semen source/collection method

image-20240611-103446.png

 

 20.   Egg retrieval date

YYYY-MM-DD

Also to be indicated during thawing cycles.   The aim is to be able to derive frozen embryos to the respective fresh cycle.  Also applies to self-donation.   The same date will also be the freezing date for oocytes

Date follicle aspiration.
Min = Date treatment start.
Max = Today's date.
Must also be specified for freezing and thawing cycles.
the purpose is to be able to derive frozen embryos to resp. fresh
stimulation cycle.
1 = Ejaculated.
2 = Epididymis.
3 = Testis.
4 = Retrograde ejaculation.

Fresh cycles

this date will autocomplete from the date in the egg collection Lab event

 

In the case of thaw cycles;

this date will autocomplete with the date of the most recent fresh cycle egg collection, but this may not be the correct one - this date should be manually reviewed and edited if necessary - the form will automatically pull the egg collection date for the most recent fresh egg collection ,

21 Number of oocytes obtained

n

All obtained at OPU.   Valid for fresh cycle

Number received oocytes. Indicated only for fresh cycle.
Min = 0
Max = 99

Fresh cycles

this date will autocomplete from the date in the egg collection Lab event

22. Carried out fertilization method

  1. IVF

  2. ICSI

  3. Combination

Refers to how oocytes are fertilized.

 

This information will autocomplete from the insemination/injection lab event

 23.  Transferred embryo

  1. IVF

  2. ICSI

  3. Combination

method of fertilisation of the embryo(s) transferred; Indicated at both fresh and frozen cycles.

This information will autocomplete from the insemination/injection lab event connected to the embryo transferred in the embryo transfer lab event

24. Cancel treatment

  1. Cancelled before aspiration

  2. Cancelled before ET–ospec old

  3. Cancelled before fertilization

  4. Freeze all: OHSS risk

  5. Cancelled before ET - other

  6. Freeze all: PGD/PGS

  7. Freeze all:-other

  8. Cancelled before insemination
    (Not used)

No. 1: All reasons to cancel before OPU

No. 2: No longer used.   Use point 5.

No. 3: May be 0 eggs or sperm at OPU.

No. 4: All total freeze to avoid OHSS

No 5: e.g. lack of fertilisation or embryonic development (used instead of point 2). No.
7: other causes of total freezing than above

this is manual completion field - you should manually select an appropriate option

 

 

Mellowood - to remove option 2 and 8

25. Date Embryo thawing

YYYY-MM-DD

Applies to freezing cycles only.   To be completed regardless of whether ET or not.

this date will autocomplete from the Thaw Lab event

26. Date of embryo transfer

YYYY-MM-DD

Valid for both fresh and frozen cycles.

this date will autocomplete from the Embryo Transfer Lab event

27.Number of frozen Embryos

n

Only in the case of fresh cycle.

this number will autocomplete from the Freeze Lab event

28. Date embryo freezing

YYYY-MM-DD

 

this date will autocomplete from the Freeze Lab event

29. Number of transferred Embryos

n

 

For example.  1 or 2.   "0" does not need to be filled in as it appears from the fact that no ET date is filled in.

 

this date will autocomplete from the Embryo Transfer Lab event

30. Date Pregnancy test

YYYY-MM-DD

 

This date will autocomplete from the pregnancy date in the Treatment Plan

image-20240611-104005.png

 

 31. Pregnancy test results

  1. Pos

  2. Neg

  3. Got your period

  4. Missing

"N/A" includes if the result is not known. Later it will be clear for the group "Missing" if it is an ongoing pregnancy, see variable 32.

Results pregnancy test.
Missing includes not performed or received period.(This is point 3)

This date will autocomplete from the drop down fields beside the pregnancy test date in the Treatment Plan - see above

32. Date of ultrasound

YYYY-MM-DD

Guideline: Performed no earlier than 5 weeks after OPU.

This date will autocomplete from the date of gestational scan record

 

image-20240611-121414.png

 

 33. Number of gestational sacs

N

For example.  0, 1,  2, 3.  If monocygotic twins,  i.e. two foetuses in the same sac, indicate only a gestational sacs.   That they are twins is shown in variables 35-37

This number will autocomplete from the sac field in the gestational scan record - as above

 34. Date of termination of pregnancy (for pregnancies not going into delivery)

YYYY-MM-DD

Applies to all complete miscarriages (pregnancies where the entire pregnancy goes to miscarriage and not, for example, when there is a spontaneous reduction from two fetuses to one) before week 22+0.

If a miscarriage diagnosis is made on ultrasound, the date of termination of pregnancy = date of ultrasound  .

If no Ultrasound performed indicated the date of termination of pregnancy= first day of bleeding. 

For ectopic pregnancy, the date of  termination of pregnancy = date of Stillborn infants weeks 22+0 to 27+6 should be reported as childbirth.

this field may autocomplete from the cycle outcome but should always be manually reviewed

 35. Pregnancy Outcome

futus 1

  1. Ongoing viable pregnancy

  2. Ectopic pregnancy

  3. Spontaneous abortion.

  4. Legal abortion.

  5. Spontaneous fetal reduction before 13 weeks.

  6. Spontaneous fetal reduction week 13+0 – 21+6.

  7. Stillborn child week 22+0 – 27+6.

  8. Induced fetal reduction.

  9. Stillborn child at week 28+0 or more.

  10. Live birth.

  11. Unknown (lost to follow up)

 

Point 2: Positive pregnancy test, no pregnancy visible on ultrasound no earlier than 5 weeks after OPU.

 

Point 3: Requirements for previous ultrasound  or PAD verified pregnancy.

 

 

Autocompletes from cycle outcome folder

image-20240611-120226.png

 

36. Pregnancy Outcome

fetus 2

Options as above

 

As above

 37. Pregnancy Outcome

fetus 3

Options as above

 

AS above

38 Contact requested

Y/N

 

 

39. Date of childbirth

YYYY-MM-DD

Indicated at all live births, as well as at stillborn babies from week 22+0.

Autocompletes from cycle outcome folder - date of outcome field

40. Number Thawed Embryos

1, 2, 3....

Thawing cycles only.   Indicates how many embryos needed to be thawed for ET.

Autocompletes from thaw lab event

41. Method of freezing of Transferred embryos

  1. Slow freezing",

  2. Vitrification

If the ET of both slow freezing and vitrification  , it is indicated as vitrification

only related to thaw cycles - from original freeze cycle.

This should always be reviewed manually

42. BMI

Numeric variable (13-52)

Enter with one decimal place at the start of treatment.   Specified for each cycle.

Autocompletes from Progress Notes / Physical Characteristics

image-20240611-120703.png

 

 43. Lost of follow up

  1. Yes

  2. No

Indicated for cycles where pregnancy is unknown    or not, and for cycles where termination of pregnancy is unknown  . 

Autocompletes from cycle outcome folder

image-20240611-120226.png

 

44. Total gonadotropin dose

Numeric variable

Enter the total dose of recombinant gonadotropin and/or urine-derived gonadotropin.   Applies to fresh cycles only

Enter total dose FSH+hMG for the cycle. Enter total dose of recombinant gonadotropin and/or urine derived gonadotropin.

Should autocomplete - need 7.0.14.83

Stimulation codes need added to Product Code in DTP

45. Preimplantation genetic diagnosis

0 = No. 1 = PGD. 2 = PGS.

 

These cycles are also reported  as "proprietary gametes"

 

  1. Date of insemination

YYYY-MM-DD

Applies to both AIH and AID.

Autocompletes from insemination event

47. Previous IVF children

This variable is not used

Calculated by the register.
Does not need to be reported

 

48. Former ant. failed

fresh started IVF cycles

This variable is not used

Calculated by the register.
Does not need to be reported

 

 49 Complications

  1. Yes

  2. No

Applies only to adverse complications during treatment and up to a negative pregnancy test or a positive pregnancy test, up to five weeks after ET.

To be reported from 2014.  Note the difference between this variable (49), which is mandatory, and the other complication variables.  Variable 49 shall be yes/no.  If yes, at least one of the following

Addressed.  (but they are only =1 for yes).

Manual entry if relevant

50. OHSS —hospitalized

Yes

Applies both with and without ascite tapping

Manual entry if relevant

51. OHSS - Paracentesis

Yes

Applies to outpatient asciclinic apportionment only???

Manual entry if relevant

52. Infection

Yes

requiring hospitalisation

Manual entry if relevant

53. Bleeding

Yes

requiring hospitalisation

Manual entry if relevant

54. Ovarian torsion

Yes

Surgically remedied

Manual entry if relevant

55. Troboembolic disease

Yes

Diagnosed with ultrasound/phlebography/CT and treated with anticoauglantia, NB not e.g. Fragmin prophylaxis

Manual entry if relevant

56. Other serious Complication

Diagnostic code and action code(s)

ICD-code

Manual entry if relevant

57. Number of days of cultivation at ET

2,3,4,5,6,7

 

Min = 1
Max = 7

Applies to both fresh and frozen embryos

From lab event transfer lab event - day autocompletes from day of embryo

58. Pregnancy ultrasound performed

  1. Yes

  2. Not performed due to miscarriage

  3. No

Applies to both fresh cycle and thaw cycle. If yes, enter the date on variable 32

 

59. ?????

 

 

 

60. Number of frozen oocytes

n (0-99)

Only in the case of fresh cycle

Number of oocytes that were frozen at the time Indicated only for fresh cycle.
Min = 0
Max = 99

Autocompletes from egg thaw lab event

61 Date of oocyte Thawing

YYYY-MM-DD

 

egg thaw lab event

62. Drugs(fresh treatment)

ATC-code

Applies to all medicines used for treatment.

Applies to all drugs used for treatment and for adjuvant drugs.

For total dose of gonadotropins, see variable 44. Other medicinal products only by ATC code.

There are two variables that contain info about medicines.
One concerns drugs at the fresh cycle (this variable).
The second applies to medicines for future freezing cycles (next variable-new design).
In this way, it is possible to trace medicine used partly during egg aspiration and partly during the frozen treatment.

from treatment plan

ALl drugs in use should be configured in ‘Product Code’ field in DTP

63. Financing of Treatment

  1. Publicly funded

  2. Privately financed

 

Intended treatment tab

 64. Clinics

According to list

 

From CLcini site drop down image-20240612-102626.png

65. Drugs (frozen/thawed cycles)

ATC-code

Applies to all drugs used for treatment.

 

 

66. Cycle ID of cycle then oocytes (own or Donated ) was frozen

 

Digit

Applies to frozen oocytes thawed for fertilization

The unique ID number (see variable 8)  of the egg freezing cycle)

no validation associated with this

67. Embryo donation

Yes

 

manually review

68. Number of children born

1,2,3,4

Control variable

should autocomplete from outcome folder

Issues identified 11/06/24

Fresh cycles

  • Drugs (rule 62) and total dose (rule 44) are not pulling through to the form - clinic should be updated

  • Rule 41. freeze method rule - this is only relevant with thaw cycles and should not complete for fresh cycles

Thaw cycles

  • the number of embryos thawed is not collecting

  • the egg collection pulls from the fresh cycle where the embryos where frozen but there is still an error saying it is missing

All cycles with ET

  • none of these validation rules should be active unless field 31 is completed with ‘pos’

image-20240611-115816.png

 

Related content