HI Service - IHI Lookup - Test Cases

Reading & Development: 2 hours 

Quick Intro

After successfully executing the IHI Lookup, it is important to modify your implementation to meet the Test Cases for the Use Cases we have built to.

• UC.010 (adding a new patient in your local system and retrieving their IHI), and
• UC.015 (updating patient details in your local system and revalidating their IHI).

Both of these Use Cases are very similar and utilize the same HI Service web service.

Use Case 010 (UC.010) – Register Patient

Here is the description of UC.010;

Clarification
UC.010 is titled ‘Register Patient’, it is important to note that this is the process of entering a new patient in your local system (e.g. a new patient attends a practice and an administrator creates a new patient record) and it does not mean a new patient is being registered for an IHI in the HI Service.

We will now walk through several Test Cases for UC.010. The first few examples are quite introductory just to give you a feel for the test cases. Please be sure to review all the applicable Test Cases for each Use Case.

Code Example
The following functionality could be applied to meet this test case. This code can be used as a guide to assist you when sending a family name and given name for an IHI lookup.

string familyName = "Name with More than 40 characters should send only 40 characters.";
request.familyName = familyName.Substring(0, 40);

string givenName = "Name with More than 40 characters should send only 40 characters.";
request.givenName = givenName.Substring(0, 40);

Code Example
The following code example shows a method to validate the date of birth when entered manually. Your software likely already conducts similar validation. 

public static bool IsValidDate(int year, int month, int day)
{
    if (year < DateTime.MinValue.Year || year > DateTime.MaxValue.Year)
        return false;

    if (month < 1 || month > 12)
        return false;

    return day > 0 && day <= DateTime.DaysInMonth(year, month);
}

UI Example 1: Calendar control, where user automatically select valid date of birth that includes year, month and day.

1-ihi-date-of-birth-screenshot.jpg

UI Example 2: Individual dropdown controls for the day, month and year.

1-ihi-date-screenshot.jpg

Code Example
The following code example demonstrates how you can save/update the patient record with the mandatory IHI details. We have used dummy classes/objects (Patient, HIResponse, HIHelperService, etc) to demonstrate this functionality.

When the IHI status is “Active” or “Deceased” the response is simple to interpret as they are returned in the <ihiStatus> tag. However, when the patient IHI status is “Retired”, “Expired” or “Resolved” it is  not returned within the <ihiStatus> tag and the response will be returned with a service message as shown in the table below.

Please use the test data to see the different responses from the HI Service. 

To find out the service messages, see the code below.

// searchIHIResponse is available class in installed NEHTA library.
searchIHIResponse ihiResponse = client.BasicMedicareSearch(request);
var serviceMessages = ihiResponse.searchIHIResult.serviceMessages

Actual test case implementation;

private void SavePatientIHIDetails_HI_010_005820(Patient patient)
{
    // HIHelperService is service class and contains HI Service related utility methods, e.g. IHI Lookup, IHI Validate, etc.
    HIResponse ihiResponseObj = HIHelperService.SearchBy(patient.GivenName, patient.FamilyName, patient.DOB, patient.Gender, patient.MedicareNumber, patient.IHINumber, patient.DVA);

    // IHI is not null or empty with IHI status "Active" or "Deceased"
    if (!string.IsNullOrEmpty(ihiResponseObj.IHINumber))
    {
        patient.IHINumber = ihiResponseObj.IHINumber;
        patient.IHIStatus = ihiResponseObj.IHIStatus;
        patient.IHIRecordStatus = ihiResponseObj.IHIRecordStatus;
        patient.IHIUpdatedDate = DateTime.Now;
    }
    else
    {
        // service messages are retrieved as.
        // ihiResponse = client.BasicMedicareSearch(request); where client is ConsumerSearchIHIClient. Please see IHI lookup example.
        // ihiResponse.searchIHIResult.serviceMessages.serviceMessage

        // Please check the IHI look up tutorial to find more.
        // In this demo, HIHelperService is a local service class that does all the job under the hood, and put the HI response with the service messages into local HIResponse object

        var serviceMessage = ihiResponseObj.ServiceMessages.serviceMessage[0];
        // When IHI is retired, expired or resolved.

        switch (serviceMessage.code)
        {
            // Error Code 01613 = "Expired"
            case "01613":
                patient.IHIStatus = "Expired";
                patient.IHIError = serviceMessage.reason;
                break;
            // Error Code 01614 = "Retired"
            case "01614":
                patient.IHIStatus = "Retired";
                patient.IHIError = serviceMessage.reason;
                break;
            // Information Code: 01606, 01611, and 01612 when IHI is resolved to new <IHI Number>
            case "01606":
            case "01611":
            case "01612":
                // Get the new IHI number from the HI Service response.
                // Get the old IHI number (your local CIS database) and //save                   // into patient's old ihi.
                // Store the service messages.
                break;
        }

        _patientService.SavePatient(patient);

    }
}

Code Example
The following code example demonstrates how to raise an error/alert when the same IHI number is assigned to more than one patient record. For the purpose of simplicity, assume we have a method in our local system to search for a patient and it throws an exception if the IHI is already linked with another patient. Your software would likely prompt the user that they should merge records or conduct some other activity.

public void SaveOrUpdatePatient(Patient patient)
{

    try
    {
        searchIHI request = new searchIHI();
        request.givenName = patient.GivenName;
        request.familyName = patient.FamilyName;
        request.sex = patient.SexType;
        request.dateOfBirth = patient.DOB;
	 request.medicareCardNumber= patient.MedicareNumber

        // Invokes a basic search
        searchIHIResponse ihiResponse = client.BasicSearch(request);

        // All details must be saved when saving IHI number.
        patient.IHINumber = ihiResponse.searchIHIResult.ihiNumber;
        patient.IHINumberStatus = ihiResponse.searchIHIResult.ihiStatus;
        patient.UpdatedAt = DateTime.Now;
        patient.IHIRecordStatus = ihiResponse.searchIHIResult.ihiRecordStatus;

        // Verify IHI number is not already attached with linked with another patient.
       // This code throws    some kind data exception if IHI number is found with existing patient in the local system.
        VerifyIHINumberInExistingPatientRecord(patient); 
        patientRepository.SaveOrUpdatePatient(patient);
    }
    catch (IncorrectDataException de)
    {
        MessageBox("This IHI number is already attached with existing patient.");
        return;

    }
}

The following screenshot shows the IHI details linked with a newly created patient.

1-ihi-demographics-ihi-screenshot.jpg

Code example
The following code example demonstrates the error messages returned from the HI Service and can be saved either in the file system or database using the logging service of your software.
Let’s take an assumption the web service call throws a fault exception in case of incorrect request or service message if record is not matched. Following code handles the both. It is highly important to interrogate "serviceMessage" to ensure the request was successful.

// Set up the request IHI
searchIHI request = new searchIHI();
request.medicareCardNumber = "495015297";
request.medicareIRN = "1";
request.dateOfBirth = DateTime.Parse("22 Aug 1980");
request.givenName = "John";
request.familyName = "Kelleher";
request.sex = SexType.M;

try
{
    // Invokes a basic search
    searchIHIResponse ihiResponse = client.BasicMedicareSearch(request);

    // Error logging from the returned response.
    if (ihiResponse.searchIHIResult.serviceMessages != null &&
        ihiResponse.searchIHIResult.serviceMessages.serviceMessage.Length>0)
    {
        // Log details e.g. 
        InfoLog info = new infoLog();

        info.ErrorMessage = ihiResponse.searchIHIResult
                .serviceMessages.serviceMessage[0].reason;
        info.ErrorId = client.SoapMessages.SoapRequestMessageId;
        info.ErrorDateTime = DateTime.Now;
        errorDetails.ErrorNumber = client.SoapMessages.SoapResponseMessageId;
	info
      // Log error in Database.
       DbLogger.LogInfo(errorDetails);
    }
                
    return ihiResponse.searchIHIResult.ihiRecordStatus.ToString();

}
catch (FaultException fex)
{
    string returnError = "";
    MessageFault fault = fex.CreateMessageFault();
    if (fault.HasDetail)
    {
        ServiceMessagesType error = fault.GetDetail<ServiceMessagesType>();
        // Look at error details in here
        if (error.serviceMessage.Length > 0)
            returnError = error.serviceMessage[0].code + ": " 
                         + error.serviceMessage[0].reason;
    }

    // If an error is encountered, client.LastSoapResponse often provides a more
    // detailed description of the error.
    string soapResponse = client.SoapMessages.SoapResponse;
    string requestMessageId = client.SoapMessages.SoapRequestMessageId;
    string responseMessageId = client.SoapMessages.SoapResponseMessageId;


    ErrorLog errorDetails = new ErrorLog();

    errorDetails.ErrorMessage = returnError;
    errorDetails.ErrorId = requestMessageId;
    errorDetails.ErrorNumber = responseMessageId;
    errorDetails.ErrorDateTime = DateTime.Now;


    // Log error in File System
    FileLogger.LogError(errorDetails);

    // Log error in Database.
    DbLogger.LogError(errorDetails);

                
}

1-ihi-duplicate-patient-record.jpg

The following code example demonstrates how to warn the user (with an alert) when the patient is saved with a verified IHI number that has the same demographic data as another patient already present in the local software.

private void btnSavePatient_Click(object sender, EventArgs e)
{

    Patient patient = new Patient();

    patient.FamilyName = txtFamilyName.Text;
    patient.GivenName = txtGivenName.Text;
    patient.DOB = txtDob.Text;
    patient.Gender = txtGender.Text;
    patient.MedicareNo = txtMedicareNo.Text;
    patient.IHINumber = txtIHINumber.Text;
    patient.IHIStatus = txtIHIStatus.Text;
            
    Patient patientRecordFound = _patientRepo
           .GetPatientByDemographicMatchingIHINumber(patient);

    if(patientRecordFound != null)
    {

        DialogResult dialogResult = MessageBox.Show("A patient with the same demographics and IHI already exists in the system. Would you still like to save the patient?", "Duplicate Patient Record", MessageBoxButtons.YesNoCancel, MessageBoxIcon.Warning);

        if (dialogResult == DialogResult.Yes)
        {
            // Flag the both patients as conflicted.
            bool newPatientSaved = _patientRepo.SavePatientWithFlagConflicted(patient);
	     bool newPatientSaved = _patientRepo.SavePatientWithFlagConflicted(patientRecordFound);

        }
        else if (dialogResult == DialogResult.No)
        {
            //do something else
        }

    }

This example demonstrates that each time a new patient is saved, all fields mentioned in the test objective must be saved for the audit trail.

1-ihi-demographics-screenshot.jpg

1-ihi-patient-ihi-history.jpg

Code example

private void btnSavePatient_Click(object sender, EventArgs e)
{
    Patient patient = new Patient();

    patient.FamilyName = txtFamilyName.Text;
    patient.GivenName = txtGivenName.Text;
    patient.DOB = txtDob.Text;
    patient.Gender = txtGender.Text;
    patient.MedicareNo = txtMedicareNo.Text;

    patient.IHINumber = txtIHINumber.Text;
    patient.IHIStatus = txtIHIStatus.Text;


    PatientIHIHistory patientIHIData = new PatientIHIHistory();
    patientIHIData.LocalID = "Local Software Identifier";
    patientIHIData.Name = patient.FamilyName + patient.GivenName;
    patientIHIData.IHINumber = patient.IHINumber;
    patientIHIData.IHIStatus = patient.IHIStatus;
    patientIHIData.User = "Local Software User";
    patientIHIData.UserHPI = "HPI if available";
    patientIHIData.HIService = "e.g. IHI Lookup";
    patientIHIData.HPIO = "HPI-O";
    patientIHIData.HIService_Operation = HI_WebService_NAME;
    patientIHIData.HIService_Version = HI_WebService_Version;
    patientIHIData.HIServiceMessageID = "HI Message ID";

    patient.PatientIHIHistory.Add(patientIHIData);
    _patientRepo.SavePatient(patient);
}

1-ihi-app-config-screenshot.png

private readonly static string HI_WebService_NAME =     ConfigurationManager
        .AppSettings.Get("WebServiceName");

private readonly static string HI_WebService_Version =  ConfigurationManager
        .AppSettings.Get("WebServiceVersion");

Full SOAP Web service response

<?xml version="1.0" encoding="UTF-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Header><wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">http://ns.electronichealth.net.au/hi/svc/ConsumerSearchIHI/3.0/ConsumerSearchIHIPortType/searchIHIResponse</wsa:Action><wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">urn:uuid:fd8b53c3-80fa-49c6-b99b-e891d347bcc0</wsa:MessageID><wsa:RelatesTo xmlns:wsa="http://www.w3.org/2005/08/addressing" RelationshipType="http://www.w3.org/2005/08/addressing/reply">urn:uuid:43098eb6-9696-4b61-8e6c-1d9cfed5b6f3</wsa:RelatesTo><wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing">http://www.w3.org/2005/08/addressing/anonymous</wsa:To><audit:product xmlns:audit="http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0"><audit:vendor><qid:qualifier xmlns:qid="http://ns.electronichealth.net.au/hi/xsd/common/QualifiedIdentifier/3.0">http://ns.medicareaustralia.gov.au/distinguishedname/1.0</qid:qualifier><qid:id xmlns:qid="http://ns.electronichealth.net.au/hi/xsd/common/QualifiedIdentifier/3.0">CN=Medicare Australia :6278034019,O=Medicare Australia,L=TUGGERANONG,ST=ACT,C=AU</qid:id></audit:vendor><audit:productName>HI</audit:productName><audit:productVersion>1.0</audit:productVersion><audit:platform>MedicareAustralia</audit:platform></audit:product><audit:signature xmlns:audit="http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0" xmlns:qid="http://ns.electronichealth.net.au/hi/xsd/common/QualifiedIdentifier/3.0"><Signature xmlns="http://www.w3.org/2000/09/xmldsig#" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/><Reference URI="#Id-eb7cacc2-8f31-4ea2-ae7d-e891d347a103"><Transforms><Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/></Transforms><DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>D9IEYD8kyNn6/onXUr8opgKk3Y4=</DigestValue></Reference></SignedInfo><SignatureValue>EEpKm9Wt2EXTUEsoiSiGZCFiu4y5aKFaUQnf9VGE0iPNrqeCtSPn1zBTeQNtT/NjL2hDgFfkof7Yl/9PPJcCSE7U8h6tBg7MJgoparjyPqtbsdyNg3lGvOVGWduvZFWQQZ2o+D1YydVEG335WJUQCJMSvnFDNw0Rt/eUUSoYqIx4OI2/KTNZ4izqTtEo8JdF25BIDEDKT+mGcXJlqQ3NYXmBboB9f8EFgh2WveO4kQYCv6KBsA69pwgRCG1t+Wv8x45b0WSYBCp4gBW5XSOU8kQNX67kJ6EmKJnzvIozqeWEdSM5bmt2+t8/Hg9FLuzaekly0ReD+4OEGWyPKivnZg==</SignatureValue><ds:KeyInfo xmlns="" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:X509Data><ds:X509Certificate>MIIFyTCCBLGgAwIBAgIDBsExMA0GCSqGSIb3DQEBBQUAMH8xCzAJBgNVBAYTAkFVMQwwCgYDVQQKEwNHT1YxGzAZBgNVBAsTEk1lZGljYXJlIEF1c3RyYWxpYTFFMEMGA1UEAxM8VGVzdCBNZWRpY2FyZSBBdXN0cmFsaWEgT3JnYW5pc2F0aW9uIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTE4MDcxODA2MTkwNFoXDTIyMDMwNTAwNTQxMFowfDELMAkGA1UEBhMCQVUxDDAKBgNVBAgTA0FDVDEUMBIGA1UEBxMLVFVHR0VSQU5PTkcxGzAZBgNVBAoTEk1lZGljYXJlIEF1c3RyYWxpYTEsMCoGA1UEAxMjVGVzdCBNZWRpY2FyZSBBdXN0cmFsaWEgOjk0MjE4NzAzNTQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCph8PA14r2K0TMy9efrpT9adscGcj374/Dzvu2H/csqILusHjsB/d7TnVVV7D6StWCxYn/kf2wuZMFdkrEdCjsSHfbTHPGgtFPcxunorYTPHEtSe5p0dp/IZML7tUCiK48ywOTipDZ/Xiyxokt2bVjnq5AAe1WWou5ZJYJ+E7D7v6aRD/SwDQXoq/D/iq9Prg9lYzeXFnKgCfsLuKQiEweU6GVSy/S4uT6i0U91k605vbIV5HtSIDuzLikZaYD6uUDB/pK8l2h8CpkxlKvtLYZxOskKfzopgrWse/ZC73e+1CBTd4FjuGXU6xm8suybxD1gOpqogY4gXCyJHh11uNrAgMBAAGjggJPMIICSzAMBgNVHRMBAf8EAjAAMB8GA1UdEQQYMBaBFGVidXMudGVzdEBoaWMuZ292LmF1ME8GCCsGAQUFBwEBBEMwQTA/BggrBgEFBQcwAYYzaHR0cDovL29jc3AuY2VydGlmaWNhdGVzLWF1c3RyYWxpYS5jb20uYXUvbWFvY2EucGt4MBkGCSoko5CVFwHOGQQMFgo5NDIxODcwMzU0MIIBIQYDVR0gBIIBGDCCARQwggEQBgoqJNL+gHcBBAIBMIIBADCBywYIKwYBBQUHAgIwgb4agbtDZXJ0aWZpY2F0ZXMgaXNzdWVkIHVuZGVyIHRoaXMgQ1AgbXVzdCBvbmx5IGJlIHJlbGllZCBvbiBieSBlbnRpdGllcyB3aXRoaW4gdGhlIENvbW11bml0eSBvZiBJbnRlcmVzdCwgdW5sZXNzIG90aGVyd2lzZSBhZ3JlZWQsIGFuZCBub3QgZm9yIHB1cnBvc2VzIG90aGVyIHRoYW4gdGhvc2UgcGVybWl0dGVkIGJ5IHRoaXMgQ1AuMDAGCCsGAQUFBwIBFiRodHRwOi8vd3d3Lm1lZGljYXJlYXVzdHJhbGlhLmdvdi5hdS8wDgYDVR0PAQH/BAQDAgeAMBMGA1UdIwQMMAqACECvQwoiM+vJMFEGA1UdHwRKMEgwRqBEoEKGQGh0dHA6Ly9tYXRlc3QuY2VydGlmaWNhdGVzLWF1c3RyYWxpYS5jb20uYXUvVGVzdE1BT0NBL2xhdGVzdC5jcmwwEQYDVR0OBAoECEl266/wkvKQMA0GCSqGSIb3DQEBBQUAA4IBAQBJhbptvpSumSoipJhbQYDgGaHjb684BGh1ozzyNM8wDorxaxmEAVGZxfFf2nkNhKcLL4DTbcz2uvAiLfS4LsHaJiU7DpgdCTkQbcaXszTMPt3pKZ9xV/GqQqhbLa/e2/HzxlcLIbx2ELBn6ywVW9W2PkGQOLJdiIa8upe1KoSegzid5qjaIoZYdig4HC6HYTjkvgYR4xNT4AGQbUBs13QMnxQuvT67jNp8vFMJNYkydo7ZW/WEIVnBo+rneKisml+Bg2980kxF8bhyraTgHoQfS3DovBEvQU4fx/AhC12kb+uy3Ne0ghYcycmfl4rsdOIydFX/VJwcg6rCzoXzZnoH</ds:X509Certificate></ds:X509Data></ds:KeyInfo></Signature></audit:signature></soap12:Header><soap12:Body xml:id="Id-eb7cacc2-8f31-4ea2-ae7d-e891d347a103"><consWSDL:searchIHIResponse xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:consWSDL="http://ns.electronichealth.net.au/hi/svc/ConsumerSearchIHI/3.0"><out4:searchIHIResult xmlns:out4="http://ns.electronichealth.net.au/hi/xsd/consumermessages/SearchIHI/3.0"><out2:ihiNumber xmlns:out2="http://ns.electronichealth.net.au/hi/xsd/consumercore/ConsumerCoreElements/3.0">http://ns.electronichealth.net.au/id/hi/ihi/1.0/8003602345688629</out2:ihiNumber><out2:medicareCardNumber xmlns:out2="http://ns.electronichealth.net.au/hi/xsd/consumercore/ConsumerCoreElements/3.0">2950163041</out2:medicareCardNumber><out2:ihiRecordStatus xmlns:out2="http://ns.electronichealth.net.au/hi/xsd/consumercore/ConsumerCoreElements/3.0">Verified</out2:ihiRecordStatus><out2:ihiStatus xmlns:out2="http://ns.electronichealth.net.au/hi/xsd/consumercore/ConsumerCoreElements/3.0">Active</out2:ihiStatus><out:givenName xmlns:out="http://ns.electronichealth.net.au/hi/xsd/common/IndividualNameCore/3.0">SYLVESTER</out:givenName><out:familyName xmlns:out="http://ns.electronichealth.net.au/hi/xsd/common/IndividualNameCore/3.0">STALLONE</out:familyName><out5:dateOfBirth xmlns:out5="http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0">1968-05-12</out5:dateOfBirth><out5:sex xmlns:out5="http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0">M</out5:sex></out4:searchIHIResult></consWSDL:searchIHIResponse></soap12:Body></soap12:Envelope>

Use Case 015 (UC.015) – Update the Patient Record

In this guide, we will demonstrate some Test Cases which are applicable to UC.015, updating a patient in your local system. To see to all test cases related to update patient, please click here.
The following is an example of a Test Case which has the same requirement covered by a Test Case for UC.010. If you have addressed that Test Case, no action should be needed.

Code Example

This code demonstrates the 16 number digit check using C# regular expression.

public bool VerifyIHINumber(string ihiNumber)
{
    var match = Regex.Match(ihiNumber, @"800360\d{10}");
    return match.Success;
}

Demo screenshot shows when a patient is being updated, user can enter IHI number manually and revalidate.

1-ihi-update-patient-screenshot.jpg

// ------------------------------------------------------------------------------
// Client instantiation and invocation
// ------------------------------------------------------------------------------

// Instantiate the client
ConsumerSearchIHIClient client = new ConsumerSearchIHIClient(
    new Uri("https://www5.medicareaustralia.gov.au/cert/soap/services/"),
    product,
    user,
    hpio,
    signingCert,
    tlsCert);

// Set up the request IHI
searchIHI request = new searchIHI();
request.ihiNumber = "http://ns.electronichealth.net.au/id/hi/ihi/1.0/" + patient.IHINumber;
request.dateOfBirth = DateTime.Parse(patient.DOB);
//request.givenName = "Emily";
request.familyName = patient.FamilyName;
request.sex = SexType.M;

try
{
    // Invokes a basic search
    searchIHIResponse ihiResponse = client.BasicSearch(request);
    string ihiNumber = ihiResponse.searchIHIResult.ihiNumber;

    // Check IHI is resolved, and new IHI has been returned.
    if (ihiResponse.searchIHIResult.serviceMessages.serviceMessage[0].code == "01611")
    {
        // verify returned demographics with local data. 

        var returndPatientData = new Patient()
        {
            FamilyName = ihiResponse.searchIHIResult.familyName,
            GivenName = ihiResponse.searchIHIResult.givenName,
            DOB = ihiResponse.searchIHIResult.dateOfBirth.ToString()
            // Other patient info
        };

        if (ValidatedWithLocalData(patient, returndPatientData))
        {
            // Move old IHI into Patient record history with resolved status.
            // Save Patient data with new returned IHI
        }
        else
        {
            // If new IHI cannot be validated with the local patient data, then alert user.
            DialogResult dialogResult = MessageBox.Show("HI returns with resolved status, with new IHI " + ihiNumber + ", but demographics cannot be validated with local data.", "IHI Resolved", MessageBoxButtons.YesNoCancel,MessageBoxIcon.Exclamation);
            // Give option to operator and determine what action should be taken.
        }
    }
}
catch (FaultException fex)
{
    string returnError = "";
    MessageFault fault = fex.CreateMessageFault();

    if (fault.HasDetail)
    {
        ServiceMessagesType error = fault.GetDetail<ServiceMessagesType>();

        //error.serviceMessage.
        // Look at error details in here
        if (error.serviceMessage.Length > 0)
            returnError = error.serviceMessage[0].code + ": " + error.serviceMessage[0].reason;
    }

    // If an error is encountered, client.LastSoapResponse often provides a more
    // detailed description of the error.
    string soapResponse = client.SoapMessages.SoapResponse;
    txtSoapResponse.Text = soapResponse;
}
catch (Exception ex)
{
    // handle any errors.
}

The following is the SOAP response body in which the HI Service returned “01611” as the service message code with the new IHI number.

<soap12:Body xml:id="Id-c075083e-280b-40ec-acec-e891d347561f">
    <consWSDL:searchIHIResponse
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:consWSDL="http://ns.electronichealth.net.au/hi/svc/ConsumerSearchIHI/3.0">
        <out4:searchIHIResult
            xmlns:out4="http://ns.electronichealth.net.au/hi/xsd/consumermessages/SearchIHI/3.0">
            <out2:ihiNumber
                xmlns:out2="http://ns.electronichealth.net.au/hi/xsd/consumercore/ConsumerCoreElements/3.0">http://ns.electronichealth.net.au/id/hi/ihi/1.0/8003601240025671
            </out2:ihiNumber>
            <out2:ihiRecordStatus
                xmlns:out2="http://ns.electronichealth.net.au/hi/xsd/consumercore/ConsumerCoreElements/3.0">Verified
            </out2:ihiRecordStatus>
            <out2:ihiStatus
                xmlns:out2="http://ns.electronichealth.net.au/hi/xsd/consumercore/ConsumerCoreElements/3.0">Active
            </out2:ihiStatus>
            <out:givenName
                xmlns:out="http://ns.electronichealth.net.au/hi/xsd/common/IndividualNameCore/3.0">ARTHUR
            </out:givenName>
            <out:familyName
                xmlns:out="http://ns.electronichealth.net.au/hi/xsd/common/IndividualNameCore/3.0">MORSE
            </out:familyName>
            <out5:dateOfBirth
                xmlns:out5="http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0">2000-12-12
            </out5:dateOfBirth>
            <out5:sex
                xmlns:out5="http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0">M
            </out5:sex>
            <out5:serviceMessages
                xmlns:out5="http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0">
                <out5:highestSeverity>Informational</out5:highestSeverity>
                <out5:serviceMessage>
                    <out5:code>01611</out5:code>
                    <out5:severity>Informational</out5:severity>
                    <out5:reason>(INFORMATION) This IHI record is a duplicate IHI record that has been resolved to IHI number 8003601240025671.</out5:reason>
                </out5:serviceMessage>
            </out5:serviceMessages>
        </out4:searchIHIResult>
    </consWSDL:searchIHIResponse>
</soap12:Body>

This code example demonstrates how to handle the IHI status responses returned by the HI Service. When IHI lookup request is made for validation. It raises a fault exception when the status is “Retired”

1-ihi-update-patient-ihi-status-screenshot.jpg

try
            {
                // Invokes a basic search
                searchIHIResponse ihiResponse = client.BasicSearch(request);

                txtIHINumber.Text = ihiResponse.searchIHIResult.ihiNumber;
                txtIHIStatus.Text = ihiResponse.searchIHIResult.ihiStatus.ToString();
                txtRecordStatus.Text = ihiResponse.searchIHIResult.ihiRecordStatus.ToString();

                switch (ihiResponse.searchIHIResult.ihiStatus.ToString())
                {
                    case "Deceased":
                        MessageBox.Show("Deceased", "", MessageBoxButtons.OK, MessageBoxIcon.Information);
                        break;
                    case "Expired":
                        MessageBox.Show("Expired", "", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
                        break;

                    default:
                        MessageBox.Show("Nothing has been changed.");
                        break;
                }

            }
            catch (FaultException fex)
            {
                string returnError = "";
                MessageFault fault = fex.CreateMessageFault();

                if (fault.HasDetail)
                {
                    ServiceMessagesType error = fault.GetDetail<ServiceMessagesType>();

                    //error.serviceMessage.
                    // Look at error details in here
                    if (error.serviceMessage.Length > 0)
                        returnError = error.serviceMessage[0].code + ": " + error.serviceMessage[0].reason;
                }

                if (returnError.Contains("Retired"))
               {
                  DialogResult dialogResult = MessageBox.Show("The patient’s IHI status is flagged as ‘Retired’ meaning the patient has been flagged as deceased in the HI Service.", "Patient IHI Status", MessageBoxButtons.OK, MessageBoxIcon.Warning);
            // Save new status. 

               }                
                txtError.Text = returnError;

                // If an error is encountered, client.LastSoapResponse often provides a more
                // detailed description of the error.
                string soapResponse = client.SoapMessages.SoapResponse;
                txtSoapResponse.Text = soapResponse;

            }

Conclusion

You should now be familiar with the web services, use cases, and test cases for conducting IHI Lookups with a goal towards using them to uniquely identify patients. This functionality is important for many aspects of Digital Health such as Secure Messaging, Electronic Prescribing and the My Health Record system.

In the next guide we will verify the healthcare professionals who are being setup in your system by validating their HPI-Is.

View All | Back | Next: Search for HPI-I - HI Service Developer Guide 3