Uncategorized > JSON Web Token Field Summary
Uncategorized

JSON Web Token Field Summary

Fields

Show Required Fields OnlyShow Translation Fields

  • iss (Required)
    • String
    • Reliable
    • Issuer. This will be the source responsible for the assertion.
  • sub (Required)
    • String
    • Reliable
    • Subject Identifier. A locally unique and never reassigned identifier for the End-User, which is intended to be consumed by the Client.
      The sub value is a case sensitive string.
  • aud (Required)
    • String
    • Reliable
    • Audience(s) that this token is intended for. This will be your SSO destination.
  • exp (Required)
    • Number
    • Reliable
    • Expiration time on or after which the ID Token MUST NOT be accepted for processing. The processing of this parameter requires that the current date/time MUST be before the expiration date/time listed in the value. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
      Typically we send date/times in ISO 8601 but this is sent as an epoch to stay compatible with JWT.
  • iat (Required)
    • Number
    • Reliable
    • Time at which the JWT was issued. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
      Typically we send date/times in ISO 8601 but this is sent as an epoch to stay compatible with JWT.
  • name
    • String
    • Probable
    • 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.
  • given_name
    • String
    • Probable
    • 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.
  • family_name
    • String
    • Probable
    • 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.
  • middle_name
    • String
    • Probable
    • 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.
  • email
    • String
    • Probable
    • 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.
  • npi
    • String
    • Probable
    • End-User’s NPI number. Note that not all providers will have an NPI number.
  • zoneinfo
    • String
    • Probable
    • String from IANA time zone database representing the End-User’s time zone. For example, Europe/Paris or America/Los_Angeles.
  • locale
    • String
    • Probable
    • 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.
  • phone_number
    • String
    • Probable
    • 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.
  • patient_ids
    • Array
    • Probable
    • An array of identifiers for the patient.
      Not all SSO sessions will have a Patient context attached.
      • patient_ids[].id – String – Probable – The identifier.
      • patient_ids[].id_type – String – Probable – The type of the identifier. For example, MRN.
  • visit_id
    • String
    • Probable
    • An identifier indicating the current visit that the SSO context is happening in.
  • facility_id
    • String
    • Probable
    • The facility that the user is currently logged in to.
      Facility represents different physical locations of a health system, for example Main Hospital vs. Diabetes Clinic.
  • department_id
    • String
    • Probable
    • The department where the user is currently logged in.
      A facility can contain multiple departments. For example, a hospital may have a physical therapy department and a radiology department.