XDStar Documentation

XD Star Re-documentation Effort

(or at least Bill's point of view on same)

ConOps

Concepts of Operation - high level view of XD*. Written at a high enough level that you don't need to be an engineer to understand it. (Darn it Jim, I'm a doctor not an engineer! -- Dr. McCoy of Star Trek).

This is a narrative and includes no reference material.

Target audience: Planning Committee, other committees that wish to profile the use of XD*, users

Content includes:

• List of all XD* profiles
• Brief description of their purpose, actors, and transactions
• High level similarities and differences of these profiles
• High level metadata contraints of each

Information Model

Part, or all, of this is a documentation of the metadata model for XD* from these perspectives:

• Major element definitions (SubmissionSet, DocumentEntry, Folder, Association, ObjectRef)
• Submission (Provide and Register, Register perspectives)
  • Basics (Submission Set)
  • How to incrementally add content to a submission (assembly instructions)
  • Rules for adding content (if you add this my must also add this, may also add this...)
• Variance for non-XDS profiles (XDR, XDM, XCA)
• Query and Query response
  • LeafClass vs ObjectRef
  • Short descriptions of all Stored Queries
  • What profiles offer query and how they are different
• How to interpret query responses
• ID management
  • id (symbolic, UUID)
  • uniqueid
  • Patient ID

Target audience: developers. This is a normative reference and HowTo guide. It is not transaction oriented. Instead, it discusses the rules for metadata and as appropriate indicates which transaction(s) a rule or concept applies.