Updates for PersonName, QuantityRange, ResponseCode, StudyAmendment (DDF-RA #653, #648, #643, #637)

Author: ASL-rmarshall

docs/USDM_API.json

@@ -1,7 +1,9 @@
-from typing import Union, List, Literal
+from typing import Union, Literal
 from .api_base_model import ApiBaseModelWithIdNameLabelAndDesc
+from .person_name import PersonName
 
 class AssignedPerson(ApiBaseModelWithIdNameLabelAndDesc):
+  personName: PersonName
   jobTitle: str
   organizationId: Union[str, None] = None
   instanceType: Literal['AssignedPerson']

docs/USDM_API.yaml

@@ -0,0 +1,10 @@
+from typing import Union, List, Literal
+from .api_base_model import ApiBaseModelWithId
+
+class PersonName(ApiBaseModelWithId):
+    text: Union[str, None] = None
+    familyName: Union[str, None] = None
+    givenNames: List[str] = []
+    namePrefixes: List[str] = []
+    nameSuffixes: List[str] = []
+    instanceType: Literal['PersonName']

model/assigned_person.py

@@ -3,16 +3,14 @@
 from .api_base_model import ApiBaseModelWithIdNameLabelAndDesc
 from .code import Code
 from .range import Range
-from .quantity import Quantity
+from .quantity_range import QuantityRange
 from .characteristic import Characteristic
 from .comment_annotation import CommentAnnotation
 
 class PopulationDefinition(ApiBaseModelWithIdNameLabelAndDesc):
   includesHealthySubjects: bool
-  plannedEnrollmentNumberRange: Union[Range, None] = None
-  plannedEnrollmentNumberQuantity: Union[Quantity, None] = None
-  plannedCompletionNumberRange: Union[Range, None] = None
-  plannedCompletionNumberQuantity: Union[Quantity, None] = None
+  plannedEnrollmentNumber: Union[QuantityRange, None] = None
+  plannedCompletionNumber: Union[QuantityRange, None] = None
   plannedSex: Annotated[List[Code], Len(min_length=0, max_length=2)] = []
   criterionIds: List[str] = []
   plannedAge: Union[Range, None] = None

model/person_name.py

@@ -0,0 +1,9 @@
+from typing import Literal, Union
+from .api_base_model import ApiBaseModelWithId
+from .quantity import Quantity
+from .range import Range
+
+class QuantityRange(ApiBaseModelWithId):
+  quantity: Union[Quantity, None] = None
+  range: Union[Range, None] = None
+  instanceType: Literal['QuantityRange']

model/population_definition.py

@@ -1,8 +1,8 @@
 from typing import Literal
-from .api_base_model import ApiBaseModelWithId
+from .api_base_model import ApiBaseModelWithIdNameAndLabel
 from .code import Code
 
-class ResponseCode(ApiBaseModelWithId):
+class ResponseCode(ApiBaseModelWithIdNameAndLabel):
   isEnabled: bool
   code: Code
   instanceType: Literal['ResponseCode']

model/quantity_range.py

@@ -1,10 +1,9 @@
 from typing import Literal, Union
 from .api_base_model import ApiBaseModelWithIdNameLabelAndDesc
 from .quantity import Quantity
-from .range import Range
+from .quantity_range import QuantityRange
 
 class Strength(ApiBaseModelWithIdNameLabelAndDesc):
+  numerator: QuantityRange
   denominator: Union[Quantity, None] = None
-  numeratorQuantity: Union[Quantity, None] = None
-  numeratorRange: Union[Range, None] = None
   instanceType: Literal['Strength']

model/response_code.py

@@ -1,5 +1,5 @@
 from typing import Union, List, Literal
-from .api_base_model import ApiBaseModelWithId
+from .api_base_model import ApiBaseModelWithIdNameLabelAndDesc
 from .study_amendment_reason import StudyAmendmentReason
 from .study_change import StudyChange
 from .study_amendment_impact import StudyAmendmentImpact
@@ -8,7 +8,7 @@
 from .governance_date import GovernanceDate
 from .comment_annotation import CommentAnnotation
 
-class StudyAmendment(ApiBaseModelWithId):
+class StudyAmendment(ApiBaseModelWithIdNameLabelAndDesc):
   number: str
   summary: str
   primaryReason: StudyAmendmentReason