Message EHRCS11_Put_New_Client_Registry_Patient

Communication Step Summary

Description:

This EHR Communication Step will use client and provider identifying information to create a new patient in the Client Registry.

This communication step will use IIP Put to initiate the EHR Client Registry Services to manage the following HL7 V3 Client Registry Messages to complete this interaction.

Find Candidates Query*
Add Client Notification*

* See Infoway Client Registry Messaging Overview for more details regarding these HL7 messages.

Used by:

List of EHR IP

EHRIP11 Add New Client Registry Patient

Uses: IIP_Put

Communication Structure:

This EHR Communication Step is composed of the following generic transaction component wrappers that encapsulate and provide the context for the HL7 v3 message payload.

HL7 v3 Message Composite Message Structure	Comment
Transmission Wrapper	Information to package & route HL7 v3 Message Payload Includes attributes to identify generic messaging mode Includes handling behaviour for defined HL7 message interaction
Message Control Wrapper	Includes domain specific administrative information for the controlled act being executed such as Provider, Client and Location Context
Message Payload	The message parameters

HL7 Trigger:

-Notification

Communication Step Type:

-Put

Domain:

-Client Registry

Constraint:

-New Client

Message:

Inputs:

-Header

EHRi Interface Identifiers

-Add Client Notification Message Header

Attribute/ Attribute Group	Notes
Registration Request Identifier (*)	Unique identifier for this transaction, used in ‘undos’;
Registration Request Status Code (*)	Indicates the status of the registration (e.g. Active);
Created by (*) (1)	Indicates the person responsible for the event that caused this message (e.g. registrar);
Time of Creation (*)	The time the person responsible for creating the event made the decision for it to occur;
Created by Author ID (*)	A unique identifier for the Author; Note: Although this attribute has been defined as Populated, a constraint exists that this attribute must be specified if Author Name is null;
Created by Author Name (*)	The name by which the author is known; Note: Although this attribute has been defined as Populated, a constraint exists that this attribute must be specified if Author ID is null;
Client Identifier	At least 1 client identifier must be present in the message;
Client Status Code	Indicates the status of the Client role (e.g. Active);
Client Effective Time	Indicates the effective time of the Client role;
Registry Organization Identifier	Unique identifier for the organization that assigned that scoped the client.

-Payload

Client Registry Data

Attribute/ Attribute Group	Notes
Registration Request Effective Time (*)	The time at which the registration request took effect;
Client Name	Name(s) for the Client;
Client Gender	Gender of the Client;
Client Date of Birth	Date of birth of the Client;
Client Address	Address(es) of the Client;
Client Telecom	Telecom of the Client.

Rationale

This Communication Step allows a health care provider, who has a patient’s consent, to create new patient information in the Client Registry .

General Info
Name	EHRCS11_Put_New_Client_Registry_Patient
Action Type	uninterpreted
Sender
Receiver	IIP Put
Collaboration	EHRIP11 - Add New Client Registry Patient

Action EHRCS11_Put_New_Client_Registry_Patient

General Info
Name	EHRCS11_Put_New_Client_Registry_Patient
Type	uninterpreted
Asynchronous	false
Owner	EHRCS11_Put_New_Client_Registry_Patient

Arguments
request