Identifier Notation

The Clinia Platform uses the Identifier datatype to store metadata about source records and partition records. You'll find them in the meta.identifier section of a record. They can be system-generated or user-provided using Historical Import. These identifiers can be used interchangeably with a record's primary IDs when retrieving and recording by ID, that is, using the Identifier Notation:

<identifier.system>:<identifier.value>:<identifier.use>

Considering the following partition record:

{
  "id": "2kwTqjNJmSt1tRJ4sxJXDrGYqrx",
  "type": "clinic",
  "meta": {
    "identifier": [
      {
        "system": "external-system",
        "use": "external"
        "value": "II200000"
      },
      {
        "system": "source-2",
        "use": "source",
        "value": "2kvfqgdjh6PFTOfa5PXi3wQtt5g"
      },
      {
        "system": "source-1",
        "use": "source",
        "value": "2kvfpldxFQRB5HJZBoxQoofMh0Q"
      },
      {
        "system": "clinia-relative-identity",
        "use": "object-id",
        "value": "1000"
      }
    ],
    "updatedAt": "2024-08-20T15:56:19.07Z"
    "createdAt": "2024-08-20T15:56:19.07Z"
  }
}

The partition record can be retrieved using the Get Partition Resource endpoint using the primary identifier:

GET /partitions/partition-1/v1/collections/clinic/resources/2kwTqjNJmSt1tRJ4sxJXDrGYqrx

Or any of the identifiers in the meta.identifier section, using the Identifier Notation:

GET /partitions/partition-1/v1/collections/clinic/resources/external-system:II200000:external

GET /partitions/partition-1/v1/collections/clinic/resources/source-2:2kvfqgdjh6PFTOfa5PXi3wQtt5g:source

GET /partitions/partition-1/v1/collections/clinic/resources/source-1:2kvfpldxFQRB5HJZBoxQoofMh0Q:source

GET /partitions/partition-1/v1/collections/clinic/resources/clinia-relative-identity:1000:object-id