Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Output class is used in the reporting event's outputs attribute to define the outputs for the reporting event.

Excerpt Include
ARSP:ER Diagram: Output
ARSP:ER Diagram: Output

An instance of the Output class is created for each output and, in each instance:,

  • The id attribute contains the identifier value assigned for the output.
  • The version attribute contains the version number of the output.
  • The name attribute indicates the assigned name of the output.
  • The description attribute may be used to record a detailed description of the output.
  • The label attribute may be used to record a short description of the output.
  • One or more category identifier values may be included in the categoryIds attribute to categorize the output, as described in the AnalysisOutputCategorization section.
  • One or more references to associated documentation for the output may be included in the documentRefs attribute, as described in the DocumentReference section.
  • The programming code used to generate the results displayed in the output may be recorded or referenced in the programmingCode attribute, as described in the AnalysisOutputProgrammingCode section.

An output contains the results from a set of 1 or more related analyses (see the Note in the NestedList ListOfContents section for information about associating analyses with outputs). Within the output, the results may be represented in a single display or they may be represented in 2 or more separate displays. The display(s) within an output are specified in the displays attribute, which contains 1 or more instances of the OrderedDisplay class. Each instance of the OrderedDisplay class has 2 attributes:

...

  • name, which contains either the name of the output file or a sponsor-defined label for the file
  • description, which may be used to record a detailed description of the file
  • label, which may be used to record an alternative label for the file
  • location, which indicates the location of the file relative to the location of the reporting event file
  • fileType, which contains an indication of the file format (e.g., PDF, RTF) represented as an instance of 1 of the 2 specializations of the ExtensibleTerminologyTerm class for the OutputFileTypeEnum enumeration:
    • OutputFileType, in which the controlledTerm attribute contains a file type from the OutputFileTypeEnum enumeration
    • SponsorOutputFileType, in which the sponsorTermId attribute contains the identifier of a sponsor term created in the terminology extension for the OutputFileTypeEnum enumeration

...