---
title: "Entity: Reference Datum & Coding Match"
canonical: "https://wiki.patientsknowbest.com/space/api/3765338113/Entity%3A%20Reference%20Datum%20%26%20Coding%20Match"
format: markdown
---
> Macro (toc)

# Class Diagram

<u>[Reference Datum & Coding Match](https://miro.com/app/board/uXjVMzAXPm0=/?share_link_id=352635420707)</u>

# Display

Pre-defined customer reference sets are managed by the Organisation administrator, and represented as instances of [[Reference Datum]].

PKB-managed reference sets are managed by PKB and represented as instances of [[Coding Match]].

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fappointments&sa=D&sntz=1&usg=AOvVaw1zS9WQmwrWJmY7tDKkmPSr)<u>[the manual](https://manual.patientsknowbest.com/organisation-administrator/code-sets)</u> for more information.

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  |  |  |  |  |
| Read |  |  | [/ValueSet](https://wiki.patientsknowbest.com/space/api/3711172639/Aggregated+ValueSet) | [Code sets](https://manual.patientsknowbest.com/organisation-administrator/code-sets) |  |
| Update |  |  |  |  |  |
| Delete |  |  |  |  |  |
| **Entity: Reference Set** |
| **Public ID** `String` |  |  |  |  |  |
| **Aggregated ID** `String` |  |  | This is the resource id. |  |  |
| **Type **`Enum`<br>- ORDER_SERVICE
- HOSPITAL_SERVICE
- UNIT
- LAB_DISCIPLINE |  |  | Included in the url and compose.include.system elements. |  |  |
| **Entity: Reference Datum** |
| **Legacy ID** `String` |  |  |  |  |  |
| **Public ID** `String` |  |  |  |  |  |
| **Value **`String` |  |  | compose |  |  |
| **Text **`String` |  |  | compose |  |  |
| **Privacy Label** `Enum`<br>- GENERAL_HEALTH
- MENTAL_HEALTH
- SEXUAL_HEALTH
- SOCIAL_CARE |  |  | [privacy-label](http://fhir.patientsknowbest.com/structuredefinition/privacy-label) |  |  |


|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  |  |  |  |  |
| Read |  |  | [/ValueSet](https://wiki.patientsknowbest.com/space/api/3711172639/Aggregated+ValueSet) |  |  |
| Update |  |  |  |  |  |
| Delete |  |  |  |  |  |
| **Entity: Coding Match** |
| **Legacy ID** `String` |  |  |  |  |  |
| **Public ID** `String` |  |  |  |  |  |
| **Aggregated ID** `String` |  |  | This is the resource ID. |  |  |
| **Type** `Enum` |  |  | [data-type](http://fhir.patientsknowbest.com/structuredefinition/data-type) |  |  |
| **Exclude** `Boolean` |  |  | [sensitive-exclusion-code](http://fhir.patientsknowbest.com/structuredefinition/sensitive-exclusion-code) |  |  |
| **Code** `String` |  |  | compose<br>Also included in the url and compose.include.system elements. |  |  |
| **System** `String` |  |  | Included in the url and compose.include.system elements. |  |  |
| **Text** `String` |  |  | compose |  |  |
| **Privacy Label** `Enum`<br>- GENERAL_HEALTH
- MENTAL_HEALTH
- SEXUAL_HEALTH
- SOCIAL_CARE |  |  | [privacy-label](http://fhir.patientsknowbest.com/structuredefinition/privacy-label) |  |  |
| **Parent** `Ref: [[Coding Match.Legacy ID]]` |  |  |  |  |  |
| **Created** `Timestamp` |  |  |  |  |  |