References and identifiers
Actor references are under review. This page describes the current draft. Read the development status before relying on the actor model for an integration.
A record's identity, its business identifier and its links to other records have different purposes.
| Item | Example | Meaning |
|---|---|---|
| Resource ID | Practitioner/123 |
Identifies a resource within a FHIR service and resource type. |
| Business identifier | An assigning system and a value |
Identifies a person or record in a particular source namespace. |
| Profile canonical | The URL in meta.profile |
Identifies the rules the resource claims to follow, not the patient or record. |
Linking shared resources
Patient, Practitioner, PractitionerRole, Organization and Location can be reused across records. Each DigiDOT reference field specifies its permitted targets and reference form. For example, no-basis-Practitioner represents the clinician; the reference field describes whether that person requested, recorded, performed or authored the information.
For a link to a separately stored resource, use a literal reference. Within the same FHIR service, a relative reference such as Practitioner/planning-practitioner avoids an environment-specific service URL. The following recorder fragment illustrates this form:
"recorder": { "reference": "Practitioner/planning-practitioner", "type": "Practitioner", "display": "Robin Taylor" }
The same pattern applies to the care provider and clinic, for example Organization/planning-county and Location/planning-location in the example scenario.
Follow the reference rules on the consuming field. Where reference is 1..1 and identifier is 0..0, identifier-only references and display alone cannot satisfy the field. These fields in the planning and clinical profiles also explicitly exclude contained references starting with #. Where an Annotation permits both authorString and authorReference, constraints on the Reference option do not remove the string option.
For literal references, HPR, national identity numbers and organisation numbers belong in the target resource's identifier, with the correct assigning system. They are not substituted for its resource ID. Adding a later verified identifier to the same Practitioner preserves the existing clinical references. Reference.type, when supplied, is a resource type such as Practitioner, not a profession.
Medication and allergy references
The literal-reference restrictions above are not universal across DigiDOT. AllergyIntolerance permits literal and identifier-only references for recorder, asserter and the Reference option of note.author[x]. MedicationRequest permits identifier-only references for requester and note.author[x], and MedicationStatement for informationSource, when supported by the receiving system and the exchange agreement.
An identifier-only reference uses Reference.identifier.system and value. The permitted target type still applies. A targetProfile constraint alone does not require Reference.reference or prohibit Reference.identifier; use the constraints and comments on the actual field. The exchange agreement must define accepted identifiers and their handling.
Reuse or register when linking stored resources
- Find a verified match in central storage using the relevant identifier and namespace. Reuse the existing resource and its resource ID.
- If no resource exists, register it through the agreed storage process, following the relevant no-basis profile. Ambiguous matches must be reconciled; do not choose the first result or create a duplicate.
- Use the stored resource's reference in the clinical record. The receiving service must check that the target exists and conforms to an allowed profile.
Profile validation checks the applicable reference constraints. It does not perform identity matching or prove that a target exists on a particular server. Registration, matching, target resolution and access handling belong to the storage integration.
Person, qualification and participation
| Information | Where it belongs | What it means |
|---|---|---|
| HPR or another applicable national person identifier | Practitioner.identifier |
Identifies the person; HPR uses urn:oid:2.16.578.1.12.4.1.4.4. |
| Professional qualification | Practitioner.qualification.code |
no-basis supports national category, approval and specialty codes. A reference does not add a qualification binding. |
| Organisational role | PractitionerRole |
Connects a person with an organisation and, where recorded, a location or function. |
| Participation in this contact or booking | Encounter.participant.type or Appointment.participant.type |
Describes how the participant took part; it is not a professional qualification. |
The current Appointment, Encounter, EpisodeOfCare and ServiceRequest profiles permit no-basis-PractitionerRole in selected fields. Finance drafts also retain role targets. Use it only where the target field permits it and the source records that organisational context. The example scenario includes one optional clinic assignment, reused by both Appointment and Encounter participants. It connects Robin to the county and clinic; findings, procedures and journal-note authors still reference Practitioner directly. The national profile is reusable across systems; a role instance describes a particular assignment and can be reused across patients and visits. A separate role record is not required by these profiles.
Example: national personnel category on Practitioner
no-basis-Practitioner supports Kategori helsepersonell (9060) in qualification.code. The following fragment represents the category Tannlege (TL), with an English explanatory text:
"qualification": [{ "code": { "coding": [{ "system": "urn:oid:2.16.578.1.12.4.1.1.9060", "code": "TL", "display": "Tannlege" }], "text": "Dentist" } }]
Populate qualification and approval information from a verified source. An example category is not evidence of an individual's current registration or authorisation. National category codes are listed in the Head message standard, code system 9060.
The local Personnel Types — Retired comparison list is retired and has no active DigiDOT binding. Reuse the relevant national qualification, specialty or function terminology through no-basis when the personnel model is agreed. Suitable SNOMED CT practitioner-role concepts are another standard source. These represent different information needs; do not insert personnel codes into a Reference or infer access permissions from them.
Preserving source identity
Keep a known stable source business identifier with its assigning namespace. A booking identifier identifies the booking, not its patient; an episode identifier is not shared by every record in that episode. Preserve the same identity when resubmitting the same logical record.
Appointment, Encounter, EpisodeOfCare, ServiceRequest, Condition, Procedure and Observation permit business identifiers to be absent. When supplied, their profiles require both system and value. Other profiles have their own requirements: Dental Contact Note, for example, requires its source note identifier.
Do not fabricate source identifiers to fill optional fields. Resource-ID assignment, lookups, duplicate prevention and creation/update permissions belong to the integration agreement. Adding a later verified identifier to the same correctly matched Practitioner does not require replacing the person's clinical references.
Bundles in the examples
The main clinical walkthroughs use collection Bundles: containers for reading related records together. They do not request server writes. A transaction Bundle represents an atomic set of server interactions and requires request instructions. References to new entries can match their Bundle.entry.fullUrl values, for example a urn:uuid: value.
Use the focused DENT transaction examples in Examples in JSON for the draft submission format. Collections and complete test-data imports are not ready-made DENT transaction requests. Referenced MPI Patients are not submitted as DENT writes.
References: FHIR R4 references, resource identity and transactions.