1b. List contacts, locations, and brands
If you previously answered that your organization has one FHIR API endpoint, you see the Organization Details screen. If you previously answered that your organization has more than one FHIR API endpoint, you see the FHIR API Endpoint Details screen. Both screens require similar information.
Register your contacts, EHR vendor, and other details
Click the fields to provide the requested information:
EHR Vendor Deployed and Patient Portal URL: Enter the information provided by your EHR vendor.
Contacts: For each contact, click the field to choose yourself (your name and email address are automatically supplied from your Apple Account) or to add a new contact. You can also add or change contacts later. (See Identify who will fill registration roles.)
If you add contacts, assign Administrator privileges only to those who need to change registration information. As you add contacts, Apple sends them email invitations to join you in managing your organization’s registration. All of your contacts with Administrator or Read Only privileges will receive emails from Apple throughout the registration process.
If you have more than one FHIR API endpoint, click these fields to provide the requested information:
FHIR API Endpoint Name: Enter any name that helps you identify this endpoint and distinguish it from the others. For example, you might name one endpoint “Clinic Care records” and another one “Urgent Care records.”
Brand name: Choose the name you previously entered, or click Add New Brand, enter the requested information, then click Done.
The brand name is displayed in the Health app for this FHIR API endpoint. (See Determine how to brand your organization in the Health app.) Your patients don’t see the FHIR API endpoint name.
The Health app Listing Preview displays an image that shows how your information will appear to your patients.
Click Next.
Select a search result display option
Choose how you want to display your organization as a search result in the Health app. The Search Result Preview on the right displays an image that shows how your choice will appear.
To prepare for this task, see Choose how to display your organization in the Health app.
Choose an option:
Brand only: See Determine how to brand your organization in the Health app.
Brand and related brand: To specify the related brand, choose a brand from the list, or click Add New Brand, enter the requested information, then click Done.
Note: If displaying the related brand above the main brand name is preferable for your organization, contact health_records_support@apple.com for assistance.
Brand and location name: See Identify where your patients receive care. Because you haven’t entered a location name yet, the Search Result Preview on the screen doesn’t display a name.
Click Next.
Update your locations or brands, if needed
You can do any of the following on the List Locations and Brands screen:
Add a name to a location: Click the location address in the left column, click Edit, enter the name in the Location Name field, click Done, then click List Locations and Brands at the top left. (See Identify where your patients receive care.)
Change the address for a location: Click the address in the left column, click Edit, make your changes, click Done, then click List Locations and Brands at the top left.
Add a patient care location served by the FHIR API endpoint: Click Add Location, select New Location, supply the requested information, click Done, then click List Locations and Brands at the top left.
Change the brand name or logo: Click the name in the Brand column, click Edit for the Brand Details section, make your changes, click Done, then click List Locations and Brands at the top left. (See Determine how to brand your organization in the Health app and Choose how to display your organization in the Health app.)
Delist or relist a location in the Health app: To delist a location, click in the right column for that location, then click Remove from FHIR API Profile. A delisted location doesn’t appear in the Health app for this FHIR API endpoint. You might delist a location, for example, if it’s the address of your corporate headquarters, if the location isn’t currently open for business, or if the location is associated with another of your organization’s FHIR API endpoints. To list the location again while you’re on the List Locations and Brands screen, click Add Location, select Existing Location, select the location, then click Add Location. (Later, after you finish registering, you can relist a location on the FHIR API profile page. See Delist or relist a location in the Health app.)
Add multiple locations at once: Click “importing a CSV file,” then follow the instructions. (See Add multiple locations simultaneously.)
Remove the location from your application: Click in the right column for that location, then select Delete Location.
Note: You’ll have opportunities to make changes later.
After making any updates to the List Locations and Brands screen, do one of the following:
If you have only one FHIR API endpoint: Click Next, then respond to the Health Records Directory Listing Agreement, as described below.
If you have more than one FHIR API endpoint: Click Submit. A FHIR API Profile screen appears for your review. Do one of the following:
Review the information you provided for this endpoint: Follow the instructions in Review your application.
Register another FHIR API endpoint: To help you coordinate with others in your organization, you may want to complete the registration applications for all of your FHIR API endpoints before publishing any of them.
To register another endpoint, click All FHIR API Endpoints at the top left of the FHIR API Profile screen, then click Add FHIR API Endpoint.
Respond to the Health Records Directory Listing Agreement
If you have a single FHIR API endpoint, the Health Records Directory Listing Agreement appears after you leave the List Locations and Brands screen. A signing authority from your organization is required to review and accept this agreement. (See Identify who will fill registration roles.)
To learn more about the agreement while you review it, click Health Records Directory Listing FAQ. To print the agreement, click Print.
With the agreement onscreen, do one of the following:
Read and accept the terms of the agreement: Select the option that begins with “I accept.”
Note: This action can’t be undone.
Forward the agreement to your organization’s signing authority: Select the option that begins “I am not the signing authority,” then enter the requested information. Advise your signing authority to expect an email from Apple with the subject “Health Records Directory Listing Agreement.”
Continue without accepting the terms of the agreement: Select the option that begins “Skip for now.” You can continue configuring FHIR API endpoint information, but as you’ll see, you won’t be able publish any endpoints until the agreement is accepted.
After you choose one of the three options below the agreement, click Submit, then follow the instructions in Review your application.