18.1.2.1.1.3. Patient Record¶
18.1.2.1.1.3.1. Trigger Events¶
This message is emitted by the archive on : - receive of HL7 messages :
Order messages : ORM^O01, OMI^O23 and OMG^O19
ORU^R01
SIU Appointment Notification messages : SIU^S12, SIU^S13 and SIU^S15
Forwarding of all of the above messages to external HL7 receivers
Invocation of ADT Patient Management changes in external archive.
Notification to HL7 receivers on ADT Patient Management changes in own archive.
18.1.2.1.1.3.2. Message Structure¶
Field Name |
Opt |
Description |
|---|---|---|
EventID |
M |
EV (110110, DCM, ‘Patient Record’)
|
EventActionCode |
M |
Create : ‘C’
Update : ‘U’
Delete : ‘D’
|
EventDateTime |
M |
The time at which the event occurred
|
EventOutcomeIndicator |
M |
Success : ‘0’
Minor failure : ‘4’
|
EventOutcomeDescription |
M |
Error/Exception message when EventOutcomeIndicator : ‘4’
|
Field Name |
Opt |
Description |
|---|---|---|
UserID |
M |
HL7 messages : ‘Sending Application and Facility’
Triggered from UI : ‘Remote IP address’ or ‘User name of logged in user’
Triggered by object storage : ‘Calling AE title in association’
|
UserIDTypeCode |
U |
HL7 messages : EV (HL7APP, 99DCM4CHEE, ‘Application and Facility’)
Triggered from UI (secured archive) : EV (113871, DCM, ‘Person ID’)
Triggered from UI (unsecured archive) : EV (110182, DCM, ‘Node ID’)
Triggered by object storage : EV (110119, DCM, ‘Station AE Title’)
|
UserTypeCode |
U |
Triggered from UI : Person : ‘1’
All other cases : Application : ‘2’
|
UserIsRequestor |
M |
true
|
RoleIDCode |
M |
EV (110153, DCM, ‘Source’)
|
NetworkAccessPointID |
U |
Hostname/IP Address of calling host
|
NetworkAccessPointTypeCode |
U |
NetworkAccessPointID is host name : ‘1’
NetworkAccessPointID is an IP address : ‘2’
|
Field Name |
Opt |
Description |
|---|---|---|
UserID |
M |
HL7 messages : ‘Receiving Application and Facility’
Triggered from UI : ‘Request URI’
Triggered by object storage : ‘Called AE title in association’
Triggered by scheduler : ‘Archive device name’
|
UserIDTypeCode |
U |
HL7 messages : EV (HL7APP, 99DCM4CHEE, ‘Application and Facility’)
Triggered from UI : EV (12, RFC-3881, ‘URI’)
Triggered by object storage : EV (110119, DCM, ‘Station AE Title’)
Triggered by scheduler : EV (113877, DCM, ‘Device Name’)
|
UserTypeCode |
U |
Application : ‘2’
|
AlternativeUserID |
MC |
Process ID of Audit logger
|
UserIsRequestor |
M |
Patient deletion triggered by scheduler : ‘true’
All other cases : ‘false’
|
RoleIDCode |
M |
EV (110152, DCM, ‘Destination’)
|
NetworkAccessPointID |
U |
Hostname/IP Address of the connection referenced by Audit logger
|
NetworkAccessPointTypeCode |
U |
NetworkAccessPointID is host name : ‘1’
NetworkAccessPointID is an IP address : ‘2’
|
Field Name |
Opt |
Description |
Note |
|---|---|---|---|
ParticipantObjectID |
M |
Patient ID or <none> if unknown |
|
ParticipantObjectTypeCode |
M |
Person : ‘1’ |
|
ParticipantObjectTypeCodeRole |
M |
Patient : ‘1’ |
|
ParticipantObjectIDTypeCode |
M |
EV (2, RFC-3881, ‘Patient Number’) |
|
ParticipantObjectName |
U |
Patient Name |
|
ParticipantObjectDataLifeCycle |
U |
Verification ⇒ ‘4’ |
Present only for audits triggered by PDQ Service |
ParticipantObjectDetail |
U |
‘type=HL7v2 Message value=<Base-64 encoded HL7 message>’ |
|
ParticipantObjectDetail |
U |
‘type=HL7v2 Message value=<Base-64 encoded HL7 response>’ |
|
ParticipantObjectDetail |
U |
‘type=MSH-9 value=<Base-64 encoded HL7 message type>’ |
|
ParticipantObjectDetail |
U |
‘type=MSH-10 value=<Base-64 encoded HL7 message control ID>’ |
|
ParticipantObjectDetail |
U |
‘type=MSH-9 value=<Base-64 encoded HL7 response message type>’ |
|
ParticipantObjectDetail |
U |
‘type=MSH-10 value=<Base-64 encoded HL7 response message control ID>’ |
18.1.2.1.1.3.3. Sample Message¶
Patient Record audit emitted on receive of HL7 ADT message
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AuditMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.dcm4che.org/DICOM/audit-message.rnc">
<EventIdentification EventActionCode="C" EventDateTime="2018-09-11T11:43:05.007+02:00" EventOutcomeIndicator="0">
<EventID csd-code="110110" codeSystemName="DCM" originalText="Patient Record"/>
</EventIdentification>
<ActiveParticipant UserID="DCM4CHEE|DCM4CHEE" AlternativeUserID="9132" UserIsRequestor="false" UserTypeCode="2" NetworkAccessPointID="localhost" NetworkAccessPointTypeCode="1">
<RoleIDCode csd-code="110152" codeSystemName="DCM" originalText="Destination Role ID"/>
<UserIDTypeCode csd-code="HL7APP" codeSystemName="99DCM4CHEE" originalText="Application and Facility"/>
</ActiveParticipant>
<ActiveParticipant UserID="PAMSimulator|IHE" UserIsRequestor="true" UserTypeCode="2" NetworkAccessPointID="localhost" NetworkAccessPointTypeCode="1">
<RoleIDCode csd-code="110153" codeSystemName="DCM" originalText="Source Role ID"/>
<UserIDTypeCode csd-code="HL7APP" codeSystemName="99DCM4CHEE" originalText="Application and Facility"/>
</ActiveParticipant>
<AuditSourceIdentification AuditSourceID="dcm4chee-arc">
<AuditSourceTypeCode csd-code="4"/>
</AuditSourceIdentification>
<ParticipantObjectIdentification ParticipantObjectID="MEE4-54798^^^MEE4&1.3.6.1.4.1.12559.11.1.4.1.2&ISO^PI" ParticipantObjectTypeCode="1" ParticipantObjectTypeCodeRole="1">
<ParticipantObjectIDTypeCode csd-code="2" originalText="Patient Number" codeSystemName="RFC-3881"/>
<ParticipantObjectName>Berger^Oliver^^^^^L</ParticipantObjectName>
<ParticipantObjectDetail type="HL7v2 Message" value="TVNIfF5+XCZ8UEFNU2ltdWxhdG9yfElIRXxEQ000Q0hFRXxEQ000Q0hFRXwyMDE2MDYwMjE0Mjg1Nnx8QURUXkEyOF5BRFRfQTA1fDIwMTYwNjAyMTQyODU2fFB8Mi41fHx8fHx8QVNDSUlbQ1JdDQpFVk58fDIwMTYwNjAyMTQyODU2DQpQSUR8fHxNRUU0LTU0Nzk4Xl5eTUVFNCYxLjMuNi4xLjQuMS4xMjU1OS4xMS4xLjQuMS4yJklTT15QSXx8QmVyZ2VyXk9saXZlcl5eXl5eTHxTY2h1c3Rlcl5eXl5eXk18MTk5NDEwMjV8TXx8fEdhc3RlaWd3ZWdeXkhhbGxlaW5eXjU0MDBeQVVUfHxeUFJOXlBIfHx8fENBVHwxMTIyOV5eXklIRVBBTSYxLjMuNi4xLjQuMS4xMjU1OS4xMS4xLjIuMi41JklTT15BTnx8fHx8fHx8fHx8fHxOW0NSXQ0KUFYxfHxO"/>
<ParticipantObjectDetail type="HL7v2 Message" value="TVNIfF5+XCZ8RENNNENIRUV8RENNNENIRUV8UEFNU2ltdWxhdG9yfElIRXwyMDE4MDkxMTExNDMwNC4yNzR8fEFDS15BMjheQUNLfDE2OTE3ODcwNTN8UHwyLjV8fHx8fHxBU0NJSVtDUl0NTVNBfEFBfDIwMTYwNjAyMTQyODU2fA=="/>
<ParticipantObjectDetail type="MSH-9" value="QURUXkEyOA=="/>
<ParticipantObjectDetail type="MSH-10" value="MjAxNjA2MDIxNDI4NTY="/>
<ParticipantObjectDetail type="MSH-9" value="QUNLXkEyOA=="/>
<ParticipantObjectDetail type="MSH-10" value="MTY5MTc4NzA1Mw=="/>
</ParticipantObjectIdentification>
</AuditMessage>
Patient Record audit emitted on forwarding of received HL7 ADT message
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AuditMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.dcm4che.org/DICOM/audit-message.rnc">
<EventIdentification EventActionCode="C" EventDateTime="2018-09-11T11:43:05.007+02:00" EventOutcomeIndicator="0">
<EventID csd-code="110110" codeSystemName="DCM" originalText="Patient Record"/>
</EventIdentification>
<ActiveParticipant UserID="DCM4CHEE|DCM4CHEE" AlternativeUserID="9132" UserIsRequestor="false" UserTypeCode="2" NetworkAccessPointID="localhost" NetworkAccessPointTypeCode="1">
<RoleIDCode csd-code="110152" codeSystemName="DCM" originalText="Destination Role ID"/>
<UserIDTypeCode csd-code="HL7APP" codeSystemName="99DCM4CHEE" originalText="Application and Facility"/>
</ActiveParticipant>
<ActiveParticipant UserID="PAMSimulator|IHE" UserIsRequestor="true" UserTypeCode="2" NetworkAccessPointID="localhost" NetworkAccessPointTypeCode="1">
<RoleIDCode csd-code="110153" codeSystemName="DCM" originalText="Source Role ID"/>
<UserIDTypeCode csd-code="HL7APP" codeSystemName="99DCM4CHEE" originalText="Application and Facility"/>
</ActiveParticipant>
<AuditSourceIdentification AuditSourceID="dcm4chee-arc">
<AuditSourceTypeCode csd-code="4"/>
</AuditSourceIdentification>
<ParticipantObjectIdentification ParticipantObjectID="MEE4-54798^^^MEE4&1.3.6.1.4.1.12559.11.1.4.1.2&ISO^PI" ParticipantObjectTypeCode="1" ParticipantObjectTypeCodeRole="1">
<ParticipantObjectIDTypeCode csd-code="2" originalText="Patient Number" codeSystemName="RFC-3881"/>
<ParticipantObjectName>Berger^Oliver^^^^^L</ParticipantObjectName>
<ParticipantObjectDetail type="HL7v2 Message" value="TVNIfF5+XCZ8UEFNU2ltdWxhdG9yfElIRXxEQ000Q0hFRXxEQ000Q0hFRXwyMDE2MDYwMjE0Mjg1Nnx8QURUXkEyOF5BRFRfQTA1fDIwMTYwNjAyMTQyODU2fFB8Mi41fHx8fHx8QVNDSUlbQ1JdDQpFVk58fDIwMTYwNjAyMTQyODU2DQpQSUR8fHxNRUU0LTU0Nzk4Xl5eTUVFNCYxLjMuNi4xLjQuMS4xMjU1OS4xMS4xLjQuMS4yJklTT15QSXx8QmVyZ2VyXk9saXZlcl5eXl5eTHxTY2h1c3Rlcl5eXl5eXk18MTk5NDEwMjV8TXx8fEdhc3RlaWd3ZWdeXkhhbGxlaW5eXjU0MDBeQVVUfHxeUFJOXlBIfHx8fENBVHwxMTIyOV5eXklIRVBBTSYxLjMuNi4xLjQuMS4xMjU1OS4xMS4xLjIuMi41JklTT15BTnx8fHx8fHx8fHx8fHxOW0NSXQ0KUFYxfHxO"/>
<ParticipantObjectDetail type="HL7v2 Message" value="TVNIfF5+XCZ8RENNNENIRUV8RENNNENIRUV8UEFNU2ltdWxhdG9yfElIRXwyMDE4MDkxMTExNDMwNC4yNzR8fEFDS15BMjheQUNLfDE2OTE3ODcwNTN8UHwyLjV8fHx8fHxBU0NJSVtDUl0NTVNBfEFBfDIwMTYwNjAyMTQyODU2fA=="/>
<ParticipantObjectDetail type="MSH-9" value="QURUXkEyOA=="/>
<ParticipantObjectDetail type="MSH-10" value="MjAxNjA2MDIxNDI4NTY="/>
<ParticipantObjectDetail type="MSH-9" value="QUNLXkEyOA=="/>
<ParticipantObjectDetail type="MSH-10" value="MTY5MTc4NzA1Mw=="/>
</ParticipantObjectIdentification>
</AuditMessage>