Entity: Identifiers

Class Diagram

Identifiers

Display

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

Please see the manual for more information.

Mappings

 

HL7 API

FHIR API

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Entity: National ID

Value String

The value of the ID.

PID-2.1
PID-3.1
QRD-8.1
PID-4.1 / ADR A19

Patient.identifier

 

Profile page

 

Entity: National ID Type

Name String

The name of this specific ID type.

 

 

 

Profile page

 

Country Codes Enum

Each National ID Type is associated with one or more countries.

 

 

 

 

 

HL7 Assigning Authority String

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
PID-3.4
PID-4.4 / ADR A19

 

 

 

 

HL7 Type Code String

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
PID-3.5
PID-4.5 / ADR A19

 

 

 

 

FHIR Identifier System String

Used by the FHIR API to indicate that an identifier belongs to this National ID Type.

 

Patient.identifier

 

 

 

Entity: Local ID

Value String

The value of the ID.

PID-2.1
PID-3.1
QRD-8.1
PID-4.1 / ADR A19

Patient.identifier

 

Profile page

 

Entity: Local ID Type

Public ID String

The ID of the Local ID Type.

 

Patient.identifier

 

 

 

Name String

The name of this specific ID type, to help distinguish between several. For example, Hospital XYZ ID.

 

 

 

Profile page

 

HL7 Assigning Authority String

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
PID-3.4
PID-4.4 / ADR A19

 

 

 

 

HL7 Type Code String

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
PID-3.5
PID-4.5 / ADR 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.