location of 'must support' pointer

IHE / ITI.PDQm

The Patient Demographics Query for Mobile (PDQm) Profile defines a lightweight RESTful interface to a patient demographics supplier leveraging technologies readily available to mobile applications and lightweight browser based applications.

https://profiles.ihe.net/ITI/PDQm/index.html

Creative Commons Attribution 4.0 International

4 stars 1 forks source link

location of 'must support' pointer #28

Closed lynnfel closed 2 years ago

lynnfel commented 3 years ago

Section Number https://profiles.ihe.net/ITI/PDQm/index.html

Issue pointer to definition of 'Must Support on index page

Proposed Change PDQm home page contains this:

Must Support` PDQm uses Must Support in StructureDefinitions with the definition found in Appendix Z. This is equivalent to IHE use of R2.

Perhaps that should be moved to where the StructureDefinitions reside: https://profiles.ihe.net/ITI/PIXm/artifacts.html#structures-resource-profiles

Note, I have submitted the same issue for PIXm (https://github.com/IHE/ITI.PIXm/issues/84) and PDQm. The resolution should be the same.

Priority:

Low: Typo or other minor classification that an editor can manage. Requires no group discussion.

JohnMoehrke commented 3 years ago

we do not have any control over the artifacts page.

JohnMoehrke commented 2 years ago

I asked around, there does not seem to be a precedent for where to publish your Must Support requirements. There is one proposal that has a section "Conformance Expectations" that brings in the definitions of SHALL/SHOULD/MAY, defines Must-Support, and possibly other things that we might see as similar. Others are putting this on a similar level as security considerations. see us-core - https://build.fhir.org/ig/HL7/US-Core/conformance-expectations.html

JohnMoehrke commented 2 years ago

I like it where we have it, on the front page. I could see it as being more visible. It could be more inclusive of other things mentioned in Appendix Z. It could define SHALL/SHOULD/MAY and point at our General Intro Appendix E - https://profiles.ihe.net/GeneralIntro/ch-E.html

JohnMoehrke commented 2 years ago

decided today

Change to "Conformance Expectations"
add sentence about shall/should/may and appendix E link
increase the header level for this (and download)

lynnfel commented 2 years ago

Sounds good to me

JohnMoehrke commented 2 years ago

note, some discussion on zulip that a Conformance Expectations could be a standalone html. We will watch this ongoing discussion and may change to that.