Test your FHIR APIs with Health Records
After applying to be a vendor and accepting the Service Integration Agreement (SIA), you can configure and test your sandbox FHIR APIs using Apple’s automated test harness. This allows you to verify the user experience in the Health app and checks the availability of your FHIR API endpoint and data compliance with FHIR specifications using a test patient.
Note: The steps below apply to technology companies that build FHIR API and EHR platforms. If you represent a healthcare organization wanting to provide health records to your patients, see Prepare to register for Health Records instead.
Set up your sandbox
Sign in to Health Records at Apple Business Register.
Click “Create FHIR API Endpoint” (in blue), provide details of your FHIR API endpoint, then click Submit.
Click Add Test Account at the top right.
Enter a user name and password for a test patient account, then click Done.
Click Start Test, then click Redirect to open your authorization page.
Log in with the credentials for the test patient account, then authorize it. (See Test your FHIR API endpoint for more details.)
Note: If you support scope selection, grant permissions to all resources.
If the test yields errors or doesn’t succeed, click View Test Results, correct all failures, return to the FHIR API Profile screen, then click Start Test to retest.
Tip: While they won’t prevent you from proceeding, fix errors marked as recommendations to ensure the best experience for your customers and their patients.
Preview your sandbox in the Health app
On your test iPhone, go to Settings > General > Language & Region > Region, then set the region to the United States, Canada, or the United Kingdom.
Sign in to Health Records at Apple Business Register.
On your FHIR API Profile screen, click Preview at the top right, then follow the onscreen instructions to scan with the iPhone camera.
Verify the following:
Every supported resource has data.
No data is found in the Unreadable category.
To test your sandbox more fully, repeat all three steps on an iPad.
Submit your test results to Apple
Do one of the following:
If you’re registering as a FHIR API vendor: Click Submit to send your results to Apple for review. Once you receive a confirmation email, your customers can start to register in Health Records. See Prepare to register for Health Records.
If you’re registering as an EHR vendor: You need to run a pilot test. See Connect customers to your EHR vendor platform in Health Records.