Skip to content

Data Model

You may take a look at the data model at public repository. Currently only .NET version is available, Java version is undergoing.

There is no official client library as it is expected common libraries to be used. Good example for .NET world is Refit.

Serialization

Objects are serialized as JSON with following rules:

  • Names of properties are serialized with camel casing (camelCase)
  • Properties with null values are not serialized, including arrays
  • Date and time values are always in ISO 8601 format and according to UTC (yyyy-MM-ddThh:mm:ss[.fff]Z)
  • UTF-8 is the default encoding (other encodings are possible, but not recommended)
  • Order of properties doesn't matters

Here is an example Patient object:

{
   "id": 156224,
   "pidTypeId": 0,
   "givenName": "John",
   "familyName": "Doe",
   "isMale": true,
   "dateOfBirth": "2001-03-22"
}

.