Applicable Doc. 03 - IAM Design and Architecture Management Plan.pdf

Identity and Access Management

Design and Architecture Management Plan

April 2021

Version 0.1

Department of Veterans Affairs

IAM

Architecture and Design Management Plan i October 2021

Revision History

Date Version Description Author

09/28/2021 0.1 Initial Draft Patrick Kiboti

Architecture and Design Management Plan ii October 2021

Table of Contents

1. Introduction

1.1. Purpose

1.2. Artifacts

1.2.1. System Design Document

1.2.2. Service Description

1.2.3. MPI/HL7 Interface Specification

1.2.4. FHIR

1.3. References

2. Architecture and Design Development

2.1. Architecture and Design Process Flow

3. Sample Process

Architecture and Design Management Plan 3 October 2021

1. Introduction

1.1. Purpose

Architecture and Design Management is a systematic approach to identifying, organizing, communicating, and managing the changing architecture and design to allow coordination between multiple stakeholders.

There are two primary objectives of this document:

1. Ensure that the architecture and design for new enhancement is well captured, understood and agreed by the multiple stakeholders.

2. Create a process for accepting architecture and design artifacts.

The intended audiences for this document include the following:

• Technical Leads: This group is responsible for the architecture and design for all VA

MPI components, MPI, PSIM, TK and VistA

• VA MPI Developers: This group is responsible for coding and implementation of the approved design and architecture.

• IAM PMO: This group is responsible for accepting, reviewing, and approving contract deliverables which includes the design and architecture package

1.2. Artifacts

The documents that are used to define the design and architecture are:

1.2.1. System Design Document

This document provides details on software and system changes to deliver IAM VIP release.

1.2.2. Service Description

This document describes the interactive interfaces to and from the VA Master Person Index (VA MPI) Service.

1.2.3. MPI/HL7 Interface Specification

This interface specification is intended to identify the VistA information that will be shared as part of the MVI.

1.2.4. FHIR

This describes the resources and transactions that make up VA MPI implementation of the HL7 FHIR standard.

1.3. References

The templates for the documents document are included here.

Architecture and Design Management Plan 4 October 2021

2. Architecture and Design Development

2.1. Architecture and Design Process Flow

The following is a high-level process flow of the architecture and design process flow

Architecture and Design Management Plan 5 October 2021

1. Receive Approved Requirements

VA MPI Technical shall receive approved requirements from the Analyst lead.

NOTE: For the requirements process, refer to the Requirement Management Plan

2. Define the Software Architecture and Design

VA MPI technical leads shall conduct design sessions to define the implementation strategy.

This activity includes but not limited to:

• Define enhancements to the HL7 messaging as required in the requirements. (HL7 v2.4, 3.0 or FHIR)

• Define enhancements to the messaging between PSIM and MPI

• Define UI changes – This may require follow up with the business to establish the location and placement of new attributes in MVI TK or MPI

UI.

• Define MDM changes

• Establish the dependencies – These will be provided to the appropriate PM to manage.

• Confirm the LOE for each requirement – Updates shall be provided to the IAM Roadmap.

3. Create System Design Document

VA MPI technical lead shall update the outcome of the architect and design in the following sections of the System Design Document section

• Software Architecture

• Updated IAM diagrams

4. Coding

The VA MPI developers shall start the coding changes as directed by the respective VA MPI Technical Lead

If there are messaging change the lead developer or designee shall update the appropriate section of the Service Description with the messaging changes

5. Update System Design Document

VA MPI Technical Lead shall or designee shall update the System Design Document with the detailed implementation details that shall include and not limited to:

• Conceptual Design

Architecture and Design Management Plan 6 October 2021

• System Architecture

• Database changes

• Detailed Design (Software and Hardware)

• Data Design

• External System Interface Design

• Human-Machine Interface

6. Deliver System Design Document and Service Description

As required by the contract the development group shall deliver the updated System Design Document, MPI/HL7 Interface Specification and Service Description to the VA MPI PMO group.

7. Review and Approve System Design and Service Description

The VA MPI PMO team shall review and approve the System Design document.

The approval criteria shall include and not limited to:

• Approved requirements have defined implementation

• Service Description messaging and applicable versioning is called out

• System Design document includes approved UI changes.

• Database changes have been defined and approved

8. Publish Service Description and MPI/HL7 Interface Specification

The VA MPI PMO team in collaboration with the VA MPI release manager shall release the updates Service Description that includes a summary of the changes made.

Architecture and Design Management Plan 7 October 2021

3. Sample Process The sample below defines the application of the process defined above using the following approved requirement.

1. [Business User Story VAMPI- 10577] Support Sexual Orientation

• MVI Scope o Enhance VistA to trigger messages to MVI when Sexual Orientation is added or Updated in VistA o Enhance HL7 messages (v2.4 and v3.0) to transmit Sexual Orientation to

MVI

o Process Sexual Orientation – Correlation and Primary View o Synchronize Sexual Orientation to LOB o TK Enhancement to display the Sexual Orientation value o Provide location to stored Sexual Orientation in VistA o Enhance messaging to include explicit delete from consumers (i.e, if a null value is sent we shall not delete existing Primary View value).

The systems that will be collecting and sending data to MVI are Cerner

Data Format – Below are the Support Sexual Orientation Attributes o Lesbian, gay or homosexual.

o Straight or heterosexual.

o Bisexual.

o Something else, please describe. - Maximum Characters - 255 o Don’t know.

o Choose not to disclose.

Promote to Primary View – (DQ/HC IdM group) - MVI shall promote Sexual Orientation to the Primary View

The business rule for promoting the Sexual Orientation to the Primary View is Last In Win.

The MVI TK shall be enhanced to support override of the Sexual Orientation value.

Deletes are not allowed in VistA HC IdM can delete using the OVR – The delete will be shared with other correlations and not VistA.

HC IdM will have option to add Authority Score during the OVR process.

For MPI – The enhancement shall include adding the Authority Score and Adding the field to Patient Inquiry in VistA

Architecture and Design Management Plan 8 October 2021

Following the process defined above

1. Define the Software Architecture and Design

VA MPI technical leads defines

• Define enhancements to the HL7 messaging

This attribute shall be added to the Administrative Observation

<administrativeObservation classCode="VERIF">

<code code="SOGI" displayName="Sexual Orientation" codeSystem="2.16.840.1.113883.4.349"/> <value xsi:type="CD" code="LGH~STH~BIS~QER" displayName="Lesbian gay or homosexual~Staright or

Heterosexual~Bisexual~Queer"/>

</administrativeObservation>

• Define enhancements to the messaging between PSIM and MPI

OBX^x^CE^Sexual Orientation^^LGH~Lesbian, gay or homosexual~L^^

OBX^x^ST^Sexual Or Description^^~free text information~L^^

OBX^x^CE^Pronoun^^HIS~He/him/his~L^^

OBX^x^ST^Pronoun Description^^~free text information~L^^

OBX^x^CE^Admin Sex^^O~OTHER~L^^

• Define enhancements to the messaging between MPI and VistA - This is bi-directional

OBX^x^CE^Sexual Orientation^^LGH~Lesbian, gay or homosexual~L^^

OBX^x^ST^Sexual Or Description^^~free text information~L^^

OBX^x^CE^Pronoun^^HIS~He/him/his~L^^

OBX^x^ST^Pronoun Description^^~free text information~L^^

OBX^x^CE^Admin Sex^^O~OTHER~L^^

• Define UI changes

Primary View tab

Architecture and Design Management Plan 9 October 2021

• Establish the dependencies o Cerner – TBD o CPRS - CPRS patches are: OR*3*558/PXRM*2*78 o VA.GOV - TBD

• Confirm the LOE for each requirement – Updates shall be provided to the IAM Roadmap.

2. Create System Design Document

Architecture and Design Management Plan 10 October 2021

VA MPI technical lead shall update the outcome of the architect and design in the following sections of the System Design Document section

• Software Architecture

• Updated IAM diagrams

3. Coding

The VA MPI developers shall start the coding changes as directed by the respective VA MPI Technical Lead

If there are messaging change the lead developer or designee shall update the appropriate section of the Service Description with the messaging changes

Below are the messages updated to the Service Description – Update to Add Person (Implicit Add with Search)

1301 Request:

<ps:PRPA_IN201301UV02 xmlns="urn:hl7-org:v3" xmlns:ps="http://vaww.oed.oit.va.gov" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:hl7-org:v3 ../../schema/HL7V3/NE2008/multicacheschemas/PRPA_IN201301UV02.xsd" ITSVersion="XML_1.0"> <id extension="MCID-ADD-COR-bmc07302012" root="22a0f9e0-4454-11dc-a6be-3603d6866807"/> <creationTime value="20070803130624"/> <interactionId extension="PRPA_IN201301UV02" root="2.16.840.1.113883.1.6"/> <processingCode code="T"/> <processingModeCode code="T"/> <acceptAckCode code="AL"/> <receiver typeCode="RCV"> <device classCode="DEV" determinerCode="INSTANCE"> <id root="2.16.840.1.113883.4.349"/> <telecom value="https://example.org/PatientFeed"/> </device> </receiver> <sender typeCode="SND"> <device classCode="DEV" determinerCode="INSTANCE"> <id extension="200ESR" root="1.2.840.114350.1.13.99997.2.7788"/> </device> </sender> <controlActProcess classCode="CACT" moodCode="EVN"> <subject typeCode="SUBJ"> <registrationEvent classCode="REG" moodCode="EVN"> <id nullFlavor="NA"/> <statusCode code="active"/> <subject1 typeCode="SBJ"> <patient classCode="PAT"> <id root="1.2.840.114350.1.13.99997.2.3412" extension="1070121175V853480^NI^200M^USVHA"/> <statusCode code="active"/> <patientPerson> <name use="L">

Architecture and Design Management Plan 11 October 2021

<given>SVETLANA</given> <family>HEINRICH</family> </name> <administrativeGenderCode code="M"/> <birthTime value="19500101"/> <addr use="HP"> <streetAddressLine>23456 Street</streetAddressLine> <city>Chicago</city> <state>IL</state> <country>USA</country> <postalCode>33333</postalCode> </addr> <asOtherIDs classCode="PAT"> <id root="2.16.840.1.113883.3.42.10001.100001.12" extension="20141203^NI^200DOD^USDOD"/> <scopingOrganization classCode="ORG" determinerCode="INSTANCE"> <id root="2.16.840.1.113883.3.42.10001.100001.12"/> </scopingOrganization> </asOtherIDs> <asOtherIDs classCode="CIT"> <id root="2.16.840.1.113883.4.1" extension="777889999"/> <scopingOrganization classCode="ORG" determinerCode="INSTANCE"> <id root="2.16.840.1.113883.4.1"/> </scopingOrganization> </asOtherIDs> </patientPerson> <providerOrganization classCode="ORG" determinerCode="INSTANCE"> <id root="1.2.840.114350.1.13.99998.8734"/> <name>Good Health Clinic</name> <contactParty classCode="CON"> <telecom value="tel:+1-342-555-8394"/> </contactParty> </providerOrganization> <subjectOf> <administrativeObservation classCode="VERIF"> <id extension="Administrative Sex" root="2.16.840.1.113883.4.349"/> <code code="AdministrativeSex" displayName="Administrative Sex" codeSystem="2.16.840.1.113883.4.349"/> <value xsi:type="CD" code="M" displayName="Male"/> </administrativeObservation> </subjectOf> <subjectOf> <administrativeObservation classCode="VERIF"> <id extension="SEXUAL ORIENTATION" root="2.16.840.1.113883.4.349"/> <code code="SOGI" displayName="Sexual Orientation" codeSystem="2.16.840.1.113883.4.349"/> <value xsi:type="CD" code="LGH~STH~BIS~OTH" displayName="Lesbian gay or homosexual~Straight or Heterosexual~Bisexual~Another option :ALIEN Explanation of Sexual Orientation description"/> </administrativeObservation> </subjectOf> <subjectOf> <administrativeObservation classCode="VERIF">

Architecture and Design Management Plan 12 October 2021

<code code="PERSON_TYPE" displayName="Person Type" codeSystem="2.16.840.1.113883.4.349"/> <value xsi:type="CD" code="vet~pat" displayName="Veteran,Patient"/> </administrativeObservation> </subjectOf> <subjectOf> <administrativeObservation classCode="VERIF"> <id extension="PRONOUN" root="2.16.840.1.113883.4.349"/> <code code="Pronoun" displayName="Pronoun" codeSystem="2.16.840.1.113883.4.349"/> <value xsi:type="CD" code="HIS~HER~THE~ZIR~PTN~OTH" displayName="His/He/Him~Hers/Her/she~They/Them/Theirs~Ze/Zir/Zirs~Patient Name~OTHER:ALIEN Explanation of Pronouns"/> </administrativeObservation> </subjectOf> </patient> </subject1> <custodian typeCode="CST"> <assignedEntity classCode="ASSIGNED"> <id root="1.2.840.114350.1.13.99998.8734"/> <assignedOrganization classCode="ORG" determinerCode="INSTANCE"> <name>Good Health Clinic</name> </assignedOrganization> </assignedEntity> </custodian> </registrationEvent> </subject> </controlActProcess> </ps:PRPA_IN201301UV02>

4. Update System Design Document

VA MPI Technical Lead shall, or designee shall update the System Design Document with the detailed implementation details that shall include and not limited to:

• Database changes

• Hardware Detailed Design

• Software Detailed Design

****Sample updates****

Flows:

TK Override:

To update SO, Pronouns, Administrative Sex at Primary View level create 1300 - PRIMARY VIEW OVERRIDE task.

Administrative Sex can be updated calling MPI UPDATE PRIMARY VIEW

Sexual Orientation can be updated by calling MPI PSIM UPDATE SEX ORIEN PV Pronoun values can be updated by calling MPI PSIM UPDATE PRONOUN PV

Architecture and Design Management Plan 13 October 2021

Displaying Values in TK

MPI populates Primary View tab calling MPI RPC - MPI GET BY SOURCE ID and

MPI RETURN CORRELATION DATA

Correlation Compare page values are populated from ADR calling PSIM directly

PSIM flows:

1301 Add these new traits at correlation and PV level 1302 Update triggers A08 to MPI.

A31 from MPI to PSIM adds/updates these traits at PV and correlation level PSIM sends these traits over MPI NEXT ICN FOR PSIM and MPI ADD CORRELATION RPCs

Testing Recommendation:

• To test best is from PSIM tools IdmRequestUtilities.

• Submit the sample 1301 that will add an ICN with correlation and these traits.

Then send 1302 Update from IdmRequestUtilities.

• This will update the values and send an A08 to MPI.

• Then MPI will send A31 to PSIM

• You can also test override functionality from TK.

5. Deliver System Design Document and Service Description

As required by the contract the development group shall deliver the updated System Design Document and Service Description to the VA MPI PMO group

6. Review and Approve System Design and Service Description

The VA MPI PMO team shall review and approve the System Design document.

The approval criteria shall include and not limited to:

• Approved requirements have defined implementation

• Service Description messaging and applicable versioning is called out

• System Design document includes approved UI changes.

• Database changes have been defined and approved

7. Publish Service Description

The VA MPI PMO team in collaboration with the VA MPI release manager shall release the updates Service Description that includes a summary of the changes made.