Naming Conventions
Last updated
Was this helpful?
Last updated
Was this helpful?
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 instance, CD.COM.01 identifier_type defines a code directory (CD) that 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) that is specific to the CRVS (CRVS) and SP-MIS interface 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.
ASM
assumption
EXC
exception
PRS
process
DO
data object
CD
code directory
DT
data type
DF
data format
API
application programming interface
Depending on whether one part of a standard can be used across 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.
COM
common
CRVS
civil registration and vital statistics
This can either be .API for the API specific code directories/error codes, or a consecutive numbering starting from 01.