Postman Collections
Last updated
Last updated
In order to view the reference implementation in action, please send messages to the CDR using one of the following Postman Collections:
The following FHIRâ„¢ API have been established to enable testing:
HIV Bundles: https://openhimcore.qa.disi.gicsandbox.org/fhir
HIV Lab Bundles: https://openhimcore.qa.disi.gicsandbox.org/fhir
The required auth header for all of the above is:
Authorization: Custom test
You can submit data by using the bundles that are available in the Postman Collection but before doing so, it is essential that you first ensure that the request URL is pointing to the appropriate FHIRâ„¢ implementation API.
The request URL can be seen at the top left of each message bundle.
All of the Postman Collections make use of the variable {{openhimURL}} which is used to dynamically set the appropriate FHIRâ„¢ API. You can either replace this variable with the URL you want to use or you can leverage the appropriate Postman Environment to set the openhimURL for you. In order to use a Postman Environment, simply select the appropriate environment on the top right of the Postman application.
Introduction to the bundles in each Postman Collection:
HIV Case Reporting
HIV Case Reporting Submit Bundle: Used to submit patient level HIV case report data to the CDR.
Derived from the HIV Case-Based Surveillance FHIRâ„¢ Implementation Guide.
HIV Program Monitoring
HIV Program Monitoring Submit Bundle: Refers to continuous use of data at patient level to systematically provide high quality services to patients and achieve maximum program impact.
Derived from the HIV Program Monitoring and Patient Care Coordination FHIRâ„¢ Implementation Guide.
HIV Lab Integration
This collection allows you to perform the following key operations individually:
Submit a new lab order for HIV:
[EMR] Submit lab Order Bundle: Submit a request for a new lab order.
Note: Please follow these steps before submitting a lab order request:
First, submit a request using the "HIV Case Reporting Submit Bundle" so that the patient record is created in the Master Patient Index (MPI).
Generate an access_token
using the request titled "Generate SanteMPI access_token" and then copy the text from the JSON response for access_token.
Using the copied access_token
from step 2, paste the text to the authorization section for the request titled "Query Patient (First generate access_token)" using the authorization type of Bearer Token.
Execute the request titled "Query Patient (First generate access_token)".
Using the NID that was specified for the patient during the request in step 1, search for the patient in the JSON response body that was received directly after step 4 was executed.
Search for the object link[]
that is associated with the found patient NID. For example:
Note: The patient identifier as shown in the image above will be used for all lab orders, lab results, and lab rejections.
Make sure that you update your variable value for patientGuid
to match the one found in the link[]
object.
Finally, submit your lab order
Result: an existing lab order for HIV:
[LAB] Submit lab result Bundle: Submit a result for an existing lab order.
Note: Make sure to use the same patient identifier as was used when submitting a lab order.
Reject an existing request for a HIV lab order:
[LAB] Submit lab Rejection: Rejects an existing lab order ServiceRequest
.
Note: Make sure to use the same patient identifier as was used when submitting a lab order.
Cancel an existing request for a HIV lab order:
[LAB] Submit lab Cancellation: Cancels an existing lab order ServiceRequest
.
Note: Make sure to use the same patient identifier as was used when submitting a lab order.
Note: Lab integration has been incorporated into the FHIRâ„¢ Implementation Guides.