User Profile Requirements

b.well requires specific user demographic information to create and manage user profiles within the platform. This data can be provided either in the ID token from your Identity Provider during authentication or collected by your application and submitted to b.well through the updateUserProfile mutation.

User profile data follows the FHIR Person resource structure.

Required Demographics

The following fields are required to create a user profile in b.well:

Field	Type	Required	Description
`name.given`	String	Yes	First Name
`name.family`	String	Yes	Last Name
`birthDate`	String	Yes	Date of Birth (YYYY-MM-DD format

Additional Demographics

The following fields are recommended and may be required for specific b.well functionality:

Field	Type	Description
`telecom[].system`	String	Contact type (`email` or `phone`)
`telecom[].value`	String	Contact value (email address or phone number)
`telecom[].use`	String	Contact usage type (`home` or `mobile`)
`address.line`	String	Street address
`address.city`	String	City
`address.state`	String	State code (2-letter abbreviation)
`address.postalCode`	String	ZIP / Postal code
`gender`	String	Sex at birth

Note: At least one telecom entry (phone or email) is recommended.

How Demographics Are Provided

Option 1: ID Token Claims

During authentication, your Identity Provider can include demographic information in the ID token's claims. b.well automatically extracts this information when processing the OAuth 2.0 Token Exchange.

Supported ID token claims:

given_name → maps to name.given
family_name → maps to name.family
birthdate → maps to birthDate
email → maps to telecom[].value (system: email)
phone_number → maps to telecom[].value (system: phone)
address → maps to address fields
gender → maps to gender

Option 2: Application-Collected Data

Your application can collect demographic information and submit it to b.well using the User Profile methods.