Instance Example Design

Examples help clarify the complexities of FHIR for the reader. For this reason, there SHALL be an example for every Profile. Each Extension MAY have an example.

Constraints and Configuration

Instance examples in Simplifier need to be correctly named and constructed to avoid duplicates being generated or other conflicts occurring. This guidance overrides the default Simplifier behaviour and has been developed following consultation with the Simplifier development team.

When creating examples the filename SHALL adhere to the following convention:

  • ProfileExampleName - England-[ProfileName]-[FurtherDescription]-Example

The value of [FurtherDescription] SHALL be enough information for a user to understand what the example is representing. This description SHALL also be sufficient to make the example unique in the NHS England IG.

Construction of Examples

Each example SHOULD have the minimum amount of information necessary to convey the intended message whilst ensuring it is still a valid resource or extension. If there any agreed Clinical scenario(s), then these SHALL be represented in examples.

Meta Element

The Resource.meta element SHALL NOT be used for Examples.

Configuration of Simplifier

Simplifier creates metadata around an instance when imported from GitHub. This metadata needs a custom configuration to allow the examples to be correctly imported. The url for updating the metadata expressions is accessible via:

https://simplifier.net/nhs-england-implementation-guide/editmetadataexpressions
which requires Admin access to update or configure.

For each Profile the metadata expression SHALL follow the following convention:

[FHIRAssetName].Title: ('[FHIRAssetName] example: ' + id)
[FHIRAssetName].Description: ('[FHIRAssetName] example: ' + id)
[FHIRAssetName].UrlKey: id

Important Note: the following properties of examples are automatically generated by Simplifier and SHALL NOT be manually changed or updated

  • Title
  • Description
  • Url Key
  • Filename