appdIdentity Document Topic
HL7 DSTU
HL7 PA, R2-2010
HL7 Version 3 Standard: Patient Administration, DSTU Release 2 Update
February 2010 Update to DSTU Release 2

Content Last Edited: 2011-06-17T13:44:56


The Identify Document topic focuses narrowly on information exchanges with person identification document registries. The focus is on verifying the validity of a document such as a passport or driver's license and not on authenticating the identity of the person presenting the document.

This DSTU update contains no updates to the R2-2007 content.

 3.1.3 Known Issues

The Patient Administration work group is not aware of any implementers of this topic in the DSTU and is considering withdrawing it from the standard before normative ballot.

Go To Top

 Storyboards (Sorted by Title)
 Storyboards (Sorted by Display Order)
 
pointer Document Validity Verification (PRPA_ST900101UV02
Reference

For details on the interpretation of this section, see the storyboard discussion in the Version 3 Guide.

Purpose
This storyboard demonstrates the use of a request to an identification document registry (the issuing authority, or a party acting on its behalf) to verify the validity of an identification document. The identification document registry will respond with a confirmation and the verification results, or it will respond with a rejection and the reason for the rejection.
Diagram
Activity Diagram
Interaction List
Document Validity Verification Request Schema View PRPA_IN900101UV02
Document Validity Verification Response Schema View PRPA_IN900102UV02
Document Validity Verification Rejected Schema View PRPA_IN900103UV02
Narrative Example
A person shows up at the Good Health Hospital and uses his Dutch Passport (with number NP3473881, issued in the name of Henk van den Berg, a person with the national citizen ID 100197245) to identify himself. As part of the process of verifying if the person (as a biological entity) is Henk van den Berg, the clerk in the hospital sends a Document Validity Verification Request to a governmental identification-document-registry. The request contains an identification of the type of identification document ("Dutch Passport") and the identification number of the document (NP3473881). The registry responds with a Document Validity Verification Responseindicating the the document is valid.
Narrative Example

A person shows up at the Good Health Hospital and uses his Dutch Passport (with number NP835243239) to identify himself. As part of the process of verifying if the person (as a biological entity) is Kees ter Beek, the clerk in the hospital sends a Document Validity Verification Request to a governmental identification-document-registry.

The request is rejected by the registry because the clerk does not have the authorization to request a verification. The registry responds with a Document Validity Verification Rejected and identifies the authorization issue as a reason for the reject. The reject interaction does not make any statement about the validity of the document.

Go To Top

 Application Roles (Sorted by Artifact Code)
 Application Roles (Sorted by Display Order)
 
pointer Document Validity Verification Placer (PRPA_AR900101UV02
pointer Document Validity Verification Fulfiller (PRPA_AR900102UV02
Reference

For details on the interpretation of this section, see the discussion of application roles and their relationships in the Version 3 Guide.

Description View InteractionsThis application role represents applications that need to determine whether an identification document is valid.
Description View InteractionsThis application role represents the responsibility of a person identification document registry to respond to document validity verification requests. The application must either accept or reject the request. When it accepts the verification request it must return an indication as to whether the identification document is valid or not.

Go To Top

 Trigger Events (Sorted by Title)
 Trigger Events (Sorted by Display Order)
 
pointer Document Validity Verification Request (PRPA_TE900101UV02
pointer Document Validity Verification Response (PRPA_TE900102UV02
pointer Document Validity Verification Rejected (PRPA_TE900103UV02
Reference

For details on the interpretation of this section, see the discussion of trigger events in the Version 3 Guide.

Description View Interactions
Type:  User request

A source system sends a request to a document registry to verify the validity of an identification document.

Description View Interactions
Type:  Interaction based
A document registry responds to a requester with the results of an identification document validity verification. The document is either verified or not verified.
Description View Interactions
Type:  Interaction based
A document registry rejects a request to verify the validity of an identification document due to errors in the verification process.

Go To Top

 Refined Message Information Models (Sorted by Title)
 Refined Message Information Models (Sorted by Display Order)
 
pointer Document Validity Verification Request (PRPA_RM900101UV02
pointer Document Validity Verification Response (PRPA_RM900102UV02
pointer Document Validity Verification Request Rejected (PRPA_RM900103UV02
Reference

For details on the interpretation of this section, see the description of RMIMs in the Version 3 Guide.

Diagram
T-PRPA_RM900101UV.png
Parent:  Patient Administration (PRPA_DM000000UV)
Description

Overview

The Document Validity Verification Request R-MIM defines the payload for a request message sent to an Identification Document Registry. The R-MIM contains the details of the requested document validity verification activity as well as details of the identification document that is the subject of the requested verification act.

Walk-through

VerficationRequest: An act identifying a request for verification

  • id: Identifier for the verification request
  • code: Code identifying the type of verification
  • effectiveTime: Time of the requested verification event
  • priorityCode: A code (e.g., for routine, emergency), specifying the urgency under which the verification act is requested to happen
  • reasonCode: A code specifying the motivation, cause or rationale for the verification request
  • author participation: The person, organization or device that requested the verification, and the organization they represent, are identified via this participation.
  • subject Act Relationship: This relationship associates a verification request with its subject: the identification document

R_Responsible CMET: A CMET identifying the party that requested the document validity verification

IdentityDocument: An identification document that is the subject of the verification process

  • id: Identifier of the identification document
  • code: Code identifying the type of identification document (e.g. passport, drivers license)
  • subject Participation: The person whose details are shown on the identification document
Contained Hierarchical Message Descriptions
Document Validity Verification Request PRPA_HD900101UV02
Diagram
T-PRPA_RM900102UV.png
Parent:  Patient Administration (PRPA_DM000000UV)
Description

Overview

This Document Validity Verification Response R-MIM contains the details of the verification of the validity of an identification document and the result of the validity verification (document is valid or not valid).

Walk-through

Verification: An act that identifies the verification event. The verification process and results are described through classes associated with this Act

  • id: identifier for the verification event
  • code: code identifying the type of verification. Codes are taken from the ActVerificationTypeCode domain
  • effectiveTime: time of the verification event
  • value: the actual outcome of the verification process e.g. 'verified', 'not verified'
  • inFullfillmentOf Act Relationship: This relationship associates a verification event with one VerificationRequest
  • PrimaryPerformer Participation: The person, organization or device that actually performed the verification, and the organization they represent, are identified via this participation
  • subject Act Relationship: This relationship associates a verification event with its subject: the identification document.

VerificationRequest: An act identifying a request for verification. Apart from an event identifier the particulars of the request are not supported in this model

  • id: identifier for the verification request

R_AssignedEntity CMET: A CMET identifying the party which has performed the document validity verification (e.g. the issuing authority, or a party acting on behalf of that authority)

IdentityDocument: An act representing the identification document that is the subject of the verification process

  • id: identifier for the identification document
  • code: code identifying the type of identification document (e.g. passport, drivers license)
  • subject Participation: The person whose details are shown on the identification document
Contained Hierarchical Message Descriptions
Document Validity Verification Response PRPA_HD900102UV02
Diagram
PRPA_RM900103UV.png
Parent:  Patient Administration (PRPA_DM000000UV)
Description

Overview

The Document Validity Verification Request Rejected R-MIM only identifies the document validity request that is being rejected. The reason(s) for the rejection are found in the wrappers.

Walk-through

ValidityVerification: An act identifying a request for verification

  • id: identifier for the verification request (mandatory)
Contained Hierarchical Message Descriptions
Document Validity Verification Request Rejected PRPA_HD900103UV02

Go To Top

 Hierarchical Message Descriptions (Sorted by Title)
 Hierarchical Message Descriptions (Sorted by Display Order)
 
pointer Document Validity Verification Request (PRPA_HD900101UV02
pointer Document Validity Verification Response (PRPA_HD900102UV02
pointer Document Validity Verification Request Rejected (PRPA_HD900103UV02
Reference

For details on the interpretation of this section, see the description of HMDs in the Version 3 Guide.

Description

The Document Validity Verification Request payload message contains the details of a user request sent to an identification document registry to verify the validity of an identity device (e.g., document, chipcard).

Common Message Element Types Used
R_ResponsibleIdentified/informational COCT_MT040008UV
Base Hierarchical Message Description Goto RMIM Table View Excel View
Message Type List
Document Validity Verification Request PRPA_MT900101UV02
Description
The Document Validity Verification Response payload message contains results of a document validity verification performed by an identification document registry. The document could have been found to be valid or invalid.
Common Message Element Types Used
R_AssignedEntityIdentified/informational COCT_MT090008UV
Base Hierarchical Message Description Goto RMIM Table View Excel View
Message Type List
Document Validity Verification Response PRPA_MT900102UV02
Description
The Document Validity Verification Request Rejected payload message identifies a request that was rejected by the identification document registry (filler application). The reason(s) for the rejection are sent the message wrapper.
Base Hierarchical Message Description Goto RMIM Table View Excel View
Message Type List
Document Validity Verification Request Rejected PRPA_MT900103UV02

Go To Top

 Interactions (Sorted by Title)
 Interactions (Sorted by Display Order)
 
pointer Document Validity Verification Request (PRPA_IN900101UV02
pointer Document Validity Verification Response (PRPA_IN900102UV02
pointer Document Validity Verification Rejected (PRPA_IN900103UV02
Reference

For details on the interpretation of this section, see the definition of Interactions in the Version 3 Guide.

Description Schema View

A user initiates a request to an identification document registry to verify the validity of an identification document.

Trigger Event Document Validity Verification Request PRPA_TE900101UV02
Transmission Wrapper Send Message Payload MCCI_MT000100UV01
Control Act Wrapper Trigger Event Control Act MCAI_MT700201UV01
Message Type Document Validity Verification Request PRPA_MT900101UV02
Receiver Responsibilities
Reason Trigger Event Interaction
If a Verification Request Fulfiller application role accepts a request to verify the validity of a document it must respond back with the identifier of the request and the result of the verification PRPA_TE900102UV02 PRPA_IN900102UV02
If a Verification Request Fulfiller application role rejects a request to verify the validity of a document then it must respond back with the identifier of the request and the reason(s) it was rejected PRPA_TE900103UV02 PRPA_IN900103UV02
Sending and Receiving Roles
Sender Document Validity Verification Placer PRPA_AR900101UV02
Receiver Document Validity Verification Fulfiller PRPA_AR900102UV02
Description Schema View

An identification document registry accepts a request to verify the validity of an identification document. The registry carries out the the verification and returns the verification results to the requesting system.

Trigger Event Document Validity Verification Response PRPA_TE900102UV02
Transmission Wrapper Application Level Acknowledgement MCCI_MT000300UV01
Control Act Wrapper Trigger Event Control Act MCAI_MT700201UV01
Message Type Document Validity Verification Response PRPA_MT900102UV02
Sending and Receiving Roles
Sender Document Validity Verification Fulfiller PRPA_AR900102UV02
Receiver Document Validity Verification Placer PRPA_AR900101UV02
Description Schema View

An identification document registry encounters errors while processing a request to verify the validity of an identification document and rejects the verification request.

Trigger Event Document Validity Verification Rejected PRPA_TE900103UV02
Transmission Wrapper Application Level Acknowledgement MCCI_MT000300UV01
Control Act Wrapper Trigger Event Control Act MCAI_MT700201UV01
Message Type Document Validity Verification Request Rejected PRPA_MT900103UV02
Sending and Receiving Roles
Sender Document Validity Verification Fulfiller PRPA_AR900102UV02
Receiver Document Validity Verification Placer PRPA_AR900101UV02

Return to top of page