LogoLogo
WebsiteGitHubSlack
Common v1.0.0
Common v1.0.0
  • Digital Convergence Initiative (DCI)
    • About DCI
    • DCI Objective
    • Terminology
    • Acronyms
    • Licensing
  • Standards for Interoperability Interfaces
    • Structure & Versioning of the Standards
    • Naming Conventions
    • Common Assumptions
    • Common Exception Handling
    • Common Standards for Interoperability Interfaces
      • Process
        • PRS.COM.01 Standards Creation
      • Data
        • File Type: JSON-LD
        • Data Objects
          • DO.COM.01 Identifier
          • DO.COM.02 Name
          • DO.COM.03 Address
          • DO.COM.04 GeoLocation
          • DO.COM.05 GooglePlusCode
          • DO.COM.06 GeoShape
          • DO.COM.07 Place
        • Code Directory
          • CD.COM.01 identifier_type
          • CD.COM.02 marital_status
          • CD.COM.03 sex
          • CD.COM.04 vital_event
          • CD.COM.05 country
          • CD.COM.06 currency
          • CD.COM.07 relationship_type
          • CD.COM.08 ethnicity
          • CD.COM.09 nationality
          • CD.COM.10: functional_limitation _type
          • CD.COM.11: functional_limitations_level
          • CD.COM.12: payment_status
          • CD.COM.13: group_type
          • CD.COM.14: language_code
          • CD.COM.15: education_level
          • API specific
            • CD.COM.API.01 api_error_codes_common
            • CD.COM.API.02 api_error_codes_search_on_search
            • CD.COM.API.03 api_error_codes_subscribe_unsubscribe
            • CD.COM.API.04 api_error_codes_status_on_status
        • Data Types and Formats
          • DT.COM.01 object
          • DT.COM.02 string
            • Data Formats
              • DF.COM.STRING.01 date_time
              • DF.COM.STRING.02 phone_number
              • DF.COM.STRING.03 distance
              • DF.COM.STRING.04 country_code
              • DF.COM.STRING.05 geo_line
              • DF.COM.STRING.06 polygon
              • DF.COM.STRING.07 email
              • DF.COM.STRING.08 currency
          • DT.COM.03 integer
          • DT.COM.04 decimal
          • DT.COM.05 array
          • DT.COM.06 boolean
        • Data Governance
      • API
        • Design Principles
        • Versioning
        • Methods
          • API.COM.01.ASY Search (Async approach)
          • API.COM.01.SYN Search (Sync approach)
          • API.COM.02 Event Subscription
          • API.COM.03 Event Notification
          • API.COM.04.ASY Status (Async approach)
          • API.COM.04.SYN Status (Sync approach)
    • CRVS with SP-MIS Standards
    • Social Registry v1.0.0
    • Integrated Beneficiary Registry v1.0.0
    • Disability Registry v1.0.0.
    • Farmer Registry v1.0.0.
  • Resources
    • Website
    • GitHub
    • API Documentation
    • Discussion Forum
    • Guide Book
    • References
Powered by GitBook
On this page
  • Structure
  • Common and Interface-Specific Standards
  • Three Parts — Process, Data, API
  • Versioning

Was this helpful?

  1. Standards for Interoperability Interfaces

Structure & Versioning of the Standards

Last updated 1 month ago

Was this helpful?

Structure

Common and Interface-Specific Standards

Some standards can be reused and are valid across multiple interfaces (stored in the common space/main page that you are looking at), others are valid only for their own respective interface (stored in the respective space of their interface linked on the left, e.g. for CRVS, specific in CRVS with SP-MIS standards).

For instance, a name may always be defined in the same manner for multiple different workstreams, which would classify it as common, whereas a person could be defined slightly differently, depending on the use case (payment, CRVS, social registry, etc.), hence, it would fall under interface-specific standards and be stored in the respective interface space.

Three Parts — Process, Data, API

Each standard is split into three main parts:

Versioning

The overall standards are versioned directly in the GitBook via the naming of the space. Hence, CRVS v1.0 is the first version of the CRVS with SP-MIS standards.

The versioning of the APIs is explained in the Design Principles section.

You can find all previous versions of the standards in the respective 'Previous Versions' page at the very end of each space. For instance, this is the page of the CRVS with SP-MIS standards.

Previous Versions
Cover

Process

standards serve as a proof of concept of the implemented data and API interface-specific standards. Hence, when the standards are implemented for a social protection use case—what would the process flow look like? These process flows provide examples of the most relevant implementation use cases, but are of course not exhaustive.

Cover

Data

Cover

API

standards contain the different specifications per interface that are needed for information exchange. Valid across all interfaces, API standards deal with considerations regarding design principles, including security and versioning.

standards ensure a shared language and format for data used across diverse systems and by different organisations. They are further divided into the such as, e.g. a person (containing attributes like first name, sex, etc.),(containing a list of possible values for an attribute like marital status) and (e.g. whether it is a string or a decimal and for some types, e.g. a string, how to format them, e.g. a date).

Data Types and Formats
Data Object
Code Directory