Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patient Capability Statement changes to use defaults #172

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

mjosborne1
Copy link
Collaborator

@mjosborne1 mjosborne1 commented Mar 24, 2025

Changes for JIRA-47146:

  • Updated documentation to match standard conformance rules
  • Added default searches
  • Added _include to PractitionerRole

@mjosborne1 mjosborne1 marked this pull request as ready for review March 24, 2025 01:43
@mjosborne1 mjosborne1 changed the title recommit single file changes Patient Capability Statement changes to use defaults Mar 24, 2025
@@ -58,12 +58,18 @@
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<documentation value="Patients **SHALL** support the ServiceRequest resource, at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource.&#xa;&#xa;The Patient **SHOULD** support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester` and `ServiceRequest:encounter`."/>
<documentation value="AU eRequesting Patient actor **SHALL** support the ServiceRequest resource, at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource.&#xa;&#xa;Patient actor **SHOULD** support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester` and `ServiceRequest:encounter`."/>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missed occurrence of Patient actor rather than AU eRequesting Patient actor

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@@ -315,7 +489,7 @@
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation value="If Patient supports the Observation resource, the Observation Pregnancy - Status (IPS), the Observation Pregnancy - Expected Delivery Date (IPS) profiles and the conformance expectations for the Observation resource **SHALL** be supported."/>
<documentation value="If Patient actor supports the Observation resource, the Observation Pregnancy - Status (IPS), the Observation Pregnancy - Expected Delivery Date (IPS) profiles and the conformance expectations for the Observation resource **SHALL** be supported."/>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missed occurrence of Patient actor rather than AU eRequesting Patient actor

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@@ -234,7 +328,27 @@
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation value="Patient clients **SHOULD** support the PractitionerRole resource, the AU Core profile, and the conformance expectations for the PractitionerRole resource."/>
<documentation value="If the AU eRequesting Patient actor supports the PractitionerRole resource, AU eRequesting Patient actor **SHALL** support the AU Core PractitionerRole profile, and the conformance expectations for the PractitionerRole resource.&#xa;&#xa;Patient actor **MAY** support the `_include` parameter for `PractitionerRole:practitioner` and `PractitionerRole:organization`"/>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missed occurrence of Patient actor rather than AU eRequesting Patient actor

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Copy link
Collaborator

@JayMurdoch JayMurdoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments.

@@ -58,28 +58,34 @@
<valueCode value="SHOULD"/>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commenting here for inline. Change resource conformance to SHOULD, and supported profiles to SHALL.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

? if ServiceRequest is different because Resource/Profile conformance rules are must support one of the 2 profiles.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michael-wilson-au could you please advise on the approach here? Current documentation states: "The AU eRequesting Patient actor SHALL support the ServiceRequest resource, at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource."

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is special given the existing narrative. I suggest we keep this one as is and add it to the TDG discussion on variances from default obligations.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Restored Resource, Profile support to SHALL, SHOULD/SHOULD

@@ -58,28 +58,34 @@
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<documentation value="Patients **SHALL** support the ServiceRequest resource, at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource.&#xa;&#xa;The Patient **SHOULD** support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester` and `ServiceRequest:encounter`."/>
<documentation value="The AU eRequesting Patient actor **SHALL** support the ServiceRequest resource, at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource.&#xa;&#xa;AU eRequesting Patient actor **SHOULD** support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester` and `ServiceRequest:encounter`."/>
Copy link
Collaborator

@JayMurdoch JayMurdoch Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update to reflect change to conformance, and change the conformance for _include parameters from SHOULD to MAY.
Eg "If the AU eRequesting Patient actor supports the ServiceRequest resource, the AU eRequesting Patient actor SHALL support at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource. AU eRequesting Patient actor MAY support the _include parameter for ServiceRequest:patient, ServiceRequest:requester and ServiceRequest:encounter."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to MAY in doc line

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ServiceRequest has specific conformance on search: See https://jira.hl7.org/browse/FHIR-46942

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per @michael-wilson-au please retain original agreed conformance and note for TDG review.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed conformance for _include patient, requester and encounter search per JIRA-46492 has been applied.

<td><b>-</b></td>
<td><b>MAY</b></td>
<td><b>MAY</b></td>
<td><b>MAY</b></td>
Copy link
Collaborator

@JayMurdoch JayMurdoch Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commenting here for inline - the _include parameters have agreed default of MAY for placer, filler, patient, please amend.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ServiceRequest has specific conformance on search: https://jira.hl7.org/browse/FHIR-46942

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per @michael-wilson-au please retain original, agreed conformance and document difference for TDG review.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed conformance for _include patient, requester and encounter search per JIRA-46492 has been applied to the parameters table.

@mjosborne1 mjosborne1 requested a review from JayMurdoch April 2, 2025 02:33
Copy link
Collaborator

@JayMurdoch JayMurdoch Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per @michael-wilson-au, please revert resources that were originally MAY (those that are referenced by SHOULD profiles): Condition, DocRef, Location, Procedure, RelPerson.
Defaults not to be applied to these.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted resource conformance on Condition, DocRef, Location, Procedure, RelPerson to MAY.

@mjosborne1 mjosborne1 requested a review from JayMurdoch April 2, 2025 05:11
<td><b>-</b></td>
<td><b>MAY</b></td>
<td><b>MAY</b></td>
<td><b>MAY</b></td>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to FHIR-48915, the conformance level for all search parameters, including the modifier _include, for the Placer, Filler, and Patient actors is SHOULD.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants