Status på en fødselsmelding
Når en fødsel er registrert, videresender systemet meldingen asynkront til Folkeregisteret (Skatteetaten). Status på meldingen kan hentes fra to endepunkter:
GET /v1/birth/{messageId}– status på én melding ved meldings-IDPOST /v1/birth/get-by-hospital-child-identification-number– status på alle meldinger med et gitt sykehusidentifikasjonsnummer
Begge endepunktene krever lesetilgang: scope nhn:birthsystem/read (se Autentisering).
Livssyklus
stateDiagram-v2
[*] --> Mottatt: fødsel registrert
Mottatt --> SendtTilSkatteetaten: melding sendt til Folkeregisteret
SendtTilSkatteetaten --> Godkjent: godkjent av Folkeregisteret
SendtTilSkatteetaten --> Avslått: avslått av Folkeregisteret
SendtTilSkatteetaten --> Avvist: avvist av Folkeregisteret
SendtTilSkatteetaten --> Avbrutt: avbrutt av Folkeregisteret
SendtTilSkatteetaten --> ManuellBehandling: sendt til manuell behandling
Statusverdier
| Status (JSON-verdi) | Betydning |
|---|---|
Received |
Meldingen er mottatt og lagret, men ikke sendt til Folkeregisteret ennå. |
SentToTaxOffice |
Meldingen er sendt til Folkeregisteret og venter på svar. |
Approved |
Folkeregisteret har godkjent meldingen. Barnets fødselsnummer er tilgjengelig i childNin. |
Denied |
Folkeregisteret har avslått meldingen. |
Rejected |
Folkeregisteret har avvist meldingen. |
Cancelled |
Saken er avbrutt hos Folkeregisteret. |
ManualReview |
Saken er sendt til manuell behandling hos Folkeregisteret. En beslutning kan komme senere. |
Note
Barnets fødselsnummer (childNin) settes når Folkeregisteret har godkjent meldingen og registrert personen. For alle andre statusverdier er childNin null.
Hente status ved meldings-ID
GET /v1/birth/{messageId}
GET /v1/birth/6d0a3f2e-1b4c-4d5e-8f90-a1b2c3d4e5f6
Authorization: DPoP <access_token>
DPoP: <dpop_proof>
200 OK
| Felt | Type | Beskrivelse |
|---|---|---|
messageId |
GUID | ID på meldingen. |
hospitalChildIdentificationNumber |
streng | Sykehusets identifikator for barnet. |
messageStatus |
streng | Gjeldende status. Se Statusverdier. |
childNin |
streng/null | Barnets fødselsnummer, tilgjengelig når statusen er Approved. |
{
"messageId": "6d0a3f2e-1b4c-4d5e-8f90-a1b2c3d4e5f6",
"hospitalChildIdentificationNumber": "12345678910",
"messageStatus": "Approved",
"childNin": "15102623220"
}
404 Not Found
Ingen fødselsmelding finnes med oppgitt meldings-ID.
Hente status ved sykehusets identifikasjonsnummer
POST /v1/birth/get-by-hospital-child-identification-number
Forespørsel:
{
"hospitalChildIdentificationNumber": "12345678910"
}
200 OK
En liste med meldingene som matcher (listen kan være tom). Hvert element har samme struktur som svaret ved meldings-ID:
[
{
"messageId": "6d0a3f2e-1b4c-4d5e-8f90-a1b2c3d4e5f6",
"hospitalChildIdentificationNumber": "12345678910",
"messageStatus": "Approved",
"childNin": "15102623220"
}
]
Note
En korrigering er en ny melding med egen messageId (se Registrere en fødsel). Hvis du bruker samme hospitalChildIdentificationNumber som i den opprinnelige meldingen, vil dette endepunktet returnere både den opprinnelige meldingen og korrigeringen.
Anbefalt måte å få barnets fødselsnummer på
Under utarbeidelse.
Videresending til og behandling i Folkeregisteret er asynkron, så det kan ta tid før meldingen får en endelig status (Approved, Denied, Rejected eller Cancelled). Statusen ManualReview betyr at saken behandles manuelt hos Folkeregisteret og kan endre seg.