Instructions on Using the Postman Collection for PH CDI IG

The provided Postman collection includes several API endpoints for interacting with resources within the PHCDI. Follow these steps to use the collection:

Step 1: Import the Collection

  1. Open Postman.
  2. Click on the Import button in the top-left corner.
  3. Drag and drop the Sample API call for PH CDI IG.postman_collection.json file or browse and upload it manually.

Step 2: Setup Authentication

  1. Each request in the collection uses Basic Authentication.
  2. Update the following credentials in the Authorization tab for each request:
    • Username: *******
    • Password: *******

⚠️ Ensure you have the correct credentials before proceeding.

Step 3: Explore the API Requests

The collection includes various API requests to interact with FHIR resources like Person, Patient, and QuestionnaireResponse. Below is a summary:

1. POST Person

  • Description: Creates a new Person resource with details like name, address, birth date, and gender.
  • URL: https://fhir.simplifier.net/Implementation-Guide-for-NHDR/Person
  • Payload: Example JSON body provided in the request.

2. POST Patient

  • Description: Creates or updates a Patient resource with attributes such as identifiers, managing organization, and next-of-kin.
  • URL: https://fhir.simplifier.net/Implementation-Guide-for-NHDR/Patient

3. POST QuestionnaireResponse

  • Description: Submits responses to a questionnaire, e.g., PhilHealth membership or health institution referrals.
  • URL: https://fhir.simplifier.net/Implementation-Guide-for-NHDR/QuestionnaireResponse

4. POST Bundle

  • Description: Batch updates multiple resources (e.g., Person, Encounter, Organization) in one request.
  • URL: https://fhir.simplifier.net/Implementation-Guide-for-NHDR/

Review each request’s JSON payload in the Body section for details.

Step 4: Modify Payloads

  1. Click on the Body tab of any request.
  2. Modify the example JSON payloads to reflect the specific data you want to send (e.g., updating patient information or organization details).

Step 5: Send Requests

  1. Click Send to execute a request.
  2. Review the response in the Body section of Postman to ensure successful execution.

Step 6: Verify API Responses

  • Look for HTTP status codes:
    • 200 OK or 201 Created: Indicates success.
    • 400 Bad Request: Indicates invalid input.
    • 401 Unauthorized: Indicates incorrect credentials.

Step 7: Save Responses (Optional)

  • Use the Save Response button in Postman to archive API responses for documentation or further analysis.

Additional Tips

  1. Environment Variables:
    • Configure Postman environment variables for common settings like baseURL to streamline testing.
  2. Error Handling:
    • Review the response body for details if an error occurs.
  3. Security:
    • Avoid sharing sensitive credentials or JSON payloads.

The collection is available in: Link