Document descriptors (title, type description, etc.) for the Document. This is meant to include all the information about the document that is needed to index it into the Case Management System and enter it into the Document Management System.
Attribute additionalMetadata |
Additional metadata for a filed ocument.
Declaration :
- Uml : + additionalMetadata : string
Stereotype: niem-profile:niem
Properties:
Attribute affectedPartyID |
Identifier recognized by the court as being unique within this case,and used to identify a party other than the filer who is affected by the document.
Declaration :
- Uml : + affectedPartyID : id
Stereotype: niem-profile:niem
Properties:
Attribute connectedDocumentSequenceNumber |
Indicates the order (assigned by the filer) of the supporting document within the context of its parent lead document.
Declaration :
- Uml : + connectedDocumentSequenceNumber : int
Stereotype: niem-profile:niem
Properties:
Attribute documentDescription |
Name of document given by filer. Intended to supplement what is contained in the document type identifier property.
Declaration :
- Uml : + documentDescription : string
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
nc:Document/nc:DocumentDescriptionText
- niem-profile:niem:Property:
nc:DocumentDescriptionText
- niem-profile:niem:OldMultiplicity:
0,1
- niem-profile:niem:Type:
nc:DocumentType
- niem-profile:niem:XPath:
nc:Document/nc:DocumentDescriptionText
- niem-profile:niem:BaseType:
nc:TextType
- niem-profile:niem:Multiplicity:
0,1
- niem-profile:niem:CodeList:
A unique identifier for the document within this message. This is the identifier for a "whole" document (if that document is split into parts).
Declaration :
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/ncDocumentIdentification
- niem-profile:niem:BaseType:
nc:IdentificationType
- niem-profile:niem:Multiplicity:
1,unbounded
- niem-profile:niem:CodeList:
Attribute documentProducerDescriptionText |
Application and version used to create the document. Optional attribute.
Declaration :
- Uml : + documentProducerDescriptionText : string
Stereotype: niem-profile:niem
Properties:
Attribute documentRedactionRequiredIndicator |
Indicator by the filer that the document must be redacted by the court.
Declaration :
- Uml : + documentRedactionRequiredIndicator : bool
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/ecf:RedactionRequiredIndicator
- niem-profile:niem:Property:
ecf:RedactionRequiredIndicator
- niem-profile:niem:OldMultiplicity:
0,1
- niem-profile:niem:Type:
ecf:DocumentAugmentationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:RedactionRequiredIndicator
- niem-profile:niem:BaseType:
niem-xs:boolean
- niem-profile:niem:Multiplicity:
0,1
- niem-profile:niem:CodeList:
Relation documentRenditionMetadata (<directional aggregation>) |
Descriptors for a rendition of a Document. This is meant to include all the information about the document that is needed to enter it into the Document Management System.
Declaration :
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
- niem-profile:niem:Property:
ecf:DocumentRendition
- niem-profile:niem:OldMultiplicity:
- niem-profile:niem:Type:
ecf:DocumentAugmentationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition
- niem-profile:niem:BaseType:
ecf:DocumentRenditionType
- niem-profile:niem:Multiplicity:
0,unbounded
- niem-profile:niem:CodeList:
Attribute documentSensitivityCode |
A code indicating the level of security associated with a document. By default, a document will be considered to be "public" unless otherwise defined by court policy. Other sensitivity levels may include "private", in which the document is only viewable by parties in the case, and "protected" in which the document is viewable by a broader set of parties and actors associated with the case.
Declaration :
- Uml : + documentSensitivityCode : code
Stereotype: niem-profile:niem
Properties:
Attribute documentTypeCode |
The docket code used by the court for the type of document submitted. Allowable values set forth in Court Policy.
Declaration :
- Uml : + documentTypeCode : code
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
Genericode code list RegisterActionDescriptionCode.gc
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/j:RegisterActionDescriptionText
- niem-profile:niem:Property:
ecf:RegisterActionDescriptionCode
- niem-profile:niem:OldMultiplicity:
1,1
- niem-profile:niem:Type:
ecf:DocumentAugmentationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:RegisterActionDescriptionCode
- niem-profile:niem:BaseType:
nc:TextType
- niem-profile:niem:Multiplicity:
0,1
- niem-profile:niem:CodeList:
Court-specific code list
Attribute filingAttorneyID |
Identifier recognized by the court as being unique within this case,and used to identify the entity who is filing this document.
Declaration :
- Uml : + filingAttorneyID : id
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/ecf:FilingAttorneyID
- niem-profile:niem:Property:
ecf:ParticipantID
- niem-profile:niem:OldMultiplicity:
1,1
- niem-profile:niem:Type:
ecf:PersonAugmentationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentFiler/ecf:EntityPerson/ecf:PersonAugmentation/ecf:ParticipantID
- niem-profile:niem:BaseType:
nc:IdentificationType
- niem-profile:niem:Multiplicity:
1,1
- niem-profile:niem:CodeList:
Identifier recognized by the court as being unique within this case,and used to identify the entity on whose behalf this document is being filed.
Declaration :
- Uml : + filingPartyID : id
Stereotype: niem-profile:niem
Properties:
Attribute parentDocumentID |
Only present for supporting documents; indicates the identifier of the corresponding lead document.
Declaration :
- Uml : + parentDocumentID : id
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/ecf:ParentDocumentReference
- niem-profile:niem:Property:
nc:DocumentAssociation
- niem-profile:niem:OldMultiplicity:
0,1
- niem-profile:niem:Type:
ecf:DocumentAugmentationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/nc:DocumentAssociation/nc:PrimaryDocument
- niem-profile:niem:BaseType:
nc:DocumentAssociationType
- niem-profile:niem:Multiplicity:
0,1
- niem-profile:niem:CodeList:
Attribute priorRelatedDocumentID |
An identifier of a related document that was previously filed in this case. For instance, the document to which this document is a response.
Declaration :
- Uml : + priorRelatedDocumentID : id
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/ecf:PriorRelatedDocumentID
- niem-profile:niem:Property:
@nc:PrimaryDocument
- niem-profile:niem:OldMultiplicity:
0,1
- niem-profile:niem:Type:
nc:DocumentAssociationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/nc:DocumentAssociation/nc:PrimaryDocument, nc:SecondaryDocument
- niem-profile:niem:BaseType:
nc:DocumentType
- niem-profile:niem:Multiplicity:
0,1
- niem-profile:niem:CodeList:
Attribute relatedDocument |
A related document that was previously filed in this case. For instance, the document to which this document is a response.
Declaration :
- Uml : + relatedDocument : , multiplicity : *
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/ecf:PriorRelatedDocumentID
- niem-profile:niem:OldMultiplicity:
0,1
- niem-profile:niem:Property:
nc:DocumentAssociationAugmentationPoint, (ecf:DocumentAssociationAugmentation)
- niem-profile:niem:Type:
nc:DocumentAssociationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/nc:DocumentAssociation/ecf:DocumentAssociationAugmentation
- niem-profile:niem:BaseType:
ecf:DocumentAssociationAugmentationType
- niem-profile:niem:Multiplicity:
1,1
- niem-profile:niem:CodeList:
Attribute relatedDocumentType |
A type of related document that was previously filed in this case. For instance, the document to which this document is a response.
Declaration :
- Uml : + relatedDocumentType : string, multiplicity : 0..1
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
Genericode code list DocumentRelatedCode.gc
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/ecf:PriorRelatedDocumentID
- niem-profile:niem:OldMultiplicity:
0,1
- niem-profile:niem:Property:
ecf:DocumentRelatedCode
- niem-profile:niem:Type:
ecf:DocumentAssociationAugmentationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/nc:DocumentAssociation/ecf:DocumentAssociationAugmentation/ecf:DocumentRelatedCode
- niem-profile:niem:BaseType:
niem-xs:normalizedString
- niem-profile:niem:Multiplicity:
1,1
- niem-profile:niem:CodeList:
parent;prior-related;reviewed
Attribute specialHandlingInstructions |
Any additional instructions for printing of a document (such as printing on front and back of the same page or printing on a particular color paper).
Declaration :
- Uml : + specialHandlingInstructions : string
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentMetadata/ecf:SpecialHandlingIndicator
- niem-profile:niem:Property:
ecf:SpecialHandlingInstructionsText
- niem-profile:niem:OldMultiplicity:
0,1
- niem-profile:niem:Type:
ecf:DocumentAugmentationType
- niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:SpecialHandlingInstructionsText
- niem-profile:niem:BaseType:
nc:TextType
- niem-profile:niem:Multiplicity:
0,1
- niem-profile:niem:CodeList:
Attribute documentFileControlNumber |
A file control number associated with a document.
Declaration :
- Uml : + documentFileControlNumber : , multiplicity : 0..1
Stereotype: niem-profile:niem
Properties:
Attribute documentCategory |
A categorization of a document.
Declaration :
- Uml : + documentCategory : string, multiplicity : *
Stereotype: niem-profile:niem
Properties:
- niem-profile:niem:Notes:
- niem-profile:niem:OldXPath:
nc:Document/nc:DocumentCategoryText
- niem-profile:niem:OldMultiplicity:
0,unbounded
- niem-profile:niem:Property:
nc:DocumentCategoryAbstract, (nc:DocumentCategoryText)
- niem-profile:niem:Type:
nc:DocumentType
- niem-profile:niem:XPath:
nc:Document/nc:DocumentCategoryText
- niem-profile:niem:BaseType:
nc:TextType
- niem-profile:niem:Multiplicity:
0,unbounded
- niem-profile:niem:CodeList:
The title of a document.
Declaration :
- Uml : + documentTitle : , multiplicity : 0..1
Stereotype: niem-profile:niem
Properties: