Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3
Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3
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
| Page standards status: Trial-use | Maturity Level: 2 |
Mappings for the identity-assertion logical model.
| Name | Identity Assertion to OpenID Connect ID Token |
|---|---|
  identity-assertion |
OIDCToken |
  masterIdentifier |
|
 @id |
|
 extension |
|
| @value |
OIDCToken.sub Use only when this is the subject identifier assigned for this issuer and relying-party context. |
 system |
|
 names |
|
| @id |
|
| extension |
|
 modifierExtension |
|
| first |
OIDCToken.given_name |
| middle |
OIDCToken.middle_name |
| last |
OIDCToken.family_name |
| prefix |
|
| suffix |
|
| validityPeriod |
|
| addresses |
OIDCToken.address OIDC models one address object; select the applicable current address. |
| @id |
|
| extension |
|
| use |
|
| type |
|
| text |
|
| line |
OIDCToken.address.street_address |
| city |
OIDCToken.address.locality |
| district |
|
| state |
OIDCToken.address.region |
| postalCode |
OIDCToken.address.postal_code |
| country |
OIDCToken.address.country |
| period |
|
| phoneNumbers |
|
| @id |
|
| extension |
|
| modifierExtension |
|
| number |
OIDCToken.phone_number OIDC models one phone_number claim; select the applicable current number. |
| validityPeriod |
|
| type |
|
| use |
|
| rank |
|
| emails |
|
| @id |
|
| extension |
|
| modifierExtension |
|
| address |
OIDCToken.email OIDC models one email claim; select the applicable current address. |
| validityPeriod |
|
| type |
|
| ssn |
OIDCToken.verified_claims.claims.ssn_last4 Only derive and disclose the last four digits when authorized; never map the full SSN. This is a proposal-specific claim, not a standard OIDC claim. |
| identifiers |
|
| @id |
|
| extension |
|
| modifierExtension |
|
| value |
|
| system |
|
| type |
|
| validityPeriod |
|
| issuer |
|
| birthDate |
OIDCToken.birthdate |
| photo |
OIDCToken.picture Convert to a retrievable image URL when available. |
| gender |
OIDCToken.gender |
| maritalStatus |
|
| race |
|
| ethnicity |
|
| tribalAffiliation |
|
| religion |
|
| placeOfBirth |
|
| placeOfDeath |
|
| deathDate |
|
| causeOfDeath |
|
| assuranceLevel |
OIDCToken.verified_claims.verification.assurance_level Map to the OIDC4IDA verification assurance level. |
| verificationStatus |
|
| assuranceDate |
OIDCToken.verified_claims.verification.time Map to the time of identity verification. |
| assuranceMethod |
|
| contact |
|
| @id |
|
| extension |
|
| modifierExtension |
|
| relationship |
|
| name |
|
| phone |
|
| email |
|
| address |
|
| gender |
|
| period |
|
| communication |
|
| @id |
|
| extension |
|
| modifierExtension |
|
| language |
|
| preferred |
|
| generalPractitioner |
|
| managingOrganization |
|
| Documentation for this format | |
| Name | Identity Assertion to FHIR Patient | Identity Assertion to US Core Patient |
|---|---|---|
| identity-assertion |
||
| masterIdentifier |
||
| @id |
||
| extension |
||
| @value |
Patient.identifier.value |
|
| system |
Patient.identifier.system |
|
| names |
||
| @id |
||
| extension |
||
| modifierExtension |
||
| first |
Patient.name.given Map as a given name. |
Patient.name.given Map as a given name. |
| middle |
Patient.name.given Map additional given names in order. |
Patient.name.given Map additional given names in order. |
| last |
Patient.name.family |
|
| prefix |
Patient.name.prefix |
|
| suffix |
Patient.name.suffix |
|
| validityPeriod |
Patient.name.period |
|
| addresses |
||
| @id |
||
| extension |
||
| use |
Patient.address.use |
|
| type |
Patient.address.type |
|
| text |
||
| line |
Patient.address.line |
|
| city |
Patient.address.city |
|
| district |
||
| state |
Patient.address.state |
|
| postalCode |
Patient.address.postalCode |
|
| country |
Patient.address.country |
|
| period |
Patient.address.period |
|
| phoneNumbers |
||
| @id |
||
| extension |
||
| modifierExtension |
||
| number |
Patient.telecom.value |
|
| validityPeriod |
Patient.telecom.period |
|
| type |
Patient.telecom.system |
|
| use |
Patient.telecom.use |
|
| rank |
Patient.telecom.rank |
|
| emails |
||
| @id |
||
| extension |
||
| modifierExtension |
||
| address |
Patient.telecom.value |
|
| validityPeriod |
Patient.telecom.period |
|
| type |
Patient.telecom.use The personal code requires interpretation, such as mapping to home. |
Patient.telecom.use The personal code requires interpretation, such as mapping to home. |
| ssn |
Patient.identifier.value Represent each value as an identifier and supply an appropriate system and type. |
Patient.identifier.value Represent each value as an identifier and supply an appropriate system and type. |
| identifiers |
||
| @id |
||
| extension |
||
| modifierExtension |
||
| value |
Patient.identifier.value |
|
| system |
Patient.identifier.system |
|
| type |
Patient.identifier.type |
|
| validityPeriod |
Patient.identifier.period |
|
| issuer |
Patient.identifier.assigner.display Convert the issuer string to an Identifier.assigner reference when possible. |
Patient.identifier.assigner.display Convert the issuer string to an Identifier.assigner reference when possible. |
| birthDate |
||
| photo |
||
| gender |
||
| maritalStatus |
||
| race |
//hl7.org/fhir/us/core/StructureDefinition/us-core-race] |
//hl7.org/fhir/us/core/StructureDefinition/us-core-race] |
| ethnicity |
//hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity] |
//hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity] |
| tribalAffiliation |
||
| religion |
||
| placeOfBirth |
//hl7.org/fhir/StructureDefinition/patient-birthPlace] Convert the string to the extension's valueAddress. |
//hl7.org/fhir/StructureDefinition/patient-birthPlace] Convert the string to the extension's valueAddress. |
| placeOfDeath |
||
| deathDate |
Patient.deceasedDateTime |
Patient.deceasedDateTime |
| causeOfDeath |
||
| assuranceLevel |
||
| verificationStatus |
||
| assuranceDate |
||
| assuranceMethod |
||
| contact |
||
| @id |
||
| extension |
||
| modifierExtension |
||
| relationship |
||
| name |
Patient.contact.name.text |
Patient.contact.name.text |
| phone |
Patient.contact.telecom.value Set ContactPoint.system to phone. |
Patient.contact.telecom.value Set ContactPoint.system to phone. |
| email |
Patient.contact.telecom.value Set ContactPoint.system to email. |
Patient.contact.telecom.value Set ContactPoint.system to email. |
| address |
Patient.contact.address.text |
Patient.contact.address.text |
| gender |
||
| period |
||
| communication |
||
| @id |
||
| extension |
||
| modifierExtension |
||
| language |
||
| preferred |
||
| generalPractitioner |
||
| managingOrganization |
Patient.managingOrganization Convert the organization string to a Reference(Organization). |
Patient.managingOrganization Convert the organization string to a Reference(Organization). |
| Documentation for this format | ||
IG © 2021+ HL7 International / Patient Administration.
Package hl7.fhir.us.identity-matching#3.0.0-current based on FHIR 4.0.1.
Generated
2026-10-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change