Skip to content

Use Cases and Examples

Intent

Organise narrative use cases alongside validated examples

Implementation Considerations

Placement

  • Describe flows in input/pagecontent/use-cases/*.md
  • Keep Instances in input/examples; name as {Profile}-{Intent}-{Number}.fsh
  • Cross-link example pages to Profiles and vice versa

Validation

  • CI runs SUSHI then validate instances against compiled StructureDefinitions
  • Attach narrative to examples with "* ^text.div" or markdown includes

Benefits

  • Clarity for implementers

Trade-offs

  • Need ongoing curation