search

HL7 / ehrs-rle-ig

https://jira.hl7.org/browse/PSS-1956
0 stars 1 forks source link

Add CDS Hook examples for Lifecycle Events #4

Open awatson1978 opened 9 months ago

awatson1978 commented 9 months ago

Hi, The SPHR workgroup had a discussion around converting Lifecycle Events into CDS hooks, and believe that this IG ought to include examples of each of the Lifecycle events in CDS hook format.

We have the following issue staged on the SPHR IG repo: https://github.com/HL7/personal-health-record-format-ig/issues/5

New Hook Template https://cds-hooks.org/hooks/template/

CDS Examples https://cds-hooks.org/examples/

Events (25 Total) Going through the PHR-S FM, we extracted the following Record and Evidence of Record items:

Originate/Retain Record
Amend (Update) Record
Transform/Translate Record
Attest Record
Access/View Record
Report (Output) Record
Disclose Record
Transmit Record
Receive/Retain Record
De-Identify (Anononymize) Record
Pseudonymize Record
Re-identify Record
Extract Record
Archive Record
Restore Record
Destroy/Delete Record
Deprecate Record
Re-activate Record
Merge Record
Unmerge Record
Link Record
Unlink Record
Add Legal Hold Record
Remove Legal Hold Record
Manage Record Entries for Legal Hold
Provenance / Evidentiary Events

Evidence of Record Entry Originate/Retain
Evidence of Record Entry Amendment
Evidence of Record Entry Translate
Evidence of Record Entry Attestation
Evidence of Record Entry View/Access
Evidence of Record Entry Output/Report
Evidence of Record Entry Disclosure
Evidence of Record Entry Transmit
Evidence of Record Entry Receive/Retain
Evidence of Record Entry De-Identification
Evidence of Record Entry Pseudomynization
Evidence of Record Entry Re-Identification
Evidence of Record Entry Extraction
Evidence of Record Entry Archive
Evidence of Record Entry Restore
Evidence of Record Entry Destruction
Evidence of Record Entry Deprecation/Retraction
Evidence of Record Entry Merge
Evidence of Record Entry Unmerge
Evidence of Record Entry Link
Evidence of Record Entry Unlink
Evidence of Record Entry Legal Hold
Evidence of Record Entry Legal Hold Removal
Evidence of Record Entry Verification
Evidence of Record Entry Encryption
Evidence of Record Entry Decryption
Evidence of Record Entry Re-Activation
hook-name-expressed-as-noun-verb

These should be converted into CDS hook format, and given explicitly defined names, upon which to standardized. Suggested hook names might include:

record-originate
record-amend
record-translate
record-attest
record-access
record-view
record-report
record-disclose
record-transmit
record-receive
record-anonymize
record-pseudonymize
record-reidentify
record-extract
record-archive
record-restore
record-destroy
record-deprecate
record-reactivate
record-merge
record-unmerge
record-link
record-unlink
record-add-legal-hold
record-remove-legal-hold
record-manage-legal-hold

Once done, we need to create schemas for each of the CDS hooks. We did a rough first-pass of what that might look like, and came up with the following notes:

record-originate
recordId REQUIRED string
userId ??? string

record-amend
recordId REQUIRED string
userId ??? string

record-translate
recordId REQUIRED string

record-attest
recordId REQUIRED string
userId ??? string

record-access
recordId REQUIRED string
userId ??? string

record-view
recordId REQUIRED string

record-report
recordId REQUIRED string

record-disclose
recordId REQUIRED string

record-transmit
recordId REQUIRED string
destinationID MAYBE string

record-receive
recordId REQUIRED string

record-anonymize
recordId REQUIRED string

record-pseudonymize
recordId REQUIRED string

record-reidentify
recordId REQUIRED string

record-extract
recordId REQUIRED string

record-archive
recordId REQUIRED string

record-restore
recordId REQUIRED string

record-destroy
recordId REQUIRED string

record-deprecate
recordId REQUIRED string

record-reactivate
recordId REQUIRED string

record-merge
recordOneId REQUIRED string
recordTwoId REQUIRED string
Notes: [Merge Operation](https://confluence.hl7.org/display/PA/Merge+Operation)

record-unmerge
mergedRecordId REQUIRED string

record-link
recordOneId REQUIRED string
recordTwoId REQUIRED string

record-unlink
linkedRecordId REQUIRED string

record-add-legal-hold
recordId REQUIRED string

record-remove-legal-hold
recordId REQUIRED string

record-manage-legal-hold
recordId REQUIRED string

Once done, these should be included as ~25 profiles or example artifacts in the IG, so that people can load the hooks directly into their systems, as needed.

mvdzel commented 9 months ago

I like this. Will put it on the agenda to discuss in the EHR WG.