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
| Official URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/identity-assertion | Version: 3.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: IdentityAssertion | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.19 | |||||
A representation of asserted identity information, including names, postal addresses, and phone numbers with their validity periods.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  identity-assertion |
0..* | Base | Identity Assertion | |
  masterIdentifier |
1..1 | string | The master identifier | |
 system |
1..1 | string | The system of the master identifier | |
 @value |
1..1 | string | The identifier value | |
 names |
1..* | BackboneElement | The person's names | |
| first |
1..1 | string | The first name | |
| middle |
0..* | string | The middle names | |
| last |
1..1 | string | The last name | |
| prefix |
0..1 | string | The prefix | |
| suffix |
0..1 | string | The suffix | |
| validityPeriod |
0..1 | Period | The validity of this name | |
| addresses |
0..* | Address | Physical addresses | |
| period |
0..1 | Period | The validity of this address | |
| use |
0..1 | code | home | work | temp | old | billing | |
| type |
0..1 | code | postal | physical | both | |
| line |
0..* | string | The street address | |
| city |
1..1 | string | The city of the address | |
| state |
1..1 | string | The state of the address | |
| postalCode |
0..1 | string | The postal code | |
| country |
0..1 | string | The country of the address | |
| phoneNumbers |
0..* | BackboneElement | Phone numbers | |
| number |
1..1 | string | The phone number | |
| validityPeriod |
0..1 | Period | The validity of this number | |
| type |
0..1 | code | phone | fax | pager | url | sms | other | |
| use |
0..1 | code | home | work | temp | old | mobile | |
| rank |
0..1 | integer | Specify preferred order of use (1 = highest) | |
| emails |
0..* | BackboneElement | Email addresses or direct messaging | |
| address |
1..1 | string | The email address | |
| validityPeriod |
0..1 | Period | The validity of this email | |
| type |
0..1 | code | work | personal | |
| ssn |
0..* | string | The social security number | |
| identifiers |
0..* | BackboneElement | Correlated external Identifiers | |
| value |
1..1 | string | The identifier value | |
| system |
0..1 | string | The identifier system URL | |
| type |
0..1 | code | The identifier type | |
| validityPeriod |
0..1 | Period | The validity of this identifier | |
| issuer |
0..1 | string | The issuer of this identifier | |
| birthDate |
0..1 | date | The birth date | |
| photo |
0..1 | Attachment | The person's photo | |
| gender |
0..1 | code | male | female | other | unknown | |
| maritalStatus |
0..1 | code | unmarried | married | annulled | divorced | |
| race |
0..1 | code | Asked but unknown | Asked but declined | unknown | American Indian | Asian | Black | Native Hawaiian | White | Other | |
| ethnicity |
0..1 | code | The ethnicity of the person | |
| tribalAffiliation |
0..1 | code | Tribal affiliation | |
| religion |
0..1 | code | The religion of the person | |
| placeOfBirth |
0..1 | string | The place of birth | |
| placeOfDeath |
0..1 | string | The place of death | |
| deathDate |
0..1 | date | The date of death | |
| causeOfDeath |
0..1 | code | The cause of death | |
| assuranceLevel |
0..1 | code | The level of assurance | |
| verificationStatus |
0..1 | code | The verification status | |
| assuranceDate |
0..1 | date | The date of assurance | |
| assuranceMethod |
0..1 | code | The method of assurance | |
| contact |
0..* | BackboneElement | Emergency contacts | |
| relationship |
0..1 | code | Relationship to the person | |
| name |
0..1 | string | Name of contact | |
| phone |
0..1 | string | Phone of contact | |
| email |
0..1 | string | Email of contact | |
| address |
0..1 | string | Address of contact | |
| gender |
0..1 | code | Gender of contact | |
| period |
0..1 | Period | Contact period | |
| communication |
0..* | BackboneElement | Languages spoken | |
| language |
0..1 | code | Language | |
| preferred |
0..1 | boolean | Preferred language | |
| generalPractitioner |
0..* | BackboneElement | General practitioners | |
| managingOrganization |
0..1 | string | Managing organization | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
 identity-assertion |
0..* | Base | Identity Assertion | |
| masterIdentifier |
1..1 | string | The master identifier | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| @value |
1..1 | string | The identifier value Max Length:1048576 | |
| system |
1..1 | string | The system of the master identifier | |
| names |
1..* | BackboneElement | The person's names | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| first |
1..1 | string | The first name | |
| middle |
0..* | string | The middle names | |
| last |
1..1 | string | The last name | |
| prefix |
0..1 | string | The prefix | |
| suffix |
0..1 | string | The suffix | |
| validityPeriod |
0..1 | Period | The validity of this name | |
| addresses |
0..* | Address | Physical addresses | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | home | work | temp | old | billing Binding: AddressUse (required): The use of an address. Example General: home | |
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |
| line |
0..* | string | The street address This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |
| city |
1..1 | string | The city of the address Example General: Erewhon | |
| district |
0..1 | string | District name (aka county) Example General: Madison | |
| state |
1..1 | string | The state of the address | |
| postalCode |
0..1 | string | The postal code Example General: 9132 | |
| country |
0..1 | string | The country of the address | |
| period |
0..1 | Period | The validity of this address Example General: {"start":"2010-03-23","end":"2010-07-01"} | |
| phoneNumbers |
0..* | BackboneElement | Phone numbers | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| number |
1..1 | string | The phone number | |
| validityPeriod |
0..1 | Period | The validity of this number | |
| type |
0..1 | code | phone | fax | pager | url | sms | other | |
| use |
0..1 | code | home | work | temp | old | mobile | |
| rank |
0..1 | integer | Specify preferred order of use (1 = highest) | |
| emails |
0..* | BackboneElement | Email addresses or direct messaging | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| address |
1..1 | string | The email address | |
| validityPeriod |
0..1 | Period | The validity of this email | |
| type |
0..1 | code | work | personal | |
| ssn |
0..* | string | The social security number | |
| identifiers |
0..* | BackboneElement | Correlated external Identifiers | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value |
1..1 | string | The identifier value | |
| system |
0..1 | string | The identifier system URL | |
| type |
0..1 | code | The identifier type | |
| validityPeriod |
0..1 | Period | The validity of this identifier | |
| issuer |
0..1 | string | The issuer of this identifier | |
| birthDate |
0..1 | date | The birth date | |
| photo |
0..1 | Attachment | The person's photo | |
| gender |
0..1 | code | male | female | other | unknown | |
| maritalStatus |
0..1 | code | unmarried | married | annulled | divorced | |
| race |
0..1 | code | Asked but unknown | Asked but declined | unknown | American Indian | Asian | Black | Native Hawaiian | White | Other | |
| ethnicity |
0..1 | code | The ethnicity of the person | |
| tribalAffiliation |
0..1 | code | Tribal affiliation | |
| religion |
0..1 | code | The religion of the person | |
| placeOfBirth |
0..1 | string | The place of birth | |
| placeOfDeath |
0..1 | string | The place of death | |
| deathDate |
0..1 | date | The date of death | |
| causeOfDeath |
0..1 | code | The cause of death | |
| assuranceLevel |
0..1 | code | The level of assurance | |
| verificationStatus |
0..1 | code | The verification status | |
| assuranceDate |
0..1 | date | The date of assurance | |
| assuranceMethod |
0..1 | code | The method of assurance | |
| contact |
0..* | BackboneElement | Emergency contacts | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| relationship |
0..1 | code | Relationship to the person | |
| name |
0..1 | string | Name of contact | |
| phone |
0..1 | string | Phone of contact | |
| email |
0..1 | string | Email of contact | |
| address |
0..1 | string | Address of contact | |
| gender |
0..1 | code | Gender of contact | |
| period |
0..1 | Period | Contact period | |
| communication |
0..* | BackboneElement | Languages spoken | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| language |
0..1 | code | Language | |
| preferred |
0..1 | boolean | Preferred language | |
| generalPractitioner |
0..* | BackboneElement | General practitioners | |
| managingOrganization |
0..1 | string | Managing organization | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| identity-assertion.addresses.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| identity-assertion.addresses.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| identity-assertion |
0..* | Base | Identity Assertion | |
| masterIdentifier |
1..1 | string | The master identifier | |
| system |
1..1 | string | The system of the master identifier | |
| @value |
1..1 | string | The identifier value | |
| names |
1..* | BackboneElement | The person's names | |
| first |
1..1 | string | The first name | |
| middle |
0..* | string | The middle names | |
| last |
1..1 | string | The last name | |
| prefix |
0..1 | string | The prefix | |
| suffix |
0..1 | string | The suffix | |
| validityPeriod |
0..1 | Period | The validity of this name | |
| addresses |
0..* | Address | Physical addresses | |
| period |
0..1 | Period | The validity of this address | |
| use |
0..1 | code | home | work | temp | old | billing | |
| type |
0..1 | code | postal | physical | both | |
| line |
0..* | string | The street address | |
| city |
1..1 | string | The city of the address | |
| state |
1..1 | string | The state of the address | |
| postalCode |
0..1 | string | The postal code | |
| country |
0..1 | string | The country of the address | |
| phoneNumbers |
0..* | BackboneElement | Phone numbers | |
| number |
1..1 | string | The phone number | |
| validityPeriod |
0..1 | Period | The validity of this number | |
| type |
0..1 | code | phone | fax | pager | url | sms | other | |
| use |
0..1 | code | home | work | temp | old | mobile | |
| rank |
0..1 | integer | Specify preferred order of use (1 = highest) | |
| emails |
0..* | BackboneElement | Email addresses or direct messaging | |
| address |
1..1 | string | The email address | |
| validityPeriod |
0..1 | Period | The validity of this email | |
| type |
0..1 | code | work | personal | |
| ssn |
0..* | string | The social security number | |
| identifiers |
0..* | BackboneElement | Correlated external Identifiers | |
| value |
1..1 | string | The identifier value | |
| system |
0..1 | string | The identifier system URL | |
| type |
0..1 | code | The identifier type | |
| validityPeriod |
0..1 | Period | The validity of this identifier | |
| issuer |
0..1 | string | The issuer of this identifier | |
| birthDate |
0..1 | date | The birth date | |
| photo |
0..1 | Attachment | The person's photo | |
| gender |
0..1 | code | male | female | other | unknown | |
| maritalStatus |
0..1 | code | unmarried | married | annulled | divorced | |
| race |
0..1 | code | Asked but unknown | Asked but declined | unknown | American Indian | Asian | Black | Native Hawaiian | White | Other | |
| ethnicity |
0..1 | code | The ethnicity of the person | |
| tribalAffiliation |
0..1 | code | Tribal affiliation | |
| religion |
0..1 | code | The religion of the person | |
| placeOfBirth |
0..1 | string | The place of birth | |
| placeOfDeath |
0..1 | string | The place of death | |
| deathDate |
0..1 | date | The date of death | |
| causeOfDeath |
0..1 | code | The cause of death | |
| assuranceLevel |
0..1 | code | The level of assurance | |
| verificationStatus |
0..1 | code | The verification status | |
| assuranceDate |
0..1 | date | The date of assurance | |
| assuranceMethod |
0..1 | code | The method of assurance | |
| contact |
0..* | BackboneElement | Emergency contacts | |
| relationship |
0..1 | code | Relationship to the person | |
| name |
0..1 | string | Name of contact | |
| phone |
0..1 | string | Phone of contact | |
| email |
0..1 | string | Email of contact | |
| address |
0..1 | string | Address of contact | |
| gender |
0..1 | code | Gender of contact | |
| period |
0..1 | Period | Contact period | |
| communication |
0..* | BackboneElement | Languages spoken | |
| language |
0..1 | code | Language | |
| preferred |
0..1 | boolean | Preferred language | |
| generalPractitioner |
0..* | BackboneElement | General practitioners | |
| managingOrganization |
0..1 | string | Managing organization | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| identity-assertion |
0..* | Base | Identity Assertion | |
| masterIdentifier |
1..1 | string | The master identifier | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| @value |
1..1 | string | The identifier value Max Length:1048576 | |
| system |
1..1 | string | The system of the master identifier | |
| names |
1..* | BackboneElement | The person's names | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| first |
1..1 | string | The first name | |
| middle |
0..* | string | The middle names | |
| last |
1..1 | string | The last name | |
| prefix |
0..1 | string | The prefix | |
| suffix |
0..1 | string | The suffix | |
| validityPeriod |
0..1 | Period | The validity of this name | |
| addresses |
0..* | Address | Physical addresses | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | home | work | temp | old | billing Binding: AddressUse (required): The use of an address. Example General: home | |
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |
| line |
0..* | string | The street address This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |
| city |
1..1 | string | The city of the address Example General: Erewhon | |
| district |
0..1 | string | District name (aka county) Example General: Madison | |
| state |
1..1 | string | The state of the address | |
| postalCode |
0..1 | string | The postal code Example General: 9132 | |
| country |
0..1 | string | The country of the address | |
| period |
0..1 | Period | The validity of this address Example General: {"start":"2010-03-23","end":"2010-07-01"} | |
| phoneNumbers |
0..* | BackboneElement | Phone numbers | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| number |
1..1 | string | The phone number | |
| validityPeriod |
0..1 | Period | The validity of this number | |
| type |
0..1 | code | phone | fax | pager | url | sms | other | |
| use |
0..1 | code | home | work | temp | old | mobile | |
| rank |
0..1 | integer | Specify preferred order of use (1 = highest) | |
| emails |
0..* | BackboneElement | Email addresses or direct messaging | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| address |
1..1 | string | The email address | |
| validityPeriod |
0..1 | Period | The validity of this email | |
| type |
0..1 | code | work | personal | |
| ssn |
0..* | string | The social security number | |
| identifiers |
0..* | BackboneElement | Correlated external Identifiers | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value |
1..1 | string | The identifier value | |
| system |
0..1 | string | The identifier system URL | |
| type |
0..1 | code | The identifier type | |
| validityPeriod |
0..1 | Period | The validity of this identifier | |
| issuer |
0..1 | string | The issuer of this identifier | |
| birthDate |
0..1 | date | The birth date | |
| photo |
0..1 | Attachment | The person's photo | |
| gender |
0..1 | code | male | female | other | unknown | |
| maritalStatus |
0..1 | code | unmarried | married | annulled | divorced | |
| race |
0..1 | code | Asked but unknown | Asked but declined | unknown | American Indian | Asian | Black | Native Hawaiian | White | Other | |
| ethnicity |
0..1 | code | The ethnicity of the person | |
| tribalAffiliation |
0..1 | code | Tribal affiliation | |
| religion |
0..1 | code | The religion of the person | |
| placeOfBirth |
0..1 | string | The place of birth | |
| placeOfDeath |
0..1 | string | The place of death | |
| deathDate |
0..1 | date | The date of death | |
| causeOfDeath |
0..1 | code | The cause of death | |
| assuranceLevel |
0..1 | code | The level of assurance | |
| verificationStatus |
0..1 | code | The verification status | |
| assuranceDate |
0..1 | date | The date of assurance | |
| assuranceMethod |
0..1 | code | The method of assurance | |
| contact |
0..* | BackboneElement | Emergency contacts | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| relationship |
0..1 | code | Relationship to the person | |
| name |
0..1 | string | Name of contact | |
| phone |
0..1 | string | Phone of contact | |
| email |
0..1 | string | Email of contact | |
| address |
0..1 | string | Address of contact | |
| gender |
0..1 | code | Gender of contact | |
| period |
0..1 | Period | Contact period | |
| communication |
0..* | BackboneElement | Languages spoken | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| language |
0..1 | code | Language | |
| preferred |
0..1 | boolean | Preferred language | |
| generalPractitioner |
0..* | BackboneElement | General practitioners | |
| managingOrganization |
0..1 | string | Managing organization | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| identity-assertion.addresses.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| identity-assertion.addresses.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
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