Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Event rewrite #276

Merged
merged 11 commits into from
Sep 10, 2019
Merged

Event rewrite #276

merged 11 commits into from
Sep 10, 2019

Conversation

isaacvetter
Copy link
Collaborator

Fixes #149, #156, #101, #102, #146, #147, #148, #161, #163, #165, #166, #156, #167, #108, #213, #211, #155, #151, #150, #154, #153, #152, #107, #210, #172, #160, #215, #214, #228, #238

  1. Remove switch events, rename events
  2. Move Event Catalog out of base spec
  3. Define process and documentation template to define and mature events
  4. Define computable syntax for (most) events
    n) Various other smaller ballot fixes

1) Remove switch events, rename events
2) Move Event Catalog out of base spec
3) Define process and documentation template to define and mature events
4) Define computable syntax for (most) events
n) Various other smaller ballot fixes
could occur for reasons other than a user intentionally logging out.

Better addresses #163
@isaacvetter isaacvetter added the ballot Offical HL7 ballot comment label Sep 6, 2019
Copy link
Collaborator

@NiklasSvenzen NiklasSvenzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comment:

The following event maturity stages are used:
2 - Tested
2 - Considered

I am guessing one of them is incorrect. 1-Considered and 2-Tested makes more sense I think.

Copy link
Collaborator

@NiklasSvenzen NiklasSvenzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comment:

The following event maturity stages are used:
2 - Tested
2 - Considered

I am guessing one of them is incorrect. 1-Considered and 2-Tested makes more sense I think.

@isaacvetter
Copy link
Collaborator Author

Hey Niklas, Fixed! Good catch. I mostly copied the CDS Hooks maturity model. Our FHIRcast maturity model is defined as part of the core specification, here: https://github.com/HL7/fhircast-docs/blob/f421bcdda27e8221e776bd9c564114998ebfbc6b/docs/specification/STU1.md#event-maturity-model

Isaac

@wmaethner
Copy link
Collaborator

Few things:

  1. The JSON in the event examples isn't formatted (at least when I opened it for viewing) and instead shows up as one big section of text. Can we show it properly formatted to make it easier to read.
  2. The hub topics in the examples still use the url format rather than the GUID format you added in a recent PR.
  3. We call out the syncerror event as being infrastructural and not defined outside the spec like the others, yet it is still in the event catalog like the other events. Is that intended?

@isaacvetter
Copy link
Collaborator Author

isaacvetter commented Sep 10, 2019

Hey @wmaethner!

  1. The JSON in the event examples isn't formatted (at least when I opened it for viewing) and instead shows up as one big section of text. Can we show it properly formatted to make it easier to read.

You mean the examples section on each event page, right? I see it as formatted when running locally, like this:
image

And specifically, it's the ```json: markdown command that does this, for example, here: https://github.com/HL7/fhircast-docs/pull/276/files#diff-5f60a799e354568d9703b19519020082R22

Any idea what might be causing you to see something different?

  1. The hub topics in the examples still use the url format rather than the GUID format you added in a recent PR.

Ah, darn, fixed!

  1. We call out the syncerror event as being infrastructural and not defined outside the spec like the others, yet it is still in the event catalog like the other events. Is that intended?

It was intended. I thought that it was important to document the same information. Do you think we should move it's documentation entirely into the base spec? The base spec does describe how to use it.

@wmaethner
Copy link
Collaborator

  1. It must just be when you look at it in the "Files Changed" section. If that's how it looks when published then we are good.
  2. Cool
  3. Yeah that sounds good, I just wanted to confirm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ballot Offical HL7 ballot comment
Projects
None yet
3 participants