Versions Compared

Version Old Version 22 New Version 23
Changes made by

Aryn Wiebe

Aryn Wiebe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleSTEP 3: Optionally, add any custom or extension profiles you wish to add on top of the standard specification

If any custom or extension profiles are needed, you can add the FHIR Profile Snapshot <custom_profiles>.json files to the Specifications/Custom folder. If no extensions are needed, the folder should be left empty. Note that if

The custom profile must be:

  1. A Profile Snapshot (the complete definition of the resource profile). The FHIR Profiling Tool uses the snapshot to generate the FHIR resource. A resource cannot be generated from a differential profile.

  2. If the custom profile’s specification exists as a standalone resource, it will need to be nested within a

larger

  1. bundle resource definition.

Let’s walk through this process using an example custom profile - De-Identified UDS Plus Patient.

  1. Start with a bundle resource definition (sample:

    View file
    namebundle.json
    ). Notice that the fullUrl and resource tables are empty.

    Untitled 4.png

  2. Go to your reference and , copy the Canonical url and download the profile snapshot as JSON specification.

    image-20240524-182246.pngImage RemovedImage Added

  3. Update the fullUrl value with the canonical URL and load copy the custom profile into the resource table. Note that you may need to remove an extra set of curly brackets as the resource table’s brackets are equivalent to the ones in the JSON specification from the screenshot in the previous step.

    Untitled.png

  4. Upload the finished JSON (sample:

    View file
    namede-identified_-uds_-plus_-patient.json
    ) into the Specifications/Custom folder.

    image-20240524-182716.png
Expand
titleSTEP 4: Set the component to refresh the database if using a new FHIR version OR custom profiles

This component processes and stores specification data in a SQLite database (Specifications/fhir_profiles.db) for easy access. If you wish to update the FHIR version and/or load any custom profiles into that database, set the custom field Refresh in the component card to “true” before starting the component. This flag tells the component to reference the specified FHIR version and any files in the Specifications/Custom folder and refresh the database on startup.

...