HL7 / fhir-ig-publisher

Source code for the IG publisher
Apache License 2.0
67 stars 55 forks source link

CapabilityStatement's interation level documentation #908

Open udaychandrupatla opened 3 months ago

udaychandrupatla commented 3 months ago

The rendering of interaction level documentation at /CapabilityStatement/rest/resource/interaction/documentation has been rendering however we found some other rendering issues for your perusal -

The interaction-level narrative is squashed into a narrower column on the RHS for our resources that have multiple supported profiles (e.g. HealthcareService, Contract (pca-publisher-agent.xml) attached). This seems to be happening because if we have a resource that supports more than one profile, the IG publisher replaces the 'Base System Profile' and 'Profile Conformance' sections with a single 'Core FHIR Resource' section. In my opinion, the 'Base System Profile' section should still be shown, and it should list all supported profiles.

Another thing that could be improved: currently it outputs the resource-level documentation (i.e. documentation that applies to the resource, independent of the interactions) BELOW the resource interaction-level documentation. I think it should be displayed above any interaction-level documentation.

In the 'Summary' table section: it doesn't show the supported profiles in the table when the resource supports more than one profile

Zulip thread for the issue - https://chat.fhir.org/#narrow/stream/179252-IG-creation/topic/CapabilityStatement's.20interation.20level.20documentation

I have attached the CapabilityStatement XML instance and output from 1.6.11 snapshot IG Publisher here for your consideration

pca-publisher-agent.xml CapabilityStatement-pca-publisher-agent.html

vassilpeytchev commented 2 weeks ago

@lmckenzi You can assign this to me