search

smart-on-fhir / health-cards

Health Cards Framework: implementation guide and supporting material
Other
261 stars 84 forks source link

Create a table presentation for operation #87

Open yunwwang opened 3 years ago

yunwwang commented 3 years ago

I would like to recommend a table format for operation's parameters, like http://build.fhir.org/resource-operation-validate.html. Another option would be create a separate operation page and reference it from main index page.

Benefit: It is easier to quickly identify operation's parameters' name, type, and cardinality.

The longer descriptions and examples would be after the table.

yunwwang commented 3 years ago

Actually, I think this operation should be defined in https://github.com/dvci/vaccine-credential-ig. If we have operation definition page in the VCI ig, then we may not need such table structure in HealthCard

jmandel commented 3 years ago

The current expectation is that https://github.com/dvci/vaccine-credential-ig defines data profiles for COVID-19 immunization (and lab) results, while https://smarthealth.cards/ describes the general protocol for creating/issuing Health Cards. This FHIR operation (for VC issuance) is part of the basic interop pattern, rather than a data profile for the contents of a health card.

radamson commented 3 years ago

Agree with Josh that this operation belongs in https://smarthealth.cards/ and not the https://github.com/dvci/vaccine-credential-ig.

Since right now this is the only real FHIR conformance artifact in https://smarthealth.cards/ I think we can get away with just manually adding a table for it.