7. Publish your organization on iPhone and iPad
After Apple approves your FHIR API endpoint (as previously described), the information about that endpoint, such as its brand and locations, is ready to be published on the Health app. You can do any of the following:
Allow the information to be published automatically 3 days after Apple’s approval of the FHIR API endpoint.
Schedule the publication to occur within the next 30 days.
Important: If you take no action, your organization and FHIR API endpoint will be published automatically 3 days after Apple sends you the approval email.
As previously described in Preview your organization on iPhone, it’s recommended that you preview how your organization appears in the Health app before you allow publication. As described below, it’s also recommended that you finalize any plans you’ve made for your patient communications before you allow publication.
None of the tasks described on this page are required. After Apple grants approval, your organization and FHIR API endpoint will be published regardless of whether you perform these tasks.
Optional: Schedule publication to occur within 30 days
To postpone publication while you finalize your patient plans or complete your operational readiness, do the following:
Go to the FHIR API Profile screen for the endpoint.
Click Publish Later at the top right, then follow the onscreen instructions.
You can reschedule publication as often as you like.
Recommended: Finalize your patient communication plans
When Apple sends you the email that your organization and FHIR API endpoint are approved, Apple also sends you and your marketing contact an email that includes:
Guidelines for communications with your staff and patients
Guidelines for preparing a press release about your participation in Health Records
A link to marketing materials, including image files, templates, and other collateral, that you can use to promote your participation in Health Records
Note: This link to marketing materials also becomes available on the FHIR API Profile screen.
It’s recommended that you and relevant stakeholders across your organization review the guidelines and marketing material before distributing information about the availability of your patients’ health records.
Important: If you plan to make public announcements about your organization’s participation in Health Records, Apple requires you to submit them to Apple for review and approval before you make your announcements public. Apple’s review helps ensure consistency in messaging across all participating organizations.
To send your communication materials for review, email them to firstname.lastname@example.org. Allow 1–2 weeks for a response.
Tip: The Marketing Resources section of the FHIR API Profile screen contains a link labeled Deep Link for Your Organization. Click the link and follow the instructions to obtain a QR code that offers a direct link to your organization in the Health app. You can share this QR code—for example, in printed and electronic communications—to help your patients quickly find your organization by scanning the code with their iPhone or iPad camera. (This QR code works only for users in Canada, the United Kingdom, and the United States and requires iOS 11.3, iPadOS 17, or later.)
Optional: Publish immediately
Go to the FHIR API Profile screen for the endpoint.
Click Publish Now at the top right.
It can take up to 60 minutes for your organization to appear in the Health app.
Recommended: Verify your publication
At publication, Apple sends you confirmation that your FHIR API endpoint is available to iPhone and iPad users. It’s recommended that you also verify publication on iPhone and iPad.
On an iPhone or iPad with the latest version of iOS or iPadOS, open the Health app.
Do one of the following:
On an iPhone: Tap the user profile picture or initials at the top right, then tap Health Records. (If you don’t see your profile picture or initials, tap Summary or Browse at the bottom of the screen, then scroll to the top of the screen.)
On an iPad: Tap to expand Health Records in the sidebar. (If you don’t see the sidebar, tap the user profile picture or initials at the top left, then tap Health Records.)
Tap Add Account or Get Started.
To verify that your listing appears, enter any of the following in the search field (tap Cancel after verifying each way):
Your brand name
The city, state, or province name for any of your locations
Each location (if you provided location names for display along with your brand or organization name)
Tap your listing, then tap Connect Account to go to the sign-in screen for your patient portal.
Sign in with a valid user name and password, then follow the onscreen instructions to verify that the account’s records are successfully downloaded.
You can use either your account or the test patient account.
If you detect an issue you want to correct: Go to the FHIR API Profile screen for the endpoint, use the Edit buttons to make changes, click Reviewed at the top right, click Start Test to perform the FHIR API endpoint test again, then click Send for Review. Updates appear in the Health app only after Apple approves the changes you submit.
Recommended: Communicate your publication
Inform your staff that your organization’s health records are now available for your patients to download in the Health app on iPhone and iPad.
Instruct your patients on how to find your organization and sign in to access their health records.
Optional: Publish additional FHIR API endpoints
If your organization supports multiple FHIR API endpoints, do the following:
Sign in to Health Records at Apple Business Register.
Click Add FHIR API endpoint at the top left.
Click Next on the Overview screen.
Repeat the instructions in 1b. List contacts, locations, and brands.
For each FHIR API endpoint you register, repeat the following instructions:
After completing the steps, return to the top of this page, follow the instructions to publish the endpoint, then verify and communicate its publication.