Naming Conventions
Last updated
Last updated
The DCI case convention is inspired by the one used for the OpenID standards which is snake case.
As a consequence, snake case is used as a case convention for everything except for the data object title.
Reference to the OpenID naming practice can be found under this link.
For the name of the data objects, e.g. CRVSPerson, CamelCase is used.
In order to uniquely identify different parts of the standards a unique label is assigned to a part created.
For intance, CD.COM.01 identifier_type
defines a Code Directory (CD) which can be a common (COM) data object across multiple interfaces and is the 1st (01) code directory defined in that common interface/ GitBook space.
Another example
DO.CRVS.01 crvs_person
defines a Data Object (DO) which is specific to the CRVS (CRVS) and SP-MIS Interace and is the 1st (01) data object defined for that specific CRVS and SP-MIS interface/ GitBook space.
This defines which part of the standard we are looking at.
Depending on whether one part of a standard can be used accross multiple interfaces or not as explained in the Structure & Versioning of the Standards the respective space/ interface is indicated in the second part of the label.
This can either be .API fo the API specific code directories/ error codes, or a consecutive numbering starting from 01.
Abbreviation | Meaning |
---|---|
Abbreviation | Meaning |
---|---|
ASM
Assumption
EXC
Exception
PRS
Process
DO
Data Object
CD
Code Directory
DT
Data Type
DF
Data Format
API
API/ Application Programming Interface
COM
Common
CRVS
CRVS/ Civil Registration and Vital Statistics