---
title: "Entity: Identifiers"
canonical: "https://wiki.patientsknowbest.com/space/api/3752722433/Entity%3A%20Identifiers"
format: markdown
---
> Macro (toc)

# Class Diagram

<u>[Identifiers](https://miro.com/app/board/uXjVMNV9xDs=/?share_link_id=549798323356)</u>

# Display

A patient’s identifiers appear in the Settings page of the patient's record.

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

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API** | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Entity: National ID** |
| **Value** `String`<br>The value of the ID. | [PID-2.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-3.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[QRD-8.1](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19)  
[PID-4.1 / ADR A19](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19) | [Patient.identifier](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Profile page |  |
| **Entity: National ID Type** |
| **Name** `String`<br>The name of this specific ID type. |  |  |  | Profile page |  |
| **Country Codes** `Enum`<br>Each National ID Type is associated with one or more countries. |  |  |  |  |  |
| **HL7 Assigning Authority** `String`<br>This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the assigning authority must match this value. | [PID-2.4](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-3.4](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-4.4 / ADR A19](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19) |  |  |  |  |
| **HL7 Type Code** `String`<br>This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the type code must match this value. | [PID-2.5](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-3.5](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-4.5 / ADR A19](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19) |  |  |  |  |
| **FHIR Identifier System** `String`<br>Used by the FHIR API to indicate that an identifier belongs to this National ID Type. |  | [Patient.identifier](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  |  |  |
| **Entity: Local ID** |
| **Value** `String`<br>The value of the ID. | [PID-2.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-3.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[QRD-8.1](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19)  
[PID-4.1 / ADR A19](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19) | [Patient.identifier](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Profile page |  |
| **Entity: Local ID Type** |
| **Public ID** `String`<br>The ID of the Local ID Type. |  | [Patient.identifier](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  |  |  |
| **Name** `String`<br>The name of this specific ID type, to help distinguish between several. For example, Hospital XYZ ID. |  |  |  | Profile page |  |
| **HL7 Assigning Authority** `String`<br>This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the assigning authority must match this value. | [PID-2.4](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-3.4](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-4.4 / ADR A19](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19) |  |  |  |  |
| **HL7 Type Code** `String`<br>This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the type code must match this value. | [PID-2.5](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-3.5](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-4.5 / ADR A19](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19) |  |  |  |  |

Entity: Organisation Level ID - Extends: Local ID

No attributes.

Entity: Organisation Level ID Type - Extends: Local ID Type

No attributes.

Entity: Team Level ID - Extends: Local ID

No attributes.

Entity: Team Level ID Type - Extends: Local ID Type

No attributes.

Entity: Country

No attributes.