Postman - Get a PatientIdentification

Purpose: Show how to search, “Get”, by Patient Identification to get a patient record. For example, this would be the Patient Identification created by a business system for a patient record they create. This way when searching for the patient, you don’t have to use the Noah patientid to find the patient record in Noah System via the Noah ES API.

 

Precondition:

  • Generate an Access token

 

1.) Post

https://api.qa.eu.noah-es.com/:tenantid/api/Patients/bypatientidentification/:manufacturerCode?identification=ABCD1234&skip=0&take=200

 

I have set variables for tenantid as a variable and manufacturerCode as a variable for this route.

*Note: “x” used as the value for manufacturerCode is not a real value. This would be your company’s manufacturer code

 

2.) Query Parameters

Query Params that need to be set are the 3 below.

  • identification

  • skip

  • take

 

3.) Header

a.) The X-Api-Version needs to be set. At this time 1.0 is the only version, so this is what I have set.

 

4.) Response

{ "skip": 0, "take": 200, "size": 1, "items": [ { "patientId": "e5a941f1-8e26-40b7-9d66-731ceb008182", "legacyPatientId": 10061, "created": null, "updated": null, "patientDate": null, "creatorUserAccountId": "f0d680cb-d880-4e99-9568-6f78936a38e2", "creatorUserInfo": { "userId": "f0d680cb-d880-4e99-9568-6f78936a38e2", "legacyUserId": 3, "idPId": "a9cdc8d9-4c37-418f-9afd-d490d7874ac8" }, "patientNo": "ABCD1234", "firstName": "Test3", "lastName": "Test3", "middleName": null, "gender": null, "birthDate": null, "salutation": null, "title": null, "address1": null, "address2": null, "address3": null, "province": null, "zip": null, "city": null, "country": null, "homePhone": null, "workPhone": null, "ssnumber": null, "emailAddress": null, "insurance1": null, "insurance2": null, "referral": null, "physician": null, "mobilePhone": null, "other1": null, "other2": null, "active": null, "comment": null, "photo": null } ], "links": [ { "rel": "first", "href": "http://api.qa.eu.noah-es.com/de1dbe40-6993-4eb3-ae4a-f87a07a21e3b/api/Patients/bypatientidentification/1?identification=ABCD1234&skip=0&take=200" } ] }