Postman - Create New Audiogram Action

Purpose: To show how to create an action. In this example it will be an Audiogram action.

I first want to mention there is more than one audiometric data format. There are some that are legacy, pre xml. Below is a link for the different aud data formats.

Audiogram FormatPreview

Secondly, if you look in on the swagger page, under patient actions, at the “Post -/{tenantid}/api/Patients/{patientId}/{sessionId}/action” route you will see dataFmtStd. With this you determine what format you want to save the data as. So, if you want to save the aud data as 500, you would do this "dataFmtStd": 500. It is up to you what format you want the data in. The link above will show you the different formats. *Note: The Noah ES API will only save xml formats. So you can save the data as format 500 or format 502.

Preconditions:

• Remember to create your new access token. https://himsanoah.atlassian.net/wiki/spaces/~977867606/pages/3460169759

• Create a new session for the patient

1.) Creating the Post Audiogram Action Route

The API has multiple requirements for this get route.

• Variables

• Headers

• Body

The path for Post Audiogram Action:

Open

A.) Path Variables: See Picture Below

1.) :tennantid = {{tennantid}}

2.) :patientId = {{patientId}}

3.) sessionId = {{sessionId}}

Open

B.) Headers: See Pictures Below

The X-Api-Version needs to be set. At this time 1.0 is the only version, so this is what I have set. You also need to have an X-Idempotent-ID header.

Open

C.) Body: See Pictures Below

*Note: Your audiometric data is xml data that is base 64 encoded.

Open

Body - Entire Body for this example For more details see Swagger.

2.) Sending the Post Audiogram Action Route

Go to the Authorization tab and select the token you created as a precondition above and select “Send.”

Open

3.) Results

a.) You should see a Status: 200 OK.

Open

• If you do not, Check the error code in Swagger by expanding the patientactions and scrolling down to the return values. https://api.qa.eu.noah-es.com/swagger/index.html

• Note: It might be helpful to check the Console too. It is located at the bottom, of Postman on the lower left corner. The picture below shows where to find the option to select and open the console.

b.) Successful results for the return body like this. See picture below.

Open

Full Return Body

c.) Picture of Audiogram in Noah ES Client

Open