diff --git a/examples/README.md b/examples/README.md index 21e8bc588..8ef3555ad 100644 --- a/examples/README.md +++ b/examples/README.md @@ -27,6 +27,19 @@ To avoid routing issues, we have decided to use `MSH-11` for routing of test mes **Note**: for some sample files, our transformations **will** rewrite the `MSH-5` and/or `MSH-6` HL7 fields normally used for routing, so we can't rely only on those fields to route. This is the case for most of the files in the `examples/CA` folder. If you are sending any files in that folder and you don't want the message to be delivered to our partner, please make sure `MSH-11` is **not** `T` or `P`. Otherwise the message will be delivered to our partner regardless of what is there in `MSH-5` and `MSH-6`. Please see [this ADR](/adr/026-hl7-test-message-routing.md) for more context +## Regeneration of file snapshots + +Files in the `examples/` with the suffix `1_hl7_translation`, `2_fhir_transformation` and `3_hl7_translation_final` are snapshots of its corresponding file ending in `0_initial_message`. They should not be manually updated, only by running them through RS + +In order to keep the snapshots up-to-date, we have a script that automates the regeneration of this files: `update_examples.sh`, found [here](/scripts/hurl/). Running that script should update all the necessary files + +## Notes + +- The `ORM` messages with ids `003`, `004`, `005`, `006`, `007`, `008`, `009`, `010` in the `Test/Orders` folder were modified to comply with current requirements for ReportStream, as it doesn't yet support HL7 `2.3`: + - Added `MSH-9.3` + - Changed `MSH-10` to `2.5.1` +- The `MSH-11` value for all sample files in `examples/` (with the exception of files in `examples/Test/Automated/`) was changed to `D`. This is to comply with our routing filters in RS for test messages + ## Previously renamed files - `fhir/MN NBS FHIR Order Message.json` => `Test/e2e/orders/002_ORM_O01.fhir` @@ -49,10 +62,3 @@ To avoid routing issues, we have decided to use `MSH-11` for routing of test mes - `hl7/OML_021.hl7` => `NewSTEPs/001_NewSTEPs_OML_021.hl7` - `hl7/ORU_R01.hl7` => `NewSTEPs/002_NewSTEPs_ORU_R01.hl7` - `hl7/ADT_A01.txt` => `Other/001_ADT_A01.hl7` - -## Notes - -- The `ORM` messages with ids `003`, `004`, `005`, `006`, `007`, `008`, `009`, `010` in the `Test/Orders` folder were modified to comply with current requirements for ReportStream, as it doesn't yet support HL7 `2.3`: - - Added `MSH-9.3` - - Changed `MSH-10` to `2.5.1` -- The `MSH-11` value for all sample files in `examples/` (with the exception of files in `examples/Test/Automated/`) was changed to `D`. This is to comply with our routing filters in RS for test messages