Stream: IG creation
Topic: Operation Examples
Paul Denning (Aug 31 2021 at 15:15):
Is there a convention for providing examples of operations (specified by an OperationDefinition) in an IG?
David Pyke (Aug 31 2021 at 15:17):
The payloads would be set up as examples, you can describe the operation flow in prose.
Lloyd McKenzie (Aug 31 2021 at 15:22):
The outs would either be a Parameters instance or a Resource, so those would just be regular examples. There's no specific way to tie them to the OperationDefinition other than naming convention though. The input would be a Resource, Parameters instance or a URL string. The first two would be regular examples. The URL string would just have to be in-line documentation with markdown or XHTML.
Eric Haas (Aug 31 2021 at 16:33):
Using the IG publication templates you can provide custom markdown introductions and notes for every FHIR artifact. You can use that to provide a static example transaction on the artifacts page.
Jens Villadsen (Dec 07 2021 at 07:48):
But hey - aint it Christmas soon? I could really use that 'example'-tab on operations in general when authoring operations on my IG's
Jose Costa Teixeira (Dec 07 2021 at 17:44):
why not use an examplescenario here?
Eric Haas (Dec 07 2021 at 21:48):
I just render as inline markdown transactions. I wish Postman would let you download documentation output as markdown and then could construct the interaction there and copy paste to a page here. That would be swell!
Jens Villadsen (Dec 08 2021 at 08:16):
@Jose Costa Teixeira what is that? @Eric Haas I do as well but I don't find it an optimal solution. You're saying something in regards to postman. It should certainly be possible to provide POSTman files to be directly usable
Jose Costa Teixeira (Dec 08 2021 at 08:54):
@Jens Villadsen Here's an ExampleScenario - it's a resource that shows an example interaction with requests and responses
Jose Costa Teixeira (Dec 08 2021 at 08:54):
https://build.fhir.org/ig/hl7-be/riziv-inami/ExampleScenario-scenario-allergy.html
Last updated: Apr 12 2022 at 19:14 UTC
