Interoperable Digital Identity and Patient Matching
1.0.0-ballot - STU Ballot 1 US
Interoperable Digital Identity and Patient Matching
1.0.0-ballot - STU Ballot 1 US
This page is part of the Interoperable Digital Identity and Patient Matching (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/identity-matching/StructureDefinition/IDI-Patient-L1 |
| Version: | 1.0.0-ballot |
| Name: | IDIPatientL1 |
| Title: | IDI Patient L1 |
| Status: | Active as of 2022-03-31 01:04:35+0000 |
| Definition: | (Level 1 weighting) The goal of this profile is to describe a data-minimized version of Patient used to convey information about the patient for Identity Matching utilizing the $match operation, and prescribe a minimum set of data elements which meet a combined 'weighted level' of at least 20 |
| Publisher: | HL7 International - Patient Administration WG |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/identity-matching/StructureDefinition/IDI-Patient-L1
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | I | 0..* | Patient | Patient information to be supplied to $match operation conforming to Level 1 weighting of information idi-L1: Combined weighted values of included elements must have a minimum value of 20 (see Patient Weighted Elements table) |
  meta | ||||
   Slices for profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | |
   profile:assertedProfile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/identity-matching/StructureDefinition/IDI-Patient-L1 | |
| identifier | ||||
| type | 1..1 | CodeableConcept | Description of identifier Binding: Identity Identifier Value Set (extensible) | |
| value | 1..1 | string | The value that is unique | |
| name | I | 0..* | HumanName | A name associated with the patient idi-2: Either the given or family name SHALL be present |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Patient | Patient information to be supplied to $match operation conforming to Level 1 weighting of information idi-L1: Combined weighted values of included elements must have a minimum value of 20 (see Patient Weighted Elements table) |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
 Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this |
| profile:assertedProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/identity-matching/StructureDefinition/IDI-Patient-L1 |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | An identifier for this patient |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identity Identifier Value Set (extensible) |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | ΣI | 0..* | HumanName | A name associated with the patient idi-2: Either the given or family name SHALL be present |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date of birth for the individual |
 deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | An address for the individual |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | 0..* | Attachment | Image of the patient | |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| name | 0..1 | HumanName | A name associated with the contact person | |
| telecom | 0..* | ContactPoint | A contact detail for the person | |
| address | 0..1 | Address | Address for the contact person | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
| organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Patient | Patient information to be supplied to $match operation conforming to Level 1 weighting of information idi-L1: Combined weighted values of included elements must have a minimum value of 20 (see Patient Weighted Elements table) |
| Documentation for this format | ||||
This structure is derived from Patient
Summary
Mandatory: 0 element (4 nested mandatory elements)
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Patient | Patient information to be supplied to $match operation conforming to Level 1 weighting of information idi-L1: Combined weighted values of included elements must have a minimum value of 20 (see Patient Weighted Elements table) |
| meta | ||||
| Slices for profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | |
| profile:assertedProfile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/identity-matching/StructureDefinition/IDI-Patient-L1 | |
| identifier | ||||
| type | 1..1 | CodeableConcept | Description of identifier Binding: Identity Identifier Value Set (extensible) | |
| value | 1..1 | string | The value that is unique | |
| name | I | 0..* | HumanName | A name associated with the patient idi-2: Either the given or family name SHALL be present |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Patient | Patient information to be supplied to $match operation conforming to Level 1 weighting of information idi-L1: Combined weighted values of included elements must have a minimum value of 20 (see Patient Weighted Elements table) |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this |
| profile:assertedProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/identity-matching/StructureDefinition/IDI-Patient-L1 |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | An identifier for this patient |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identity Identifier Value Set (extensible) |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | ΣI | 0..* | HumanName | A name associated with the patient idi-2: Either the given or family name SHALL be present |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date of birth for the individual |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | An address for the individual |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | 0..* | Attachment | Image of the patient | |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| name | 0..1 | HumanName | A name associated with the contact person | |
| telecom | 0..* | ContactPoint | A contact detail for the person | |
| address | 0..1 | Address | Address for the contact person | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
| organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Patient.meta.security | extensible | All Security Labels |
| Patient.meta.tag | example | CommonTags |
| Patient.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.identifier.use | required | IdentifierUse |
| Patient.identifier.type | extensible | IdentityIdentifierValueSet |
| Patient.gender | required | AdministrativeGender |
| Patient.maritalStatus | extensible | Marital Status Codes |
| Patient.contact.relationship | extensible | PatientContactRelationship |
| Patient.contact.gender | required | AdministrativeGender |
| Patient.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.link.type | required | LinkType |
| Id | Grade | Path | Details | Requirements |
| idi-L1 | error | Patient | Combined weighted values of included elements must have a minimum value of 20 (see Patient Weighted Elements table) : (((identifier.type.coding.exists(code = 'PPN') and identifier.value.exists()).toInteger()*10) + ((identifier.type.coding.exists(code = 'DL' or code = 'STID') and identifier.value.exists()).toInteger()*10) + (((address.exists(use = 'home') and address.line.exists() and address.city.exists()) or (identifier.type.coding.exists(code != 'PPN' and code != 'DL' and code != 'STID')) or ((telecom.exists(system = 'email') and telecom.value.exists()) or (telecom.exists(system = 'phone') and telecom.value.exists())) or (photo.exists())).toInteger() * 4) + ((name.family.exists() and name.given.exists()).toInteger()*4) + (birthDate.exists().toInteger()*2)) >= 20 | |
| idi-2 | error | Patient.name | Either the given or family name SHALL be present : given.exists() or family.exists() |
IG © 2021+ HL7 International - Patient Administration WG. Package hl7.fhir.us.identity-matching#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-03-31
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change