DateTime

DateTime of the event.
ISO 8601 Format

Boolean

Flag as a test message

String

Where the message originated.
Included in messages from Redox

String

ID of the source.
UUID

String

Name of the source

String

Session ID to be passed through for 3rd party sessions.
This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.

String

The Base URL to use when issuing Redox FHIR queries within the SSO session context.
See our docs on SMART via Redox for more details on how to use this field.

Array of Objects

List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox

String

ID of the destination.
UUID

String

Name of the destination

String

Code for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

String

End-User's user identification, the logical entity used to identify a user on a software, system, or websites.

String

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

String

Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

String

Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

String

Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.

String

End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. This field is not guaranteed to be unique.

String

End-User's NPI number. Note that not all providers will have an NPI number.

String

The provider specialty. Note that not all providers will have a specialty.

String

String from IANA time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.

String

End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.

String

End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.

Array

An array of identifiers for the patient.
Not all SSO sessions will have a Patient context attached.

String

The identifier.

String

The type of the identifier.
For example, MRN.

String

First Name of the Patient

String

Last Name of the Patient

String

Middle Name of the Patient

String

Date of birth of the Patient

String

Patient's Sex

String

Patient's home phone number.
In E. 164 Format. (e.g. +16085551234)

String

Patient's office phone number.
In E. 164 Format. (e.g. +16085551234)

String

Patient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Number for the visit

Object

Location of the visit.

String

Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility.
Example: Community Hospital

Array of Objects

List of IDs specific to this facility

String

An ID specific to this facility

String

The source or system to which this ID pertains.
Could be an OID or a human-readable name

String

Department

Array of Objects

List of IDs specific to this department

String

An ID specific to this department

String

The source or system to which this ID pertains.
Could be an OID or a human-readable name

String

Room.
Example: 136

String

ID of the order assigned by the placing system