Generated Narrative: StructureDefinition LEI Name Flags Card. Type Description & Constraints Identifier 0..* Identifier An identifier intended for computation #xD; Slices for extension Content/Rules for all slices #xD; extension:vlei 0..* Attachment vLEI URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI #xD; use S 0..1 code usual | official | temp | secondary | old (If known) #xD; type S 0..1 CodeableConcept Description of identifier #xD; system S 1..1 uri The namespace for the identifier value Required Pattern: https://www.gleif.org/lei #xD; value SC 1..1 string The value that is unique Constraints: lei-format #xD; period S 0..1 Period Time period when id is/was valid for use #xD; assigner S 0..1 Reference(Organization) Organization that issued id (may be just text) #xD; reference S 0..1 string Literal reference, Relative, internal or absolute URL #xD; identifier S 0..1 Identifier Logical reference, when literal reference is not known #xD; Documentation for this format
An Identifier with a value that is a Legal Entity Identifier (LEI)
HL7 International / Patient Administration
An Identifier with a value that is a Legal Entity Identifier (LEI), and may carry the verified LEI (vLEI)
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
CX / EI (occasionally, more often EI maps to a resource id or a URL)
II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
An extension to hold the verified LEI (vLEI) indicating that the LEI has been verified and is valid. Note that the vLEI is not further decomposed into the Attachment elements, as pulling these values outside of the vLEI leaves them unprotected. Thus any access to the vLEI elements should go through the proper vLEI validation process and use the values in the then validated vLEI.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
The system URI for the LEI is https://www.gleif.org/lei, which is the official source for LEI information. This URI indicates that the identifier value is a Legal Entity Identifier (LEI) as defined by the Global Legal Entity Identifier Foundation (GLEIF).
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
The value of the identifier is a Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid.
The value of the identifier must be a valid Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
The period during which the binding of the LEI to this Identifier use is valid. This should not be longer than the valid life of the LEI itself.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The organization that issued the LEI. This should be the organization that is responsible for the LEI, which is typically the Local Operating Unit (LOU) that issued the LEI. The assigner should be an organization that is authorized to issue LEIs and is recognized by the Global Legal Entity Identifier Foundation (GLEIF). This value shall not be the QVI.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
The reference to the organization that issued the LEI should point to an Organization resource that represents the Local Operating Unit (LOU) that issued the LEI. This allows for better interoperability and consistency in representing the issuer of the LEI across different systems and implementations.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
The identifier for the organization that issued the LEI should be a unique identifier that can be used to reference the organization. This could be an identifier from a recognized system such as the Global Legal Entity Identifier Foundation (GLEIF) or another authoritative source for organizational identifiers. The identifier should be used to ensure that the organization can be uniquely identified and referenced in a consistent manner across different systems and implementations.
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.