Norwegian base profiles
Actor references are under review. This page describes the current draft. Read the development status before relying on the actor model for an integration.
The current draft references and inherits definitions from hl7.fhir.no.basis version 2.2.2. Each link opens that national definition. Reference targets permitted by a profile are not automatically required records in an EHR.
Which definition each DigiDOT profile builds on
The base of a profile is recorded in its StructureDefinition.baseDefinition. It determines which constraints DigiDOT inherits. The version shown on a DigiDOT profile is its own revision, not the version of the base package.
The Profile guide lists the actual base of each profile. The individual guidance pages explain the choice where it affects DigiDOT modelling.
See the FHIR R4 profiling rules and the no-basis 2.2.2 package for the inherited constraints.
Reference targets are a separate choice from inheritance. The current clinical profiles reference stored no-basis Patient, RelatedPerson, Practitioner, PractitionerRole, Organization and Location resources where their fields permit them. A draft DigiDOT Patient profile adds non-overlapping health-group periods and does not replace those reference targets. See Health groups for the history model and the API adoption decision.
Referenced resources
These profiles are used as reference targets. Each DigiDOT field specifies which targets it permits.
| Profile | Use in DigiDOT | Definition |
|---|---|---|
| no-basis-Patient | Patient identity for the dental record. | Open profile |
| no-basis-RelatedPerson | Parents and other related people represented as identifiable participants or information sources. See the guidance below. | Open profile |
| no-basis-Practitioner | The healthcare professional who records, requests or provides care. | Open profile |
| no-basis-PractitionerRole | A professional role and its organisational context, where the field permits it. | Open profile |
| no-basis-Organization | The organisation responsible for care or the record. | Open profile |
| no-basis-Location | A clinic or treatment location. | Open profile |
| no-basis-DocumentReference | Patient documents and attachments used by Dental Contact Note, ServiceRequest, Condition, Observation and Procedure. | Open profile |
For PDF and image metadata, file access and the permitted clinical links, see Documents and attachments.
Parents and other related people
Reuse no-basis RelatedPerson when a parent or another related person needs a record that clinical resources can reference. This target is already permitted by DigiDOT Appointment, Encounter and several profiles for reported information. For example, a mother accompanying her child can be referenced as a participant, while information she reports can retain her as its source. See Profile connections for the permitted links.
For contact details alone, such as whom to telephone about an appointment, use Patient.contact. FHIR R4 distinguishes this contact role from RelatedPerson; the same person may serve both purposes.
The national profile includes existing terminology for family relationships and parental responsibility. Being a parent and having parental responsibility are separate facts. Preserve the relationship supplied by the source rather than infer one from the other. Relationships are expressed from the related person to the patient: for a mother linked to her child, the relationship is mother. Mapping from FREG must respect this direction.
No separate DigiDOT profile or relationship CodeSystem is proposed. Source ownership and update responsibility still need to be agreed with the MPI/EHR integration. A relationship record alone does not grant access to the child's health record.
Documents and attachments
Reuse no-basis DocumentReference from hl7.fhir.no.basis#2.2.2 for PDFs, source reports and ordinary image attachments. No separate DigiDOT DocumentReference profile or local document-type CodeSystem is introduced. The national profile remains broad; the conventions below describe the proposed patient-document exchange contract and are not additional machine-enforced constraints in that profile.
| Information | FHIR element and use |
|---|---|
| Patient | subject: reference the stored patient. Do not attach another patient's document to a clinical record. |
| Document identity and lifecycle | masterIdentifier identifies the document version; status describes the reference and docStatus the document itself. |
| Document type | type: use the required national document-type ValueSet when this field is populated. The example uses B02-2 (Journalnotat); select the type from the document's meaning, not its file extension. |
| Source and time | Preserve known author, custodian, date and content.attachment.creation. date is registration of the reference; attachment creation concerns the file. Do not invent unknown source authors. |
| Clinical context | context.encounter can identify the relevant Encounter or EpisodeOfCare when applicable. Patient documents may exist independently of an Encounter. |
| File | content.attachment describes MIME type, title and, when known, size and integrity hash. url identifies retrievable file content, for example Binary/examination-source-pdf. It is not a database row ID or local filesystem path. |
Links from clinical records
| Profile field | Use |
|---|---|
Composition.section.entry (Dental Contact Note) |
A document relevant to the authored narrative. |
ServiceRequest.supportingInfo |
A source document that supports the requested service. |
Condition.evidence.detail |
A document that actually supports the finding or diagnosis; DigiDOT Observation remains permitted as well. |
Observation.derivedFrom |
The source document or image from which the result was obtained. It is not a general attachment link or an output report. |
Procedure.report |
A report produced from the performed procedure. It is not the original referral or an unrelated image. |
Each link is optional; do not create or duplicate a document just to populate it. The clinical links use literal resource references. An Encounter does not need a new attachment extension: the document's context.encounter supplies the context. The receiving service must check the referenced resource, its permitted profile and patient consistency.
Example and file access
Open the complete synthetic document-attachment example (JSON). It extends the two-visit example with three PDF documents and demonstrates all five clinical links. The original periodontal chart is the source for the structured measurement; the treatment report is an output of the Procedure. All people and data are fictional.
The example uses separate FHIR Binary resources and DocumentReference.content.attachment.url. Binary.securityContext points to the associated DocumentReference, providing context for authorization; the server must enforce access rules. This field alone does not grant or restrict access. The binary bytes are base64-encoded only for the JSON example.
HAPI may store the bytes in its built-in database binary store. That internal table is not part of the FHIR information model. HAPI's custom binary-access operations provide another upload/download path, but the API contract must specify which path clients use. Do not assume custom operations are portable to every FHIR server.
Keep file content stable once it is referenced by a journal entry. A replacement document should receive a new file identity and DocumentReference, with relatesTo.code = replaces and a reference to its predecessor when appropriate. Preserve the previous content according to the agreed retention policy. Reusing the same Binary URL for different bytes would change what older references retrieve.
This pattern supports ordinary image files but does not define a complete DICOM imaging service. DICOM studies, series, viewing and DICOMweb require a separate design.
References: FHIR R4 DocumentReference, Binary and Attachment.
Organization and clinic site in county dental care
Organization identifies the organisational unit; Location identifies where care takes place. In the recall-to-treatment example, Fylkeskommune represents the county's public dental service and Central Dental Clinic is the physical clinic site. Both are fictional.
| Field in the example | Meaning |
|---|---|
Encounter.serviceProvider |
The county municipality providing this contact. |
Encounter.location.location |
The physical clinic where the visit took place. |
Location.managingOrganization |
The county municipality managing that clinic site. |
A clinic may also be an organisational unit with its own Organization, linked to the county through Organization.partOf. Its physical site is still a Location. Use the organisational level recorded as responsible in the source EHR; these profiles do not require every provider reference to point to the county itself. A treatment room can be another Location, linked to the clinic through Location.partOf, when that detail is useful.
EpisodeOfCare.managingOrganization identifies responsibility over time. Composition.custodian identifies who maintains the note. The example explicitly assigns both roles to the county; they must be determined separately from the contact provider in real data.
See FHIR R4 Organization: boundaries and relationships for the distinction between organisational and physical hierarchies.
Inherited profiles
Use the DigiDOT Appointment and Dental Contact Note profiles for these records. The national profiles below provide their inherited rules.
| Profile | Use in DigiDOT | Definition |
|---|---|---|
| no-basis-Appointment | DigiDOT Appointment inherits national scheduling rules. | Open profile |
| no-basis-Composition | Dental Contact Note inherits national Composition rules. | Open profile |
For identifiers and reference patterns, see References and identifiers.
Other permitted targets: scope to be confirmed
These targets still occur in the current StructureDefinitions. Their intended use in supplier scope needs confirmation; they are listed here to expose the outstanding choices, not to introduce more required record types.
| Profile | Where it occurs | Definition |
|---|---|---|
| no-basis-HealthcareService | A requested provider or service in ServiceRequest. | Open profile |
| no-basis-Procedure | Procedure context in ChargeItem and Claim, where permitted. | Open profile |
ServiceRequest.supportingInfo permits DigiDOT AllergyIntolerance for reported allergies and intolerances within that profile's scope.
In particular, the financial profiles currently permit no-basis-Procedure. Whether these links should use DigiDOT Procedure is an unresolved profile decision.
External medication definitions
SFM/PLL medication information has a separate scope from medication use reported during dental care. ServiceRequest now references DigiDOT MedicationStatement for reported use; it does not permit direct references to SFM List or SFM MedicationStatement. An external medication integration requires an agreed representation and access contract before it is added to the profile.
See ServiceRequest supporting context and reported MedicationStatement.