Design domain objects

[otomn]

Design domain objects that suits the need of the project

• [x] Create UML
• [x] Create Typescript class definition file

[otomn]

Data Model

data model is designed based on SDC XML structure listed at: https://www.ihe.net/uploadedFiles/Documents/QRPH/IHE_QRPH_Suppl_SDC_Rev3-0_TI_2019-07-26.pdf

Notations:

• @ map to the attribute used in the XML
• . map to the child used in the XML
• ? optional field
• : type

Design:

Procedure

• uid: string // database
• id: string
• assignedFormID: string // UID of the form

Patient

• uid: string // database
• id: string
• name: string

abstract SDCItem

• title?: string @title
• uid: uuid|string // unique identifier in the DB, do not pass to Front
• id: string @ID // ID for the questions are on the wrapper
• order?: int @order
• children: [SDCItem] .ChildItems

SDCForm: SDCItem

• title?:string @formTitle
• id //ID ~ lineage + Version
• lineage:string @lineage //identifier of a form
• version:string @version //version of a form
• header?:string .Header //xml as string
• footer?:string .Footer //xml as string
• children: [SDCItem] .Body.ChildItems
• formProperties: [SDCFormProperty] .Property

SDCFormProperty

• order?: int @order
• name: string @name
• propName: string @propName // this will be used as the primary identifier
• val = “” @val

SDCSection: SDCItem

abstract SDCQuestion: SDCItem

• // a question can either be a list or a text but not both

SDCDisplayItem: SDCItem

SDCListField: SDCQuestion

• minSelections = 1:int @minSelections
• maxSelections = 1:int @maxSelections
• options: [SDCListFieldItem] .List
• lookupEndPoint?: string .LookupEndPoint // this said to be mandatory, but not used in the sample xml

SDCListFieldItem: SDCItem

• textResponse?: SDCTextField .ListItemResponseField
• selectionDeselectsSiblings = false @selectionDeselectsSiblings
• // it is possible to have a list mixed of the above
• selectionDisablesChildren = false @selectionDisablesChildren

SDCTextField: SDCQuestion

• textAfterResponse?: string .TextAfterResponse
• type: string // in XML, this is specified via the tag of the child, all valid values are in A.1.6-1

SDCAnswer

• questionID // ID of the question
• uid // database
• responses : [string] // For SDCListField question, this will store the ID of the SDCListFieldItem

SDCFormResponse

• formId // UID of the form, UID is used for tracking the form version as well
• uid
• patientID: string // uid of the patient
• responses: [SDCAnswer]

[otomn]

UML: https://lucid.app/lucidchart/invitations/accept/45d9c009-8d77-44d3-881c-ec095ea82b98 Waiting for final confirmation

[otomn]

Domain model finalized for P1. Description within this thread, UML, and typescript code are all updated.

[otomn]

@umar-ahmed Please review the UML and insert to the doc.

[umar-ahmed]

@umar-ahmed Please review the UML and insert to the doc.

Will do, thank you

[otomn]

Issue reopened due to domain object update maxSelections and minSelections were on SDCNode, as those properties can appear on any object in the SDC XML as a way to set the default value for all list field question within a section, Since those fields can be determined for each question when parsing the XML, and no other SDC objects needs those fields, those fields are removed from the SDCNode, and added to SDCListField Description within this thread, UML, and typescript code are all updated. @umar-ahmed