Example principles

This page describes principles for AU Core examples.

Examples within the AU Core implementation guide are made available to support implementers by demonstrating how to use the FHIR standard within the context of the guide's scope.

1. Examples SHALL be valid FHIR and conform to the to the implementation guide requirements.
2. Examples SHOULD represent best practices in FHIR implementation.
3. Examples SHOULD be semantically internally consistent as much as is possible.
4. The set of examples SHOULD collectively demonstrate multiple use cases, workflows, and data scenarios anticipated by the implementation guide.
5. Implementation guide SHOULD maintain a minimal set of examples, collectively illustrating key concepts and practices without redundancy.
6. The set of examples for a profile SHALL demonstrate the use of Must Support elements as defined within the implementation guide.
7. Examples SHOULD demonstrate how to handle various data conditions such as optional elements, missing data, and masked data.
8. Examples SHOULD demonstrate a wide range of data elements, highlighting variations in types, cardinalities, and terminology bindings.
9. Examples SHOULD demonstrate a range of supplied data, e.g. detailed structure, minimal structure, coded vs text elements etc.
10. Examples SHOULD include the documentation when , explaining the context, the specific aspects of FHIR being demonstrated, and any assumptions or considerations relevant to the example's scenario.
11. Examples SHOULD include relevant documentation (e.g. context, assumptions, considerations etc relevant to the example’s scenario).