This project is read-only.

ItemIdInfo RESTFUL linking

Topics: ACORD XML 2.x, Resources, REST
Mar 5, 2016 at 7:17 PM
Edited Mar 5, 2016 at 7:17 PM
Below I have included links to samples for ItemIdInfo represented in JSON on XML. In this discussion is there anything else we need this aggregate to accomplish.

JSON ItemIdInfo
XML ItemIdInfo
Mar 11, 2016 at 7:45 PM
Edited Mar 11, 2016 at 7:47 PM
XML SUMMIT Item ID Info Brainstorm
<!-- Agency/Broker/MGA ID -->
        <!-- Insurer/UnderwritingCo ID -->
       <!-- Auto generated GUID -->                                         
       <!-- other unique ids can be stored here -->
              <OtherIdTypeCd CodeListRef=""/>
       <!-- used for requestor info and audit trail.  -->  <!—This has to be renamed because there is already an audit info 
              <SequenceNumber />
              <UpdatedByUser /> 
              <UpdatedBySystem /> 
              <UpdatedDtTime /> 
              <!-- period for which the resource should remain active -->
              <EffectiveDtTime /> 
              <ExpirationDtTime /> 
       <!-- may have to move this above ItemIdInfo to be first aggregate in parent based on HAL principles -->
               <Self>http://rest/insureds/50123</Self >
               <Vehicle>http://rest/insureds/vehicles/156948</Vehicle >
              <Address>http://rest/insureds/addresses/70123</Address >
              <!-- can also be used for search results -->
       <!-- need something to indicate available actions -->                      
              <ActionCd CodeListRef="" />                                         
Mar 11, 2016 at 7:49 PM
I believe I started this topic during the resource discussion and provided a list of new elements in the blog and see a few in here but most notably missing are EffectiveDtTime and ExpirationDtTime which are critical to Change processing (not just Policy Change). Counting on TransactionEffectiveDt to be present may work for certain traditional messages but we've found that point-in-time cases need this info.

Here's the list of ItemIdInfo extensions I believe I provided. Some of these may be considered unique to Berkley but we make use of all of them:
   <xsd:element ref="UpdatedByUser" minOccurs="0"/>
   <xsd:element ref="UpdatedBySystemId" minOccurs="0"/>
   <xsd:element ref="UpdatedBySystemCd" minOccurs="0"/>
   <xsd:element ref="UpdatedDtTime" minOccurs="0"/>
   <xsd:element ref="ac:EffectiveDtTime" minOccurs="0"/>
   <xsd:element ref="ac:ExpirationDtTime" minOccurs="0"/>
   <xsd:element ref="OtherInsurerId" minOccurs="0"/>
   <xsd:element ref="VersionNumber" minOccurs="0"/>
   <xsd:element ref="SequenceNumber" minOccurs="0"/>
   <xsd:element ref="ParentInsurerId" minOccurs="0"/>
   <xsd:element ref="ParentSystemId" minOccurs="0"/>
Kevin Schipani
Data Architect
Berkley Technology Services, LLC
Mar 11, 2016 at 7:52 PM
I’ve uploaded an example ItemIdInfo expansion with audit info some time ago that combines what I heard at the Summit with a couple additional things we’d like to see. I know we, Liberty, and Berkley all need/use this information and to me it makes perfect sense to be in the standard and as part of the 2.0 release. I’m talking about the audit type information in particular.
<ItemIdInfo id="BSC01010">
Danny Blood
Boston Software
Mar 11, 2016 at 7:54 PM
I have created some documentation on <ItemIdInfo> please update it with any additional suggestions
Mar 11, 2016 at 7:56 PM
Edited Mar 11, 2016 at 8:00 PM
There's definitely a business need to update <ItemIdInfo> right now. For audit info, how about <PersistenceInfo> as a name?

Jamie Steward
Agencyport Software
Aug 2, 2016 at 2:45 PM
Edited Aug 2, 2016 at 2:54 PM
The new <SourceSystem> aggregate contains a lot of the metadata about who and where the resource was changed.

The <ItemIdInfo> tag already contains @SourceSystemRefs, but we need to know who made the change.

As such we are recommending that we add @SourcePartyRefs with a reference to the person making the change.

In addition we need to track versions of resources and how long that version is valid. The final proposed XML looks like this:
<ItemIdInfo SourceSystemRefs="S1" SourcePartyRefs="P1">
    <!-- Agency/Broker/MGA ID -->
    <!-- Insurer/UnderwritingCo ID -->
    <!-- Auto generated GUID -->
    <!-- other unique ids can be stored here -->
    <!-- used to indicate version and effective period  -->
Aug 2, 2016 at 2:53 PM
Another new addition is the <Link> element.

This new aggregate will be the first thing you find in every resource.

The result is a much more navigable API with simple HTTP links between resources.

Here is a small sample of XML to illustrate the usage:
    <Link rel="self" href="/policy/4e068b48-798c-4df1-8d1d-ea2a90f4eb4c" title="Self" />
    <Link rel="next" href="/policy/4e068b48-798c-4df1-8d1d-ea2a345eb4d" title="Next" />
    <Link rel="last" href="/policy/4e068b48-798c-4df1-8d1d-ea2a90f4eb4c" title="Last" />
We still need to define the valid values for @rel, but the above structure will support HATEOS and HAL based interfaces.
Sep 20, 2016 at 9:29 PM
I have created a OPENAPI JSON Schema for the Link aggregate.

OpenAPI Specification