Interoperable Digital Identity and Patient Matching, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 3.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-identity-matching-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: OpenID Connect ID Token

Usages:

• This Logical Model is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

• Differential Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
oidc-token		0..*	Base	OpenID Connect ID Token
oidc-token.iss		1..1	uri	Issuer
oidc-token.sub		1..1	string	Subject identifier
oidc-token.aud		1..*	string	Audience identifiers
oidc-token.exp		1..1	decimal	Expiration time as a JWT NumericDate
oidc-token.iat		1..1	decimal	Issued-at time as a JWT NumericDate
oidc-token.nbf		0..1	decimal	Not-before time as a JWT NumericDate
oidc-token.jti		0..1	string	JWT identifier
oidc-token.auth_time		0..1	decimal	Time of end-user authentication as a JWT NumericDate
oidc-token.nonce		0..1	string	Nonce supplied by the relying party
oidc-token.acr		0..1	string	Authentication context class reference
oidc-token.amr		0..*	string	Authentication methods used
oidc-token.azp		0..1	string	Authorized party
oidc-token.at_hash		0..1	string	Access token hash
oidc-token.c_hash		0..1	string	Authorization code hash
oidc-token.name		0..1	string	Full name
oidc-token.given_name		0..1	string	Given name
oidc-token.middle_name		0..1	string	Middle name(s)
oidc-token.family_name		0..1	string	Family name
oidc-token.nickname		0..1	string	Casual name
oidc-token.preferred_username		0..1	string	Preferred username
oidc-token.profile		0..1	uri	Profile page URL
oidc-token.picture		0..1	uri	Profile picture URL
oidc-token.website		0..1	uri	Web page URL
oidc-token.email		0..1	string	Email address
oidc-token.email_verified		0..1	boolean	Whether the email address was verified
oidc-token.gender		0..1	string	Gender
oidc-token.birthdate		0..1	date	Birth date
oidc-token.zoneinfo		0..1	string	Time zone
oidc-token.locale		0..1	string	Locale
oidc-token.phone_number		0..1	string	Phone number
oidc-token.phone_number_verified		0..1	boolean	Whether the phone number was verified
oidc-token.address		0..1	BackboneElement	Postal address
oidc-token.address.formatted		0..1	string	Full formatted address
oidc-token.address.street_address		0..1	string	Street address
oidc-token.address.locality		0..1	string	City or locality
oidc-token.address.region		0..1	string	State, province, or region
oidc-token.address.postal_code		0..1	string	Postal code
oidc-token.address.country		0..1	string	Country
oidc-token.updated_at		0..1	decimal	Time the end-user information was last updated as a JWT NumericDate
oidc-token.verified_claims		0..*	BackboneElement	Verified claims with their verification context
oidc-token.verified_claims.verification		0..1	BackboneElement	Verification context
oidc-token.verified_claims.verification.trust_framework		0..1	string	Trust framework
oidc-token.verified_claims.verification.time		0..1	dateTime	Time of verification
oidc-token.verified_claims.verification.assurance_level		0..1	string	Assurance level
oidc-token.verified_claims.claims		0..1	BackboneElement	Identity claims covered by the verification
oidc-token.verified_claims.claims.given_name		0..1	string	Verified given name
oidc-token.verified_claims.claims.middle_name		0..1	string	Verified middle name(s)
oidc-token.verified_claims.claims.family_name		0..1	string	Verified family name
oidc-token.verified_claims.claims.birthdate		0..1	date	Verified birth date
oidc-token.verified_claims.claims.email		0..1	string	Verified email address
oidc-token.verified_claims.claims.phone_number		0..1	string	Verified phone number
oidc-token.verified_claims.claims.ssn_last4		0..1	string	Proposal-specific claim for the last four SSN digits
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
oidc-token		0..*	Base	OpenID Connect ID Token
oidc-token.iss		1..1	uri	Issuer
oidc-token.sub		1..1	string	Subject identifier
oidc-token.aud		1..*	string	Audience identifiers
oidc-token.exp		1..1	decimal	Expiration time as a JWT NumericDate
oidc-token.iat		1..1	decimal	Issued-at time as a JWT NumericDate
oidc-token.nbf		0..1	decimal	Not-before time as a JWT NumericDate
oidc-token.jti		0..1	string	JWT identifier
oidc-token.auth_time		0..1	decimal	Time of end-user authentication as a JWT NumericDate
oidc-token.nonce		0..1	string	Nonce supplied by the relying party
oidc-token.acr		0..1	string	Authentication context class reference
oidc-token.amr		0..*	string	Authentication methods used
oidc-token.azp		0..1	string	Authorized party
oidc-token.at_hash		0..1	string	Access token hash
oidc-token.c_hash		0..1	string	Authorization code hash
oidc-token.name		0..1	string	Full name
oidc-token.given_name		0..1	string	Given name
oidc-token.middle_name		0..1	string	Middle name(s)
oidc-token.family_name		0..1	string	Family name
oidc-token.nickname		0..1	string	Casual name
oidc-token.preferred_username		0..1	string	Preferred username
oidc-token.profile		0..1	uri	Profile page URL
oidc-token.picture		0..1	uri	Profile picture URL
oidc-token.website		0..1	uri	Web page URL
oidc-token.email		0..1	string	Email address
oidc-token.email_verified		0..1	boolean	Whether the email address was verified
oidc-token.gender		0..1	string	Gender
oidc-token.birthdate		0..1	date	Birth date
oidc-token.zoneinfo		0..1	string	Time zone
oidc-token.locale		0..1	string	Locale
oidc-token.phone_number		0..1	string	Phone number
oidc-token.phone_number_verified		0..1	boolean	Whether the phone number was verified
oidc-token.address		0..1	BackboneElement	Postal address
oidc-token.address.@id		0..1	string	Unique id for inter-element referencing
oidc-token.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.address.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.address.formatted		0..1	string	Full formatted address
oidc-token.address.street_address		0..1	string	Street address
oidc-token.address.locality		0..1	string	City or locality
oidc-token.address.region		0..1	string	State, province, or region
oidc-token.address.postal_code		0..1	string	Postal code
oidc-token.address.country		0..1	string	Country
oidc-token.updated_at		0..1	decimal	Time the end-user information was last updated as a JWT NumericDate
oidc-token.verified_claims		0..*	BackboneElement	Verified claims with their verification context
oidc-token.verified_claims.@id		0..1	string	Unique id for inter-element referencing
oidc-token.verified_claims.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.verified_claims.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.verified_claims.verification		0..1	BackboneElement	Verification context
oidc-token.verified_claims.verification.@id		0..1	string	Unique id for inter-element referencing
oidc-token.verified_claims.verification.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.verified_claims.verification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.verified_claims.verification.trust_framework		0..1	string	Trust framework
oidc-token.verified_claims.verification.time		0..1	dateTime	Time of verification
oidc-token.verified_claims.verification.assurance_level		0..1	string	Assurance level
oidc-token.verified_claims.claims		0..1	BackboneElement	Identity claims covered by the verification
oidc-token.verified_claims.claims.@id		0..1	string	Unique id for inter-element referencing
oidc-token.verified_claims.claims.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.verified_claims.claims.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.verified_claims.claims.given_name		0..1	string	Verified given name
oidc-token.verified_claims.claims.middle_name		0..1	string	Verified middle name(s)
oidc-token.verified_claims.claims.family_name		0..1	string	Verified family name
oidc-token.verified_claims.claims.birthdate		0..1	date	Verified birth date
oidc-token.verified_claims.claims.email		0..1	string	Verified email address
oidc-token.verified_claims.claims.phone_number		0..1	string	Verified phone number
oidc-token.verified_claims.claims.ssn_last4		0..1	string	Proposal-specific claim for the last four SSN digits
Documentation for this format

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

Maturity: 2

Differential View

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
oidc-token		0..*	Base	OpenID Connect ID Token
oidc-token.iss		1..1	uri	Issuer
oidc-token.sub		1..1	string	Subject identifier
oidc-token.aud		1..*	string	Audience identifiers
oidc-token.exp		1..1	decimal	Expiration time as a JWT NumericDate
oidc-token.iat		1..1	decimal	Issued-at time as a JWT NumericDate
oidc-token.nbf		0..1	decimal	Not-before time as a JWT NumericDate
oidc-token.jti		0..1	string	JWT identifier
oidc-token.auth_time		0..1	decimal	Time of end-user authentication as a JWT NumericDate
oidc-token.nonce		0..1	string	Nonce supplied by the relying party
oidc-token.acr		0..1	string	Authentication context class reference
oidc-token.amr		0..*	string	Authentication methods used
oidc-token.azp		0..1	string	Authorized party
oidc-token.at_hash		0..1	string	Access token hash
oidc-token.c_hash		0..1	string	Authorization code hash
oidc-token.name		0..1	string	Full name
oidc-token.given_name		0..1	string	Given name
oidc-token.middle_name		0..1	string	Middle name(s)
oidc-token.family_name		0..1	string	Family name
oidc-token.nickname		0..1	string	Casual name
oidc-token.preferred_username		0..1	string	Preferred username
oidc-token.profile		0..1	uri	Profile page URL
oidc-token.picture		0..1	uri	Profile picture URL
oidc-token.website		0..1	uri	Web page URL
oidc-token.email		0..1	string	Email address
oidc-token.email_verified		0..1	boolean	Whether the email address was verified
oidc-token.gender		0..1	string	Gender
oidc-token.birthdate		0..1	date	Birth date
oidc-token.zoneinfo		0..1	string	Time zone
oidc-token.locale		0..1	string	Locale
oidc-token.phone_number		0..1	string	Phone number
oidc-token.phone_number_verified		0..1	boolean	Whether the phone number was verified
oidc-token.address		0..1	BackboneElement	Postal address
oidc-token.address.formatted		0..1	string	Full formatted address
oidc-token.address.street_address		0..1	string	Street address
oidc-token.address.locality		0..1	string	City or locality
oidc-token.address.region		0..1	string	State, province, or region
oidc-token.address.postal_code		0..1	string	Postal code
oidc-token.address.country		0..1	string	Country
oidc-token.updated_at		0..1	decimal	Time the end-user information was last updated as a JWT NumericDate
oidc-token.verified_claims		0..*	BackboneElement	Verified claims with their verification context
oidc-token.verified_claims.verification		0..1	BackboneElement	Verification context
oidc-token.verified_claims.verification.trust_framework		0..1	string	Trust framework
oidc-token.verified_claims.verification.time		0..1	dateTime	Time of verification
oidc-token.verified_claims.verification.assurance_level		0..1	string	Assurance level
oidc-token.verified_claims.claims		0..1	BackboneElement	Identity claims covered by the verification
oidc-token.verified_claims.claims.given_name		0..1	string	Verified given name
oidc-token.verified_claims.claims.middle_name		0..1	string	Verified middle name(s)
oidc-token.verified_claims.claims.family_name		0..1	string	Verified family name
oidc-token.verified_claims.claims.birthdate		0..1	date	Verified birth date
oidc-token.verified_claims.claims.email		0..1	string	Verified email address
oidc-token.verified_claims.claims.phone_number		0..1	string	Verified phone number
oidc-token.verified_claims.claims.ssn_last4		0..1	string	Proposal-specific claim for the last four SSN digits
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
oidc-token		0..*	Base	OpenID Connect ID Token
oidc-token.iss		1..1	uri	Issuer
oidc-token.sub		1..1	string	Subject identifier
oidc-token.aud		1..*	string	Audience identifiers
oidc-token.exp		1..1	decimal	Expiration time as a JWT NumericDate
oidc-token.iat		1..1	decimal	Issued-at time as a JWT NumericDate
oidc-token.nbf		0..1	decimal	Not-before time as a JWT NumericDate
oidc-token.jti		0..1	string	JWT identifier
oidc-token.auth_time		0..1	decimal	Time of end-user authentication as a JWT NumericDate
oidc-token.nonce		0..1	string	Nonce supplied by the relying party
oidc-token.acr		0..1	string	Authentication context class reference
oidc-token.amr		0..*	string	Authentication methods used
oidc-token.azp		0..1	string	Authorized party
oidc-token.at_hash		0..1	string	Access token hash
oidc-token.c_hash		0..1	string	Authorization code hash
oidc-token.name		0..1	string	Full name
oidc-token.given_name		0..1	string	Given name
oidc-token.middle_name		0..1	string	Middle name(s)
oidc-token.family_name		0..1	string	Family name
oidc-token.nickname		0..1	string	Casual name
oidc-token.preferred_username		0..1	string	Preferred username
oidc-token.profile		0..1	uri	Profile page URL
oidc-token.picture		0..1	uri	Profile picture URL
oidc-token.website		0..1	uri	Web page URL
oidc-token.email		0..1	string	Email address
oidc-token.email_verified		0..1	boolean	Whether the email address was verified
oidc-token.gender		0..1	string	Gender
oidc-token.birthdate		0..1	date	Birth date
oidc-token.zoneinfo		0..1	string	Time zone
oidc-token.locale		0..1	string	Locale
oidc-token.phone_number		0..1	string	Phone number
oidc-token.phone_number_verified		0..1	boolean	Whether the phone number was verified
oidc-token.address		0..1	BackboneElement	Postal address
oidc-token.address.@id		0..1	string	Unique id for inter-element referencing
oidc-token.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.address.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.address.formatted		0..1	string	Full formatted address
oidc-token.address.street_address		0..1	string	Street address
oidc-token.address.locality		0..1	string	City or locality
oidc-token.address.region		0..1	string	State, province, or region
oidc-token.address.postal_code		0..1	string	Postal code
oidc-token.address.country		0..1	string	Country
oidc-token.updated_at		0..1	decimal	Time the end-user information was last updated as a JWT NumericDate
oidc-token.verified_claims		0..*	BackboneElement	Verified claims with their verification context
oidc-token.verified_claims.@id		0..1	string	Unique id for inter-element referencing
oidc-token.verified_claims.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.verified_claims.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.verified_claims.verification		0..1	BackboneElement	Verification context
oidc-token.verified_claims.verification.@id		0..1	string	Unique id for inter-element referencing
oidc-token.verified_claims.verification.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.verified_claims.verification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.verified_claims.verification.trust_framework		0..1	string	Trust framework
oidc-token.verified_claims.verification.time		0..1	dateTime	Time of verification
oidc-token.verified_claims.verification.assurance_level		0..1	string	Assurance level
oidc-token.verified_claims.claims		0..1	BackboneElement	Identity claims covered by the verification
oidc-token.verified_claims.claims.@id		0..1	string	Unique id for inter-element referencing
oidc-token.verified_claims.claims.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
oidc-token.verified_claims.claims.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
oidc-token.verified_claims.claims.given_name		0..1	string	Verified given name
oidc-token.verified_claims.claims.middle_name		0..1	string	Verified middle name(s)
oidc-token.verified_claims.claims.family_name		0..1	string	Verified family name
oidc-token.verified_claims.claims.birthdate		0..1	date	Verified birth date
oidc-token.verified_claims.claims.email		0..1	string	Verified email address
oidc-token.verified_claims.claims.phone_number		0..1	string	Verified phone number
oidc-token.verified_claims.claims.ssn_last4		0..1	string	Proposal-specific claim for the last four SSN digits
Documentation for this format

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

Maturity: 2

Other representations of profile: CSV, Excel