...
Please see the manual for more information.
Mappings
Entity: National ID
Attribute
Type
Description
HL7 API | FHIR API | |
Web | Custom REST API | ||
Facade (STU3) | |||
Aggregated ( |
R4) | |||||
Entity: National ID | |||||
Value | |||||
The value of the ID. | Profile page | ||||
Entity: National ID Type | |||||
...
Type
Description
HL7 API
FHIR API (Facade)
Custom REST API
Web (Patient)
Name |
The name of this specific ID type. |
|
| Profile page | ||
Country Codes |
Each National ID Type is associated with one or more countries. |
|
| ||||
HL7 Assigning Authority |
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. |
| ||||
HL7 Type Code |
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. |
| ||||
FHIR Identifier System |
Used by the FHIR API to indicate that an identifier belongs to this National ID Type. |
|
Entity: Local ID | |||||
...
Attribute
Type
Description
HL7 API
FHIR API (Facade)
Custom REST API
Value | |||||
The value of the ID. | Profile page | ||||
Entity: Local ID Type | |||||
Attribute
Type
Description
HL7 API
FHIR API (Facade)
Custom REST API
Web (Patient)
Public ID |
The ID of the Local ID Type. |
Name |
The name of this specific ID type, to help distinguish between several. For example, Hospital XYZ ID. |
Profile page | ||||
HL7 Assigning Authority |
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. |
HL7 Type Code |
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. |
Entity: Organisation Level ID - Extends: Local ID
...
Entity: Country
No attributes.
...
HL7 API
...
FHIR API
...
Web
...
Custom REST API
...
(event based updates)
...
Facade (STU3)
...
Aggregated (R4)
...
Summary of interactions
...
Read
...
...
...
Write
...
...
Delete
...
(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.
...
...
External Encounter ID
...
String
...
The ID assigned to this encounter by the source system.
...
...
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
...
...
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.
...
...
...
Conversation page
...
Entity: Location
...
Name
...
String
...
The name.
...
Description
...
String
...
A brief description.
...
...
...
Conversation page
...
Address
...
String
...
The address.
...
Entity: External Participant
...
Role
...
Enum
...
ATTENDER
REFERRER
CONSULTANT
...
.
...
Conversation page
...
Name
...
String
...
The name of the participant.
...
PV1-7 (ADT)
PV1-8 (ADT)
PV1-9 (ADT)
...
...