Status
The status endpoint returns metadata about a patient, whether they have given their consent to have a maternity record, and metadata about their maternity record if one exists.
For a patient to have an active maternity record, it's also required that they have given consent, is not deceased and that they do not have a confidential address
Consent
The pregnant woman must give her consent to participate in the trial to share maternity record information. This is a legal requirement. This consent must be given before we are allowed to store information about her in the digital maternity health record (DHG). Consent is given digitally by the pregnant woman through Helsenorge.no and lasts for the entire duration of the trial (the entire pregnancy). However, the pregnant woman can withdraw her consent to participate in the trial at any time. Withdrawal of consent is also done digitally by the woman. When consent is withdrawn, the information stored about the woman in the digital maternity health record must be deleted, and as a result, she will no longer be part of the trial.
Authorization
The endpoint requires either a machin-to-machine token or a HelseID user token for authentication. The EPJ can use a machine-to-machine token to check if the patient has a maternity record and if there has been updates without requiring the user to log in with HelseID.
Note that when a machine-to-machine token is used there are fewer required headers than with a user token.
When a user token is used all the required headers must be set as usual. The "hit-access-basis" header can in this case always be set to UNNTAK. Note that we do not do any audit logging for requests to the /status endpoint.
Curl example: Request status for patient
curl --location --request GET 'https://test.maternity-record.hit.nhn.no/api/maternity-record/v1/status' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiI......<HelseId machine token>' \
--header 'nhn-source-system: My EPJ system name' \
--header 'nhn-patient-nin: 10086055555' \
Response
| Field | Type | Required | Description |
|---|---|---|---|
| hasGivenConsent | Boolean | x | The patient has given her consent to participate in the trial to share maternity record information |
| hasActiveMaternityRecord | Boolean | x | The patient has a registered maternity record with status active |
| lastChangedDateTime | Timestamp | Timestamp in UTC when the maternity record information was last changed for this patient (if one exists) | |
| latestRecordId | String | UUID in String format which is the ID of the latest maternity record belonging to the patient (if one exists) | |
| deceased | Boolean | x | Whether the patient is deceased or not |
| hasConfidentialAddress | Boolean | x | Whether the patient has a confidential address or not |