Versions Compared

Key

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

...

{ "entry": [ { "fullUrl": "http://hl7.org/fhir/StructureDefinition/Patient", "resource": { "resourceType": "StructureDefinition", "id": "custom-patient-profile", .... } } ], "id": "resources", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "resourceType": "Bundle", "type": "collection" }

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

  1. Start with a bundle resource definition (sample:

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

If any custom or extension profiles are needed, you can add the <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’s specification exists as a standalone resource, it will need to be nested within a larger bundle resource definition. For example, this custom patient profile’s specification would go under the resource table:

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

Untitled 4.pngImage Added
  • Go to your reference and copy the Canonical url and JSON specification

    image-20240524-182246.pngImage Added

  • Update the fullUrl value and load 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.pngImage Added
  • Upload the finished JSON (sample:

    View file
    namede-identified_uds_plus_patient.json
    ) into the Specifications/Custom folder

    image-20240524-182716.pngImage Added
  • Expand
    titleSTEP 4: Set the component to refresh the database if using a new FHIR version or 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.

    ...

    Expand
    titleSTEP 7: Click on the provided URL to use the tool

    Clicking on the provided URL will take you to the FHIR Profiling Tool’s menu which contains a list of all the FHIR resources and types available in the SQLite database.

    image-20240523-200128.png

    Clicking on any of the links will trigger the tool to generate a template JSON for the specified FHIR resource or type:

    image-20240523-200322.png

    You can now copy the template JSON and bring it over to your FHIR component to use in your interface. See <link confluence page on creating FHIR resources> https://interfaceware.atlassian.net/wiki/pages/resumedraft.action?draftId=2925199362&draftShareId=96772d5d-853a-4a68-a1d0-06a21ed81114 for an example of how to use a FHIR JSON template to generate and map FHIR resources.