Skip to content

Documentation Error in USDM IG Extension Example 4 (Page 102) #697

@JBGed

Description

@JBGed

Summary

There is an error in Example 4 on page 102 of the USDM Implementation Guide. The example demonstrates extending a code class with two array attributes of differing types, but the JSON example is missing required valueInteger properties for the integer array attribute.

Location

  • Page: 102
  • Example: Example 4 - Extending a code class with array attributes

Issue Description

The provided USDM JSON example shows extension attributes for an intArrayAttribute, but the extension attribute objects are missing the valueInteger property that should contain the actual integer values.

Current (Incorrect) JSON

The example currently shows:

{
  "id": "ExtensionAttributeValue_21",
  "url": "http://cdisc.org/usdm/extensions/extension-2/intArrayAttribute",
  "extensionAttributes": [],
  "instanceType": "ExtensionAttribute"
},
{
  "id": "ExtensionAttributeValue_22",
  "url": "http://cdisc.org/usdm/extensions/extension-2/intArrayAttribute",
  "extensionAttributes": [],
  "instanceType": "ExtensionAttribute"
}

Expected (Correct) JSON

The extension attributes should include the valueInteger property:

{
  "id": "ExtensionAttributeValue_21",
  "url": "http://cdisc.org/usdm/extensions/extension-2/intArrayAttribute",
  "valueInteger": 11,
  "extensionAttributes": [],
  "instanceType": "ExtensionAttribute"
},
{
  "id": "ExtensionAttributeValue_22",
  "url": "http://cdisc.org/usdm/extensions/extension-2/intArrayAttribute",
  "valueInteger": 12,
  "extensionAttributes": [],
  "instanceType": "ExtensionAttribute"
}

Impact

This error makes the example inconsistent with the stated logical equivalence and could mislead implementers about how to properly structure integer array extensions in USDM JSON.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions