Overview

Health Gorilla uses a custom FHIR resource called User for creating patient users and managing the associated UUIDs. The patient user can then be used to open the my360 iframe where the patient can view and retrieve their medical documents.

The create_users scope is required when creating patient users via the User API.

Supported Attributes of User Resource

Attribute	Required	Notes
resourceType	Yes	Will always be "User"
meta	Yes	This field will contain a required profile attribute
active	Yes	Will always be set to "true"
identifier	Yes	Will contain the UUID of the patient
name	Yes	Will contain the name of the patient
telecom	Yes	Will contain the email and phone number of the patient. Phone is optional
address	Yes	Will contain the address of the patient
communication	Yes	Will contain the language preference of the patient
login	Yes	Will contain the login for the user
organization	Yes	Will contain the ID of the IPA facility inside of your tenant in Health Gorilla. (This will be given to you by Health Gorilla)

Creating a Patient User

Creating a UUID for a User

The User resource requires a unique identifier for a patient. This unique identifier is described in the User.identifier object. There is no specification for the unique identifier but should be unique for each patient created. The IPA facility associated with the user’s tenant must be referenced in this attribute.

"identifier": [
        {
            "type": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                        "code": "PRN",
                        "display": "Provider number"
                    }
                ]
            },
            "assigner": {
                "reference": "Organization/f-<IPA Facility ID>"
            },
            "value": "<UUID>"
        }
    ],

Setting the Patient User's Name

The User.name attribute is used to pass the user’s real name to Health Gorilla. The user’s real name is required to create a user account in Health Gorilla.

"name": {
        "text": "<FULL NAME>",
        "family": "<LAST NAME>",
        "given": [
            "<FIRST NAME>"
        ]
    },

Setting the Patient User's Email and Telephone

The User.telecom object is used to pass the user’s email and telephone to Health Gorilla. The user’s email is required. The telephone is optional.

"telecom": [
       {
           "system": "email",
           "value": "<EMAIL ADDRESS>"
       }
   ],

"telecom": [
       {
           "system": "email",
           "value": "<EMAIL ADDRESS>"
       },
       {
           "system": "phone",
           "value": "<TELEPHONE>",
           "use": "mobile"
       }
   ],

Setting the User's Address

The User.address object is used to pass the user’s address to Health Gorilla.

"address": [
   {
       "text": "123 Fake Street,  CA 90402",
     "line": [
       "123 Fake Street"
     ],
     "city": "Monica",
     "state": "CA",
     "postalCode": "90402"
   }
 ],

Connecting the User to the IPA Facility

The User.organization object is used to associate the patient user with the IPA facility setup within your tenant. The facility is set up by Health Gorilla staff and the ID will be given to you.

"organization": [
       {
           "reference": "Organization/f-<IPA FACILITY ID>"
       }
   ]

Patient User Example

{
    "resourceType": "User",
    "meta": {
        "profile": [
            "https://api.healthgorilla.com/fhir/StructureDefinition/User",
            "https://api.healthgorilla.com/fhir/StructureDefinition/user-patient"
        ]
    },
    "active": true,
    "identifier": [
        {
            "type": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                        "code": "PRN",
                        "display": "Provider number"
                    }
                ]
            },
            "assigner": {
                "reference": "Organization/f-f33234a28961ddd9ab1678ff97e6"
            },
            "value": "123321"
        }
    ],
    "name": {
        "text": "Joe Gorilla",
        "family": "Gorilla",
        "given": [
            "Joe"
        ]
    },
    "telecom": [
        {
            "system": "email",
            "value": "[email protected]"
        },
        {
            "system": "phone",
            "value": "(111) 111-1111",
            "use": "mobile"
        }
    ],
    "address": [
   {
       "text": "123 Fake Street,  CA 90402",
     "line": [
       "123 Fake Street"
     ],
     "city": "Monica",
     "state": "CA",
     "postalCode": "90402"
   }
 ],

    "communication": {
        "coding": [
            {
                "system": "urn:ietf:bcp:47",
                "code": "en",
                "display": "English"
            }
        ]
    },
    "login": "[email protected]",
    "organization": [
        {
            "reference": "Organization/f-f33234a28961ddd9ab1678ff97e6"
        }
    ]
}