Class ReviewedDocument

A document that has been reviewed through the clerk review process, and that potentially has been or will be reocrded in the court record system.

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
  ecf:ElectronicFilingCallbackMessage/ecf:ReviewedLeadDocument
- niem-profile:niem:Property:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Type:
  ecf:ReviewedDocumentType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument
- niem-profile:niem:BaseType:
  nc:DocumentType
- niem-profile:niem:Multiplicity:
- niem-profile:niem:CodeList:

Attribute documentDocketID

The identifier from the court record system used to identify the document. This attribute is populated by the MDE/process that is authorized to create docket identifiers; the attribute will not be present before that creation takes place. For example, if the clerk review process creates docket identifiers, then this attribute will be present in the RecordDocketingMessage that goes to the court record MDE. However, if the court record process creates docket identifiers, then this attribute will not be present in the RecordDocketingMessage, but will be present in subsequent callbacks. This attribute will be absent in callbacks when the ReviewedDocument was rejected, either by clerk review or the court record system.

Declaration :

- Uml : + documentDocketID : id

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
  ecf:ElectronicFilingCallbackMessage/ecf:ReviewedLeadDocument/ecf:DocumentDocketID
- niem-profile:niem:Property:
  nc:CaseDocketID
- niem-profile:niem:OldMultiplicity:
  0,1
- niem-profile:niem:Type:
  ecf:ReviewedDocumentAugmentationType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:ReviewedDocumentAugmentation/nc:CaseDocketID
- niem-profile:niem:BaseType:
  niem-xs:string
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute documentHash

A hash of the document as it appears in the court record. This attribute will be populated by either the clerk review process or the court record system. If the latter, then it will be absent in the RecordDocketingMessage. It will also be absent in callbacks for rejected documents.

Declaration :

- Uml : + documentHash : binary

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
  ecf:ElectronicFilingCallbackMessage/ecf:ReviewedLeadDocument/ecf:DocumentHashText
- niem-profile:niem:Property:
  ecf:DocumentRenditionHash
- niem-profile:niem:OldMultiplicity:
  0,1
- niem-profile:niem:Type:
  ecf:DocumentRenditionType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentRendition/ecf:DocumentHash
- niem-profile:niem:BaseType:
  nc:TextType
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute documentStatusCode

Code to describe the disposition of the document: accepted or rejected. Allowable values defined in the specification (schema).

Declaration :

- Uml : + documentStatusCode : code

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
  Genericode code list DocumentReviewStatusCode.gc
- niem-profile:niem:OldXPath:
  ecf:ElectronicFilingCallbackMessage/ecf:ReviewedLeadDocument/nc:DocumentStatus/nc:StatusText
- niem-profile:niem:Property:
  ecf:DocumentReviewStatusCode, ecf:DocumentDocketingStatusCode
- niem-profile:niem:OldMultiplicity:
  0,1
- niem-profile:niem:Type:
  ecf:DocumentStatusType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentStatus/ecf:DocumentReviewStatusCode
- niem-profile:niem:BaseType:
  c:NormalizedStringType
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:
  accepted=document was received and accepted; received=document has been received but not yet accepted; rejected=document was rejected; issued=document has been issued;

Attribute documentStatusReasonDescription

A textual description of the reason for the setting of the status in the documentStatusCode.

Declaration :

- Uml : + documentStatusReasonDescription : string

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
  nc:Document/nc:DocumentStatus/nc:StatusDescriptionText
- niem-profile:niem:Property:
  nc:StatusDescriptionText
- niem-profile:niem:OldMultiplicity:
  0,1
- niem-profile:niem:Type:
  nc:StatusType
- niem-profile:niem:XPath:
  nc:Document/nc:DocumentStatus/nc:StatusDescriptionText
- niem-profile:niem:BaseType:
  nc:TextType
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute originalDocumentID

The identifier for this document in the original ReviewFilingMessage structure. This is provided to link each filed document to a docketed document identifier in the court record.

Declaration :

- Uml : + originalDocumentID : id

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
  nc:Document/nc:DocumentIdentification
- niem-profile:niem:Property:
  nc:DocumentIdentification
- niem-profile:niem:OldMultiplicity:
  0,unbounded
- niem-profile:niem:Type:
  nc:DocumentType
- niem-profile:niem:XPath:
  nc:Document/nc:DocumentIdentification
- niem-profile:niem:BaseType:
  nc:IdentificationType
- niem-profile:niem:Multiplicity:
  1,unbounded
- niem-profile:niem:CodeList:

Attribute sealDocumentIndicator

Clerk instruction to court record system to seal this document.

Declaration :

- Uml : + sealDocumentIndicator : bool

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
  ecf:ElectronicFilingCallbackMessage/ecf:ReviewedLeadDocument/ecf:SealDocumentIndicator
- niem-profile:niem:Property:
  ecf:SealDocumentIndicator
- niem-profile:niem:OldMultiplicity:
  0,1
- niem-profile:niem:Type:
  ecf:ReviewedDocumentAugmentationType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:ReviewedDocumentAugmentation/ecf:SealDocumentIndicator
- niem-profile:niem:BaseType:
  niem-xs:boolean
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute documentStatus

A status of a document.

Declaration :

- Uml : + documentStatus : string, multiplicity : 1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
  docketcallback:RecordDocketingMessage/ecf::ReviewedLeadDocument/ecf:DocumentStatus
- niem-profile:niem:Property:
  ecf:DocumentStatus
- niem-profile:niem:OldMultiplicity:
  0,1
- niem-profile:niem:Type:
  ecf:DocumentAugmentationType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentStatus
- niem-profile:niem:BaseType:
  ecf:DocumentStatusType
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute documentReviewer

The entity that reviews and accepts or rejects a filing.

Declaration :

- Uml : + documentReviewer : string, multiplicity : 0..1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Property:
  ecf:DocumentReviewer
- niem-profile:niem:Type:
  ecf:DocumentReviewDispositionType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:ReviewedDocumentAugmentation/ecf:DocumentReviewer
- niem-profile:niem:BaseType:
  nc:EntityType
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute documentReviewStatus

The status of a document in the filing review process.

Declaration :

- Uml : + documentReviewStatus : string, multiplicity : 0..1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Property:
  ecf:DocumentReviewStatus
- niem-profile:niem:Type:
  ecf:DocumentReviewDispositionType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:ReviewedDocumentAugmentation/ecf:DocumentReviewStatus
- niem-profile:niem:BaseType:
  nc:StatusType
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute reviewedDocumentInformation

Additional document information resulting from clerk review.

Declaration :

- Uml : + reviewedDocumentInformation : , multiplicity : 1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Property:
  ecf:ReviewedDocumentAugmentationPoint, (ecf:ReviewedDocumentAugmentation)
- niem-profile:niem:Type:
  ecf:ReviewedDocumentType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:ReviewedDocumentAugmentation
- niem-profile:niem:BaseType:
  ecf:ReviewedDocumentAugmentationType
- niem-profile:niem:Multiplicity:
  0,unbounded
- niem-profile:niem:CodeList:

Attribute documentReviewDisposition

The disposition of a document after review.

Declaration :

- Uml : + documentReviewDisposition : string, multiplicity : 1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Property:
  ecf:DocumentReviewDisposition
- niem-profile:niem:Type:
  ecf:DocumentReviewType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:DocumentReviewDisposition
- niem-profile:niem:BaseType:
  ecf:DocumentReviewDispositionType
- niem-profile:niem:Multiplicity:
  1,1
- niem-profile:niem:CodeList:

Attribute reviewDisposition

The disposition of a document after review.

Declaration :

- Uml : + reviewDisposition : string, multiplicity : 1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Property:
- niem-profile:niem:Type:
  ecf:DocumentReviewDispositionType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:DocumentReviewDisposition
- niem-profile:niem:BaseType:
  structures:ObjectType
- niem-profile:niem:Multiplicity:
- niem-profile:niem:CodeList:

Attribute documentAddedInReviewIndicator

Indicator that a document was added curing clerk review

Declaration :

- Uml : + documentAddedInReviewIndicator : bool, multiplicity : 0..1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Property:
  ecf:DocumentAddedInReviewIndicator
- niem-profile:niem:Type:
  ecf:DocumentReviewDispositionType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:DocumentReviewDisposition/ecf:DocumentAddedInReviewIndicator
- niem-profile:niem:BaseType:
  niem-xs:boolean
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:

Attribute documentDocketingStatusCode

The docketing status of a document

Declaration :

- Uml : + documentDocketingStatusCode : string, multiplicity : 0..1

Stereotype: niem-profile:niem

Properties:

- niem-profile:niem:Notes:
  Genericode code list DocumentDocketingStatusCode
- niem-profile:niem:OldXPath:
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Property:
- niem-profile:niem:Type:
  ecf:DocumentStatusType
- niem-profile:niem:XPath:
  ecf:CallbackMessage/ecf:LeadDocumentReview/ecf:ReviewedDocument/ecf:DocumentAugmentation/ecf:DocumentStatus/ecf:DocumentDocketingStatusCode
- niem-profile:niem:BaseType:
  nc:StatusType
- niem-profile:niem:Multiplicity:
  0,1
- niem-profile:niem:CodeList:
  successful=document was docketed; unsuccessful=docketing of the document was not successful; not applicable=document is not appropriate for docketing