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

Initial CP for unique identifier for association instance. #103

Merged
merged 18 commits into from
Sep 3, 2024

Conversation

eldonmetz
Copy link
Collaborator

@eldonmetz eldonmetz commented May 9, 2024

OBR-3 and OBR-29 usage similar to ACM PCD-[04,06 and 07].

Closes #99

📑 Description

After PCIM connectathon testing in 2024, it was noted that it would simplify update logic for consumers if the Device-Patient Association Manager (DPAM) assigned a unique identifier at the start of an association instance and referenced it for updates. This would also be consistent with ACM profile PCD-04, PCD-06 and PCD-07 transactions.

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed
  • I have selected a committee co-chair to review the PR

ℹ Additional Information

OBR-3 and OBR-29 usage similar to ACM PCD-[04,06 and 07].
@eldonmetz eldonmetz requested a review from TomKowal May 9, 2024 18:53

2+|Rationale for Change:

After PCIM connectathon testing in 2024, it was noted that it would simplify update logic for consumers if to the Device-Patient Association Manager (DPAM) assigned a unique identifier at the start of an association instance and referenced it for updates. This would also be consistent with ACM profile PCD-04, PCD-06 and PCD-07 transactions.

Choose a reason for hiding this comment

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

Typo: "...for consumers if to the Device-Patient..." should be "...for consumers if the Device-Patient..."

[underline]#Proposed Text:#

[.text-left]
In the DEV-51 and DEV-52 transactions of the PCIM Profile, this field serves as the unique identifier for the initial association instance and each subsequent update to that association. This value is assigned by the Device-Patient Association Reporter and Device-Patient Association Manager. For the initial association message, OBR-29 Parent is required to be empty. For all subsequent updates to the same association, OBR-3 Filler Order Number identifies the unique update and OBR-29 Parent contains the value from OBR-3 Filler Order Number of the initial association instance. Device-Patient Association Reporters that are sending an update for an association instance they did not create are not required to fill in OBR-29, but Device-Patient Association Managers must always fill in OBR-29 for all updates. This allows the Device-Patient Association Consumer to correlate all subsequent updates with the original association.

Choose a reason for hiding this comment

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

Need to make it clear that OBR-3 from the initial association message goes in OBR-29.2 (Parent.Filler Assigned Identifier), and that the delimiter within OBR-3 changes from '^' to '&' when putting it in OBR-29.2.

Here's text from an ACM CP written 2 years ago (https://docs.google.com/document/d/185t8bjqTm9ZF4sSxp9aGYFFozc6orSLu/edit?pli=1):

"...a transcription of the OBR-3 component values to subcomponents while replacing the component delimiters (^) with subcomponent delimiters (&)"


[.text-left]
This field serves as the unique association instance identifier in DEV-51 and DEV-52 transactions of the PCIM profile. It is assigned by a Device-Patient Association Reporter and Device-Patient Association Manager, and is used by Device-Patient Association Manager and Consumers to associate all updates to a particular association instance throughout the history of the association. The Device-Patient Association Reporter may fill in OBR-29 if it also reported the initial association instance. This is optional, as there may be multiple reporters associating and disassociating devices. The Device-Patient Association Manager shall fill in OBR-29 and the same value will be sent to Device-Patient Association Consumers in all updates to an association instance. See OBR-3 Filler order Number for additional information.

Choose a reason for hiding this comment

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

Same as above, need to be clear that OBR-29.2 is the value of interest.

| 29
| EIP
| C
| Unique instance identifier for the originating association event that all updates apply to. See Appendix B.7 OBR - Observation Request Segment OBR-29 Parent (EIP) 00261for additional details.

Choose a reason for hiding this comment

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

Typo: add space after "00261".

@eldonmetz
Copy link
Collaborator Author

@engelbert65 Changes made based on feedback. HTML output here.

@eldonmetz
Copy link
Collaborator Author

@engelbert65 Additional formatting changes. HTML here.

@eldonmetz
Copy link
Collaborator Author

Changes based on feedback. HTML here.

In the DEV-51 and DEV-52 transactions of the PCIM Profile, this field serves as the unique identifier for the initial association instance and each subsequent update to that association. This value is assigned by the Device-Patient Association Reporter (DEV-51) and Device-Patient Association Manager (DEV-52). For the initial association message, OBR-29 Parent is required to be empty. For all subsequent updates to the same association, OBR-3 Filler Order Number identifies the unique update and OBR-29.2 Parent Filler-Assigned Identifier contains the value from OBR-3 Filler Order Number of the initial association instance. Device-Patient Association Reporters that are sending an update for an association instance they did not create are not required to fill in OBR-29.2, but Device-Patient Association Managers shall fill in OBR-29.2 for updates. This allows the Device-Patient Association Consumer to correlate all subsequent updates with the original association.

[.text-left]
When transcribing the the components of the OBR-3 field value to the OBR-29.2, all subscomponents shall be transcribed and the component delimiters (^) replaced with subcomponent delimiters (&).

Choose a reason for hiding this comment

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

Suggested change
When transcribing the the components of the OBR-3 field value to the OBR-29.2, all subscomponents shall be transcribed and the component delimiters (^) replaced with subcomponent delimiters (&).
When transcribing the the components of the OBR-3 field value to OBR-29.2, all subcomponents shall be transcribed and the component delimiters (^) replaced with subcomponent delimiters (&).

The EI data type value in the OBR-29.2 Parent Filler-Assigned Identifier field serves as the unique association instance identifier in DEV-51 and DEV-52 transactions of the PCIM profile. It is assigned by a Device-Patient Association Reporter (DEV-51) and Device-Patient Association Manager (DEV-52), and is used by Device-Patient Association Manager and Device-Patient Consumer to associate all updates to a particular association instance throughout the history of the association. The Device-Patient Association Reporter shall fill in OBR-29.2 with the originating OBR.3 Filler Order Number for all updates to association instances that it initially originated. The Device-Patient Association Manager shall fill in OBR-29.2 with the originating OBR.3 Filler Order Number in all DEV-52 messages conveying updates to an association instance. See OBR-3 Filler order Number for additional information.

[.text-left]
When transcribing the components of the OBR-3 field value to the OBR-29.2 all subcomponents shall be transcribed and the component delimiters (^) replaced with subcomponent delimiters (&).

Choose a reason for hiding this comment

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

Suggested change
When transcribing the components of the OBR-3 field value to the OBR-29.2 all subcomponents shall be transcribed and the component delimiters (^) replaced with subcomponent delimiters (&).
When transcribing the components of the OBR-3 field value to OBR-29.2, all subcomponents shall be transcribed and the component delimiters (^) replaced with subcomponent delimiters (&).

eldonmetz added 5 commits May 17, 2024 07:49
And update reference in OBR-29 for the last one.

Example one is left as just a single ID, to indicate that is also fine. If we feel they should all be EUI-64, I can update all examples to use that.
[underline]#Proposed Text:#
[.text-left]
....
MSH|^~\&|MonitorGateway||AssocMgr||20160726160000||ORU^R01^ORU_R01|12d1574|P|2.6|||AL|AL|USA||||IHE_DEV_051^IHE PCD\^1.3.6.1.4.1.19376.1.6.1.51.1^ISO

Choose a reason for hiding this comment

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

Remove the backslash after "IHE PCD"

MSH|^~\&|AssocMgr||AssocConsumer||20160726160000||ORU^R01^ORU_R01|12d1599|P|2.6|||AL|AL|USA||||IHE_DEV_052^IHE PCD^1.3.6.1.4.1.19376.1.6.1.52.1^ISO
PID|||AB60001^^^A^PI||McMurphy^R^P^^^^L
PV1||E|3 WEST ICU^3001^1
OBR|||15404697^^|69136^MDC_OBS_ASSOCIATION_PATIENT_DEVICE^MDC|||20160726160000|20160726160000

Choose a reason for hiding this comment

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

The "^^" in OBR-3 are not in the existing text.

Remove accidentally added empty fields in existing example text for OBR.3.
@eldonmetz eldonmetz merged commit 4c0e5ad into master Sep 3, 2024
@eldonmetz eldonmetz deleted the pcim-99-unique-association-identifier branch September 3, 2024 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants