Skip to end of metadata
Go to start of metadata

This page supplements the Specification Feedback page with information that is unique to the FHIR Specification Feedback Jira project.  Be sure to read the base page first.

Location Elements

There are four fields that can be used to help identify the location(s) relevant to a feedback issue.  At least one of Related Artifact(s) and Related Page(s) must be specified.  The other two are optional, though Related URL is strongly encouraged.

Related URL

This is a hyperlink to the location within the FHIR specification the issue relates to.  It might be the link from the top of the page, but ideally it will be a section-specific link.  To get the link of a particular section in a FHIR specification, hover over the section heading until a small [image] link icon appears on the right-hand side.  Right-click on the image and select “copy link”.  Then paste the link into this field.

This field can only contain a single hyperlink.  If multiple locations are relevant, put the link to the most important one here and include any other relevant links in the Description field.

Related Artifact(s)

The set of artifacts available for this multi-select field is governed by the selected Specification.  The artifacts might be resources, profiles, value sets or other FHIR artifacts.  The level of granularity of artifacts depends on the specification.  Because the FHIR core specification has so many artifacts (thousands of value sets), only resource artifacts are listed.  Value sets, operations and other artifacts are treated as linked to either their primary resource or to one of the Related Page(s) (e.g. “terminology”).

You can start typing to produce a filtered list of candidate artifacts.  Please identify all artifacts that are relevant to the issue, as this will make it easier to find when searching in the future.

Related Page(s)

This field allows identification of a page or group of pages that provide descriptive guidance for the specification but do not represent one of the resources in the preceding list.

Again, the element supports type-ahead and allows for the selection of multiple relevant pages.

This element also allows the selection of “(N/A)” for use when the feedback isn’t relevant to any page currently in the specification (e.g. a request to define a new resource) and “(many)” for use when the comment reflects an issue that is tied to many locations, for example a formatting issue affecting the display of resources.

Related Section(s)

This allows the listing of the section number or section numbers associated with an issue.  This is a less-preferred way of identifying an issue, particularly if submitting a comment against the continuous integration build as section numbers can change.  However, if reporting against content where a detailed hyperlink is not possible, section numbers can provide more precise detail than merely identifying a page or artifact.

Multiple sections can be listed, separated by spaces or commas

  • No labels