Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3 United States of America flag

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

Resource Profile: A RelatedPerson resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI)

Official URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/RelatedPersonLei Version: 3.0.0-current
Standards status: Trial-use Maturity Level: 2 Computable Name: RelatedPersonLei
Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.10

A RelatedPerson resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI), and may carry the verified LEI (vLEI). This profile is used to represent a related person who has a legal entity identifier, which is typically used for individuals who are associated with legal entities in financial transactions. The profile includes an extension for the verified LEI (vLEI) to indicate that the LEI has been verified and is valid.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI A human identifier for this person
... active ?!SΣ 1..1 boolean (USCDI) Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) (USCDI) The patient this person is related to
... relationship SΣC 0..* CodeableConcept (USCDI) The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... name SΣC 0..* HumanName (USCDI) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI) A contact detail for the person
... address SΣ 0..* Address (USCDI) Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
... Slices for identifier 1..* Identifier A human identifier for this person
Slice: Unordered, Open by profile:$this
.... identifier:lei S 1..* LEI A human identifier for this person

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI A human identifier for this person
... active ?!SΣ 1..1 boolean (USCDI) Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) (USCDI) The patient this person is related to
... relationship SΣC 0..* CodeableConcept (USCDI) The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... name SΣC 0..* HumanName (USCDI) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI) A contact detail for the person
... 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 on which the related person was born
... address SΣ 0..* Address (USCDI) Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📦4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI A human identifier for this person
... active ?!SΣ 1..1 boolean (USCDI) Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) (USCDI) The patient this person is related to
... relationship SΣC 0..* CodeableConcept (USCDI) The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... name SΣC 0..* HumanName (USCDI) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI) A contact detail for the person
... address SΣ 0..* Address (USCDI) Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
... Slices for identifier 1..* Identifier A human identifier for this person
Slice: Unordered, Open by profile:$this
.... identifier:lei S 1..* LEI A human identifier for this person

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI A human identifier for this person
... active ?!SΣ 1..1 boolean (USCDI) Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) (USCDI) The patient this person is related to
... relationship SΣC 0..* CodeableConcept (USCDI) The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... name SΣC 0..* HumanName (USCDI) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI) A contact detail for the person
... 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 on which the related person was born
... address SΣ 0..* Address (USCDI) Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📦4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron