Entity: Identifiers

Class Diagram

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

Please see the manual for more information.

Entity: National ID

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
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

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
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

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
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

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
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.

			HL7 API	FHIR API		Web	Custom REST API
			(event based updates)	Facade (STU3)	Aggregated (R4)
Summary of interactions
Read				/Encounter		Events & messages
Write			A01/A02/A03/A05/A14/A08
Delete			A11/A12/A13/A38/A27 (A08 cannot be deleted)
Entity: Encounter
Encounter ID	String	A unique ID identifying this encounter. This ID will not change even if the encounter is modified.		Encounter.id
External Encounter ID	String	The ID assigned to this encounter by the source system.	PV1-19.1 (ADT)
Entity: Encounter Event - Extends: Data Point
Type	Enum	PRE_ADMIT PENDING_ADMIT ADMIT TRANSFER DISCHARGE UPDATE
Class	Enum	IN_PATIENT OUT_PATIENT AMBULATORY EMERGENCY HOME FIELD DAYTIME VIRTUAL OTHER	PV1-2.1 (ADT)	Encounter.class Encounter.classHistory		Inbox page Conversation page
Timestamp	Timestamp	The relevant timestamp will vary depending on the type of message. For HL7 ADT messages this will normally be the timestamp of the relevant event.	PV1-44.1 (ADT) EVN-3.1 (ADT) EVN-6.1 (ADT) PV1-45.1 (ADT) PV2-8.1 (ADT)	Encounter.period		Conversation page
Entity: Location
Name	String	The name.
Description	String	A brief description.	PV1-3.9 (ADT)	Encounter.location		Conversation page
Address	String	The address.
Entity: External Participant
Role	Enum	ATTENDER REFERRER CONSULTANT		Encounter.participant		Conversation page
Name	String	The name of the participant.	PV1-7 (ADT) PV1-8 (ADT) PV1-9 (ADT)	Encounter.participant		Conversation page