PotentialMatch

Element information

Content

• Sequence [1..1]
  from type IdentificationType
  ID [0..*]    Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
  IDSet [0..*]    
  from type PotentialMatchBaseType
  Name [0..*]    Identifies the Name of the object in which associated.
  MatchScreenList [0..1]    
  AliasName [0..*]    
  from group FreeFormTextGroup
  Description [0..*]    
  Note [0..*]    
  Address [0..*]    
  Score [0..1]    
  1. Extension [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The Extension is always the last element in all components, except where the component has been extended inline.

Attributes

Used in

• Type PartyScreenResponseBaseType
• Type PartyScreenResponseType via extension of PartyScreenResponseBaseType (Element PartyScreenResponse)

Sample instance

<PotentialMatch>
   <ID/>
   <IDSet>
      <ID/>
   </IDSet>
   <Name/>
   <MatchScreenList>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Name/>
      <SourceCode>normalizedString</SourceCode>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </MatchScreenList>
   <AliasName/>
   <Description/>
   <Note/>
   <Address>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Name/>
      <AttentionOfName/>
      <CareOfName/>
      <BuildingNumber/>
      <BuildingName/>
      <BlockName/>
      <StreetName/>
      <StreetTypeCode>normalizedString</StreetTypeCode>
      <Floor/>
      <Unit/>
      <StairCase/>
      <Door/>
      <PostOfficeBox/>
      <DeliveryPointID>normalizedString</DeliveryPointID>
      <PlotID>normalizedString</PlotID>
      <CityName/>
      <CitySubDivisionName/>
      <CountrySubDivisionCode>token</CountrySubDivisionCode>
      <CountryCode>token</CountryCode>
      <PostalCode>normalizedString</PostalCode>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <Preference>
         <ID/>
         <IDSet>...
         </IDSet>
         <PrioritySequenceValue>1</PrioritySequenceValue>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <UnavailableTimePeriod>..................
         </UnavailableTimePeriod>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </Preference>
      <GeographicalCoordinate>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <ReferenceSystemID/>
         <VerticalReferenceSystemID/>
         <VerticalMeasure>1.0</VerticalMeasure>
         <LatitudeMeasure>1.0</LatitudeMeasure>
         <LongitudeMeasure>1.0</LongitudeMeasure>
         <VerticalAccuracyMeasure>1.0</VerticalAccuracyMeasure>
         <HorizontalAccuracyMeasure>1.0</HorizontalAccuracyMeasure>
         <Extension>.......................................
         </Extension>
      </GeographicalCoordinate>
      <Usage>
         <ID/>
         <IDSet>...
         </IDSet>
         <GeographicalRegionCode>normalizedString</GeographicalRegionCode>
         <LegalIndicator>true</LegalIndicator>
         <FormattedName/>
         <FormattedAddressUse>...
         </FormattedAddressUse>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Usage>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Address>
   <Score>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <ScoreValue>string</ScoreValue>
      <ScoreText/>
      <MatchWord/>
      <Algorithm/>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </Score>
   <Extension>
      <AnyExtension>
         <!--any element-->
      </AnyExtension>
      <Amount/>
      <Code/>
      <DateTime></DateTime>
      <ID/>
      <Indicator>true</Indicator>
      <Measure/>
      <Name/>
      <Number>1.0</Number>
      <Quantity/>
      <Text/>
      <Time></Time>
      <ValueText>string</ValueText>
   </Extension>
</PotentialMatch>