Application logic ¶

This page describes how DDRC defines user flows through the following high-level phases:

Identity proofing
Eligibility verification
Vital records request

flowchart LR
    start((Start))
    identity[Identity proofing]
    eligibility[Eligibility verification]
    enrollment[Vital records request]
    complete((End))
    style complete stroke-width:2px

    start --> identity
    identity --> eligibility
    eligibility --> enrollment
    enrollment --> complete

The structure of the source code in cdt-ods-disaster-recovery/ generally follows from these phases:

web/core/ implements shared logic, models, and hooks for django-cdt-identity/
web/vital_records/ implements a request for vital records
web/vital_records/tasks/ implements async tasks run by a task queue

core and vital_records are standalone Django apps registered in Django’s settings.

Furthermore, the source code in django-cdt-identity/ implements identity proofing in:

cdt_identity/ implements identity proofing and claims verification with the California Department of Technology’s Identity Gateway

Django request pipeline ¶

Each request to the DDRC app is ultimately a Django request and goes through the Django HTTP request pipeline.

DDRC uses middleware to pre- and post-process requests for (view) access control, and session configuration.

Key supporting files

[web/core/middleware.py][core-middleware]

In general, the flow of a Django request looks like:

flowchart LR
    user((User))
    style user stroke-width:2px

    pre_middleware[Request middleware]
    view_middleware[View-specific middleware]
    context[Context processors]
    view[View function]
    post_middleware[Response middleware]

    user -- Request --> pre_middleware
    pre_middleware -- Request --> view_middleware
    view_middleware -- Request --> context
    context -- Request --> view
    view -- Response --> post_middleware
    post_middleware -- Response --> user

Identity proofing ¶

In this phase, DDRC takes the user through an OpenID Connect (OIDC) flow as a Client (the Relying Party or RP) of the CDT Identity Gateway (the Identity Provider or IDP), via Login.gov.

The CDT Identity Gateway transforms PII from Login.gov into anonymized boolean claims that are later used in eligibility verification.

Entrypoint

[cdt-ods-disaster-recovery/web/vital_records/views/common.py][oauth-eligibility-views]

Key supporting files

[django-cdt-identity/cdt_identity/client.py][oauth-client]

[django-cdt-identity/cdt_identity/hooks.py][oauth-hooks]

flowchart LR
    session[(session)]

    start((Start))

    ddrc[DDRC app]
    idg[["`CDT
    Identity Gateway`"]]
    logingov[[Login.gov]]
    claims((Claims received))

    next>"`_Eligibility
    verification_`"]
    style next stroke-width:2px

    start -- "1: Clicks login button" --> ddrc
    %% invisible links help with diagram layout
    start ~~~ session

    ddrc -- "2: OIDC authorize_redirect" --> idg

    idg <-. "3: PII exchange" .-> logingov
    idg -- "4: OIDC token authorization" --> claims

    claims -- "5: continue" --> next
    claims -. update .-o session

Eligibility verification ¶

In this phase, DDRC verifies the user’s claims by using claims previously stored in the user’s session during Identity proofing

Entrypoint

[cdt-ods-disaster-recovery/web/vital_records/views/common.py][oauth-eligibility-views]

Key supporting files

[django-cdt-identity/cdt_identity/views.py][eligibility-verify]

flowchart LR
    session[(session)]

    start(("`Previous
    phase`"))
    style start stroke-dasharray: 5 5

    claims[Session claims check]
    eligible{Eligible?}

    next>"`_Vital records request_`"]
    style next stroke-width:2px

    stop{{Stop}}

    start -- Claims validation --> claims
    session -.-o claims
    claims --> eligible

    eligible -- Yes --> next
    eligible -- No --> stop
    eligible -. update .-o session

Vital records request ¶

In this final phase, the user fills out a series of forms to submit an order for a vital records request and the DDRC application generates a PDF of the vital records request and emails it to the California Department of Public Health (CDPH).

Order records ¶

Birth ¶

The user fills out the following forms:

Name on birth certificate
County of birth
Date of birth
Name of parents
Order information

Entrypoint

[cdt-ods-disaster-recovery/web/vital_records/views/common.py][order-record-views]

Supporting views

cdt-ods-disaster-recovery/web/vital_records/views/birth.py

Marriage ¶

The user fills out the following forms:

Name of persons on marriage record
County of marriage
Date of marriage
Order information

Entrypoint

[cdt-ods-disaster-recovery/web/vital_records/views/common.py][order-record-views]

Supporting views

cdt-ods-disaster-recovery/web/vital_records/views/marriage.py

Submit records ¶

The DDRC application generates a PDF of the vital records request and emails it to CDPH.

Async tasks

cdt-ods-disaster-recovery/web/vital_records/tasks/package.py cdt-ods-disaster-recovery/web/vital_records/tasks/email.py

sequenceDiagram
autonumber

    actor user as User
    participant ddrc as DDRC app
    participant package as package task
    participant email as email task
    participant cdph as CDPH

user->>ddrc: submit order for vital records request
    activate user
ddrc-->>user: confirmation of order submission
    deactivate user
ddrc->>package: mark request as ready for processing
    activate ddrc
package->>email: create vital records request PDF application
    activate package
    deactivate ddrc
email->>cdph: email vital records request PDF application
    deactivate package
    activate email
email->>user: email confirmation of vital records request PDF application submittal
    deactivate email

[core-middleware]: https://github.com/Office-of-Digital-Services/cdt-ods-disaster-recovery/blob/main/web/core/middleware.py [eligibility-verify]: https://github.com/Office-of-Digital-Services/django-cdt-identity/blob/main/cdt_identity/views.py [order-record-views]: https://github.com/Office-of-Digital-Services/cdt-ods-disaster-recovery/blob/main/web/vital_records/views/common.py [oauth-client]: https://github.com/Office-of-Digital-Services/django-cdt-identity/blob/main/cdt_identity/client.py [oauth-hooks]: https://github.com/Office-of-Digital-Services/django-cdt-identity/blob/main/cdt_identity/hooks.py [oauth-eligibility-views]: https://github.com/Office-of-Digital-Services/cdt-ods-disaster-recovery/blob/main/web/vital_records/views/common.py