Resources

For endpoints, see API.

Available resource-types

RESOURCE_TYPE	Description
antenatalAppointments	Antenatal appointments (Svangerskapskonsultasjoner)
clinicalTests	Includes recommended blood tests (Anbefalte prøver) and tests taken when required (Prøver ved behov)
currentPregnancy	Current pregnancy (Aktuelt svangerskap)
geneticDisorders	Genetic disorders (Arvelige sykdommer)
lifestyleFactors	Lifestyle factors (Levevaner)
medicalConditions	Medical conditions (Tidligere/nåværende sykdommer)
medication	Medication (Legemiddelopplysninger)
mother	The pregnant woman (mother) for this maternity record
pointsOfContact	GP, midwife etc (Fastlege, jordmor etc)
previousPregnancies	Previous pregnancies (Tidligere svangerskap)
rhesusDNegative	Info needed when mother tested negative for presence of Rhesus D-antigen (RhD-negativ gravid)
vitalMeasurementsBeforePregnancy	Vital measurements before pregnancy (Vitale mål før svangerskap)
symphysisFundalHeights	Symphysis-fundal height measurement (Symfyse-fundusmål)

CodeAndSystem

The data type "CodeAndSystem" is used for fields where a code system is used.

On create/update requests, only value is required, and the server will add values for display and codeSystem if they are not set.

Field	Type	Required	Description
code	String	x	The code value
display	String		Human readable display value
codeSystem	String		Code system

{
  "code": "NO",
  "display": "Norge",
  "codeSystem": "VOLVEN_9043"
}

Antenatal appointments

Field	Type	Required	Description
metadata	Metadata		Metadata for the object, with the version of the registration
appointmentDate	Date	x	AppointmentDate
pregnancyWeek	Int		Pregnancy week
gestationalAge	String (format: week+day)		Gestational age
motherWeight	Float		Mother's weight
bloodPressure	String (format: systolic/diastolic)		Blood pressure ( systolic/diastolic)
proteinInUrineTestResult	Enum: Neg, Spor, 1+, 2+, 3+		Protein in urine test result - NPU04206. Values from Tekstlige resultatverdier (8340)
edema	Enum: 0,1,2,3		Edema
fetusesVitalSigns	List		List with vital signs for each fetus
medication	Boolean		Use medication
employmentRate	Int		Employment rate ( as a percentage)
note	String		Appointment note

Fetus vital signs attributes

Field	Type	Description
fosterId	Int	Id for the fetus
fetalHeartRate	Int	Fetal heart rate/ minute
fetalPresentationLie	CodeAndSystem VOLVEN_8534	Fetal presentation/ lie - Presentassjon/leie ved svangerskapskonsultasjon (8534)
motherFeelsBabyMovements	Boolean	Mother feels baby's movements

JSON Example

{
  "metadata": {},
  "appointmentDate": "2024-04-23",
  "pregnancyWeek": 23,
  "gestationalAge": "32+2",
  "fetusesVitalSigns": [
    {
      "fosterId": 1,
      "fetalHeartRate": 79,
      "fetalPresentationLie": {
        "code": "1",
        "display": "Hodeleie",
        "codeSystem": "VOLVEN_8534"
      },
      "motherFeelsBabyMovements": false,
      "note": "foster 1 note"
    }
  ],
  "motherWeight": 64.7,
  "bloodPressure": "128/78",
  "proteinInUrineTestResult": {
    "value": "1+"
  },
  "edema": 1,
  "medication": false,
  "employmentRate": 100,
  "note": "my appointment 1 note"
}

Clinical tests

Field	Type	Description
hemoglobin	Float	Test for B-Hemoglobin Value must be a floating point and reported in unit(måleenhet) as described in NOR05172
ferritin	Float	Test for either P-Ferritin or S-Ferritin Value must be a floating point and reported in unit(måleenhet) as described in NPU19763
hbv	String	Test for Hepatitis B-Virus S-antigen
hbvCore	String	Test for Hepatitis B-Virus Core-antigen
hiv	String	Test for HIV (Human Immunodeficiency Virus )
syphilis	String	Test for Syphilis
aboRh	Object (see below)	Tests for ABO bloodtype and test for presence of RhesusD antigen
bloodantigens	String	Test for presence of blood antigens
chlamydia	String	Test for Chlamydia
toxoplasmosis	String	Test for Toxoplasmosis
rubellaAntigen	String	Test for presence of Rubella Antigen
hepatitisC	String	Test for Hepatitis C
mrsaVreEsbl	String	Test for presence of MRSA, VRE or ESBL (Antibiotic resistant bacteria)
bHbA1c	Integer	Test for long term concentration of blood glucose Value must be an integer and reported in unit(måleenhet) as described in NPU27300

The object for aboRh is its own object

Field	Type	Required	Description
aboType	String		Test result for ABO typing of erythrocytes. Accepted values are the ABO values: 'A', 'B', 'AB', 'O' NB! We do not accept the digit 0 to represent the bloodtype O. We accept only the character 'O'
rhesusDType	String		Test result for for presence of Rhesus D Antigen. Accepted values are: 'POSTIVE' and 'NEGATIVE'

JSON Example

{
  "metadata": {},
  "hemoglobin": 20.0,
  "ferritin": 30.0,
  "hbv": null,
  "hbvCore": null,
  "hiv": null,
  "syphilis": null,
  "aboRh": {
    "aboType": "AB",
    "rhesusDType": "NEGATIVE"
  },
  "bloodantigens": null,
  "chlamydia": null,
  "toxoplasmosis": null,
  "rubellaAntigen": null,
  "hepatitisC": null,
  "mrsaVreEsbl": null,
  "bHbA1c": 56
}

Please make sure the values represent the correct unit of measurement. The unit of measurement used is the one described in their respective NLK Codesystem.

Check the documentation for what unit to use:
NPU27300
NPU19763
NOR05172

Current Pregnancy

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
dateLastPeriod	Date	The first day of the last period
dueDate	Date	Due date
dueDateBasedOnUltrasound	Date	Due date based on ultrasound examination
dueDateCorrectedDate	Date	The date when the due date was corrected
hasPrenatalDiagnosticsTests	Boolean	Has taken prenatal diagnostics tests
numberOfFetuses	Int	Number of fetuses
assistedConception	AssistedConception	Assisted conception

AssistedConception attributes

Field	Type	Required	Description
hadAssistedConception	Boolean	x	Had assisted conception
dateAssistedConception	Date		Date of assisted conception

JSON-Example

{
  "metadata": {},
  "dateLastPeriod": "2024-03-02",
  "dueDate": "2024-11-01",
  "dueDateBasedOnUltrasound": "2024-11-04",
  "dueDateCorrectedDate": "2024-05-12",
  "hasPrenatalDiagnosticsTests": false,
  "numberOfFetuses": 2,
  "assistedConception": {
    "hadAssistedConception": true,
    "dateAssistedConception": "2024-02-02"
  }
}

Genetic Disorders

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
noneKnown	Boolean	None known genetic disorders. If false, se note
parentsAreRelatives	Boolean	The unborn child's parents are relatives
hipDysplasia	Boolean	Hip dysplasia
note	Boolean	Note genetic disorders

JSON Example

{
  "metadata": {},
  "noneKnown": false,
  "parentsAreRelatives": false,
  "hipDysplasia": true,
  "note": "my genetic disorders note"
}

Lifestyle Factors

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
stimuli	List StimuliType	List of stimuli
note	String	Note lifestyle factors

StimuliType attributes

Field	Type	Description
stimuliType	CodeAndSystem VOLVEN_8536	Type of stimuli - Type stimuli/rusmiddel (8536)
stimuliFrequencyFirstConsultation	CodeAndSystem VOLVEN_8537	Frequency at first consultation - Hyppighet på inntak av stimuli (8537)
stimuliFrequencyAt36Week	CodeAndSystem VOLVEN_8537	Frequency at 36 weeks of pregnancy - Hyppighet på inntak av stimuli (8537)

JSON Example

{
  "metadata": {},
  "stimuli": [
    {
      "stimuliType": {
        "code": "1",
        "display": "Røyk",
        "codeSystem": "VOLVEN_8536"
      },
      "stimuliFrequencyFirstConsultation": {
        "code": "3",
        "display": "Daglig",
        "codeSystem": "VOLVEN_8537"
      },
      "stimuliFrequencyAt36Week": {
        "code": "2",
        "display": "Av og til",
        "codeSystem": "VOLVEN_8537"
      }
    },
    {
      "stimuliType": {
        "code": "3",
        "display": "Alkohol",
        "codeSystem": "VOLVEN_8536"
      },
      "stimuliFrequencyFirstConsultation": {
        "code": "2",
        "display": "Av og til",
        "codeSystem": "VOLVEN_8537"
      },
      "stimuliFrequencyAt36Week": {
        "code": "4",
        "display": "Sluttet i svangerskapet",
        "codeSystem": "VOLVEN_8537"
      }
    }
  ],
  "note": "my note"
}

Medical conditions

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
nothingParticular	Boolean	Has nothing particular
heartDisease	Boolean	Has heart disease
highBloodPressure	Boolean	Has high blood pressure ( hypertension)
kidneyUrinaryTractDiseases	Boolean	Has diseases of the kidney and/ or urinary tract
diabetes	Boolean	Has diabetes and/ or diabetes gestacional
allergiesAsthma	Boolean	Has allergies and/ or asthma
epilepsy	Boolean	Has epilepsy
thrombosis	Boolean	Has thrombosis and/or treatment for it
autoimmuneDisease	Boolean	Has autoimmune disease
gynecologicalConditions	Boolean	Has gynecolocigal-conditions, -interventions, -surgeries
mentalHealth	Boolean	Has mental health issues
other	Boolean	Has other medical conditions, see note
note	String	Medical conditions note

JSON Example

{
  "metadata": {},
  "nothingParticular": false,
  "heartDisease": false,
  "highBloodPressure": true,
  "kidneyUrinaryTractDiseases": false,
  "diabetes": true,
  "allergiesAsthma": false,
  "epilepsy": false,
  "thrombosis": false,
  "autoimmuneDisease": false,
  "gynecologicalConditions": true,
  "mentalHealth": false,
  "other": false,
  "note": "My medication note"
}

Medication

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
medicationFrequency	Enum: Daily, Occasionally	Medication frequency
drugAllergy	Boolean	Has drug allergy
folate	Folate	Folate (Folic acid)
note	String	Medication note

Folate attribute

Field	Type	Required	Description
takenBefore	Boolean		Folic acid taken before getting pregnant
takenDuring	Boolean		Folic acid taken during pregnancy

JSON Example

{
  "metadata": {},
  "medicationFrequency": "Occasionally",
  "drugAllergy": false,
  "folate": {
    "takenBefore": true,
    "takenDuring": true
  },
  "note": "my note"
}

Mother

Field	Type	Description
name	String	The name of the mother
address	String	The street address where the mother lives
postNumber	String	The post number where the mother lives
postName	String	The post name where the mother lives
employedLast6Months	Boolean	If the mother has been employed the last 6 months
employmentPercentage	Int	The employment percentage (0-100) of the mother
occupationAndIndustry	String	Job/occupation of mother
language	CodeAndSystem, codeSystem="VOLVEN_3303"	The language the mother speaks - Språk (3303)
countryOfBirth	CodeAndSystem, codeSystem="VOLVEN_9043"	The country of birth of the mother - Landkoder (9043)
needsLanguageInterpreter	Boolean	Whether or not the mother needs a language interpreter
cohabitingCoparent	Boolean	Whether or not the mother lives in the same household as the coparent of the child
cohabitingCoparentNote	String	Any extra comments from patient regarding the cohabitation status/field. This field should be filled out if cohabitingCoparent = false

JSON-Example

{
  "metadata": {},
  "name": "Mamma",
  "address": "Gate Gatesen 12",
  "postNumber": "0500",
  "postName": "Oslo",
  "employedLast6Months": true,
  "employmentPercentage": 100,
  "occupationAndIndustry": "Snekker",
  "language": {
    "code": "NOB",
    "display": "Norsk, bokmål",
    "codeSystem": "VOLVEN_3303"
  },
  "countryOfBirth": {
    "code": "NO",
    "display": "Norge",
    "codeSystem": "VOLVEN_9043"
  },
  "needsLanguageInterpreter": false,
  "cohabitingCoparent": false,
  "cohabitingCoparentNote": "Patient cohabits with extended family during pregnancy and maternity leave"
}

Points of contact

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
generalPractitioner	PersonAndOrganization	The GP of the mother / pregnant woman
midwife	PersonAndOrganization	The midwife
birthInstitute	Organization	The birth institute
maternityHealthcareCentre	Organization	The maternity healthcare centre

PersonAndOrganization

Field	Type	Description
name	String	The name of the health care professional
organizationName	String	The name of the health care organization
organizationAddress	String	The address of the health care organization

Organization

Field	Type	Required	Description
organizationName	String		The name of the health care organization
organizationAddress	String		The address of the health care organization

JSON Example

{
  "metadata": {},
  "generalPractitioner": {
    "name": "Lege Legesen",
    "organizationName": "Legekontor",
    "organizationAddress": "Langgata 1a"
  },
  "midwife": {
    "name": "Jordmord Legesen",
    "organizationName": "Legekontor",
    "organizationAddress": "Langgata 1b"
  },
  "birthInstitute": {
    "organizationName": "Oslo Sykehus",
    "organizationAddress": "Sykehusveien 1"
  },
  "maternityHealthcareCentre": {
    "organizationName": "Oslo Helsestasjon",
    "organizationAddress": "Helsestasjonsgata 14"
  }
}

Previous pregnancies

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
numberOfPreviousPregnancies	Int	Number of previous pregnancies
numberOfPreviousLiveBirths	Int	Number of previous live births
spontaneousMiscarriages	Int	Number of spontaneous miscarriages
stillBirths22weeks	Int	Stillbirths at or after 22 weeks of pregnancy / Birth weight equal to or greater than 500 g.
numberOfEctopicPregnancies	Int	Number of ectopic pregnancies
note	String	Note on previous prenancies

JSON Example

{
  "metadata": {},
  "numberOfPreviousPregnancies": 1,
  "numberOfPreviousLiveBirths": 1,
  "spontaneousMiscarriages": 1,
  "stillBirths22weeks": 0,
  "numberOfEctopicPregnancies": 0,
  "note": "my previous pregnancy note"
}

Rhesus D Negative

This resource is only applicable if mother has tested negative for Rhesus D-antigen. If mother has tested positive, there is low risk of rejection of fetus due to the rhesus disease, and thus there is no need to test the fetuses for Rhesus D-antigen.

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
consentFetalRhesusTyping	Boolean	Whether mother has consented for test to determine presence of Rhesus D-antigen
fetusRhDPositiveAtWeek24	Boolean	Test result for the presence of Rhesus D Antigen in at least one of the fetuses. NB! This means that if ONE of the fetuses tested RhD positive, send in true. If ALL of the fetuses tested RhD negative, send in false Accepted values are: true and false.
prophylaxisAtWeek28	Boolean	Whether prophylactic medication has been administered to mother at week 28
dateForResult	String	Date for when result for the test was ready (YYYY-MM-DD)
note	String	Any note regarding Rhesus D-antigen

JSON Example

{
  "metadata": {},
  "consentFetalRhesusTyping": true,
  "fetusRhDPositiveAtWeek24": true,
  "prophylaxisAtWeek28": true,
  "dateForResult": "2024-03-02",
  "note": "Gjelder flerlinger"
}

Symphysis fundal heights

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
pregnancyWeek	Int	Pregancy week (from 24 weeks of pregnancy)
measurement	Int	Measurement in centimeters

JSON Example

{
  "metadata": {},
  "pregnancyWeek": 41,
  "measurement": 37
}

Vital measurements before pregnancy

Field	Type	Description
metadata	Metadata	Metadata for the object, with the version of the registration
height	Float	Height
prePregnancyWeight	Float	Prepregnancy weight
bMI	Float	BMI

JSON Example

{
  "metadata": {},
  "height": 172.5,
  "prePregnancyWeight": 65.0,
  "bMI": 21.84
}