HL7 FHIR Implementation Guide: DK Core
3.4.0 - release Denmark flag

This page is part of the HL7 FHIR Implementation Guide: DK Core (v3.4.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Danish Core Patient Profile

Official URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-patient Version: 3.4.0
Active as of 2025-02-01 Computable Name: DkCorePatient

HL7 Denmark core profile for a patient

Scope and usage

The Danish Core Patient profile is intended to encapsulate the most common and basic data model of patients in Danish healthcare systems covering both primary sector, secondary sector (specialty doctors and hospitals) and municipality cases. As such the profile should be usable in most Danish contexts. Note that the profile is usable for those that receive health and social care in municipalities, even in contexts where they are more commonly known as citizens ([DA] borgere).

Patient identifiers

This patient profile currently only reflects the use of the established national danish patient identifiers called CPR and (for patients without or with unknown CPR number) the use of replacement CPR numbers ([DA] Erstatnings-CPR-numre eller eCPR). Both national X-eCPR numbers issued by the Danish Health Data Authority ([DA] Sundhedsdatastyrelsen) and D-eCPR numbers primarily issued locally by one of the five danish regions are supported by this profile. More official identifiers are expected to be used and profiled in the future, eg:

  • eID
  • catastrophe CPR numbers.

CPR-identifier

The element identifier.type describes the specific purpose of an identifier. It is desired to use the code 'NNDNK' from the CodeSystem IdentifierType as the type for DkCoreCprIdentifier. Due to known problems with the validation tool when validating the code 'NNDNK', including this type will cause an error. Therefore, it is currently not recommended to use this code.

eCPR-identifier

The element Patient.identifier includes two slices to represent eCPR. Each slice includes an identifier with requirements for the specific eCPR:

In case it is necessary to include an eCPR which is not an X-eCPR or a D-eCPR, it is recommended to add a new slice with the relevant other system and the eCPR identifier from that system. This may be necessary for small practices or due to legacy reasons. An example of this can be seen here.

Handling CPR registry civilstand and status values

In the Danish CPR registry, a civilstand and a status attribute exist. The civilstand attribute contains information about marital status as well as deceased status. The status value contains information about a persons whereabouts e.g. living in Denmark or Greenland with known or unknown address, disappearance, and death. Most of the status values are used to inform about the reason for a CPR identifier being inactive.

In FHIR, this information is separated into different attributes. As a consequence the following decisions have been made:

  • CPR status values except for deceased status are not represented. Data in the health sector is typically not communicated, relating to inactive CPR-identifiers. If information about whether people live in Denmark or Greenland is important, this can be represented in the Patient.addresss attribute. Deceased status is represented in Patient.deceased
  • Civilstand values are represented in Patient.maritalStatus except for the value 'D' død (dead). Death is registered in Patient.deceased. Patient.maritalStatus uses a standard FHIR ValueSet. However a few of the Danish civilstatus values cannot be converted (P and O). Here the FHIR ValueSet is extended with the CPR-registry values.

The tabel below shows how to convert between CPR-registry civilstand/status and FHIR representation.

CPR-registry civilstand/status FHIR representation
status = 90 and civilstand = D indicating a dead person Patient.deceasedBoolean = true
civilstand = U indicating an unmarried person Patient.maritalStatus = U
civilstand = F indicating a divorced person Patient.maritalStatus = D
civilstand = E indicating a widow Patient.maritalStatus = W
civilstand = P indicating 'registreret partner'/registered partner which is a marriage-like status according to Danish law Patient.maritalStatus = P
civilstand = O indicating 'ophørt registreret partner'/disolved partnership. When the marriage-like partnership is disolved (parallel to a divorce) Patient.maritalStatus = O
civilstand = L indicating that the registrered partner of the person is dead (parallel to a widow) Patient.maritalStatus = W

Linking records

In Denmark it is possible to get a new CPR-number when a person e.g. changes his or her legal gender. Linking of the old and new patient records can handled using the Patient.link element, which asserts that patient resources refer to the same patient. In this case the old record should have the link type 'replaced-by' where the new record may have the link type 'replaces', both with a reference to the other record. This way of linking record can be considered in the case of legal gender. Other types of linking is described on the page for the patient resource.

Use of security label on patients

In case an implementation project needs to support name and address protection (Navne- og adressebeskyttelse) of a danish citizen, it is recommended to support this with the security label as follows:

 <Patient xmlns="http://hl7.org/fhir">
  <meta>
    <security>
      <system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality"/>
      <code value="R"/>
      <display value="Restricted"/>
    </security>
  </meta>
...  [snip] ...
</Patient>

Use of this label should be interpreted according to the law, roughly meaning that only personnel using systems in public/official affairs are allowed to see name and address for the patient/citizen.

Unknown values or Absent values

There may be scenarios where it is not possible to supply all values as required by this profile. For such cases it is possible to specify a Data Absent Reason (DAR) extension which enables data fields to be supplied where data is not available. An example of this can be seen here. The use of DAR is not restricted to the patient profile.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
marital-status-unknown-usage: The constraint ensures that only permitted forms of marriage can be used in the Danish context, as there will be no authority for other forms. See https://cpr.dk/borgere/hvad-staar-der-om-mig-i-cpr-registerindsigt/hvad-og-hvem-er-registreret-i-cpr-og-hvem-opdaterer-oplysninger-om-dig-i-cpr/
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
.... identifier:cpr Σ 0..1 DkCoreCprIdentifier [DA] cpr-nummer, som det fremgår af CPR registeret
ele-1: All FHIR elements must have a @value or children
.... identifier:x-ecpr Σ 0..1 DkCoreXeCprIdentifier [DA] X-eCPR, tildelt fra den nationale eCPR service
ele-1: All FHIR elements must have a @value or children
.... identifier:d-ecpr Σ 0..1 DkCoreDeCprIdentifier [DA] D-eCPR, decentral eCPR
ele-1: All FHIR elements must have a @value or children
... Slices for name Σ 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... name:official Σ 0..1 HumanName [DA] Officielt navn, som det fremgår af CPR registeret
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
Fixed Value: official
..... family Σ 1..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... municipalityCode 0..1 CodeableConcept [DA] Kommunekode
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... regionalSubDivisionCodes 0..1 CodeableConcept [DA] Regionskode
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... address-official 0..1 boolean Indicate that this address is meant to be the 'official' address for that person. This can be indicated by setting the boolean to 'true' or adding a code for the country, e.g. 'DK'. In Denmark the official is the address registered in the CPR-register, see: https://www.retsinformation.dk/eli/lta/2023/1010.
URL: http://hl7.org/fhir/StructureDefinition/address-official
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: DK MaritalStatus (extensible)
ele-1: All FHIR elements must have a @value or children
... Slices for generalPractitioner 0..* Reference(Danish Core Organization Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile) Patient's nominated primary care provider
Slice: Unordered, Open by value:identifier.system
ele-1: All FHIR elements must have a @value or children
.... generalPractitioner:referencedSORUnit 0..* Reference(Organization | Practitioner | PractitionerRole) [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau
ele-1: All FHIR elements must have a @value or children
..... identifier Σ 0..1 SORIdentifier Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
... managingOrganization Σ 0..1 Reference(Danish Core Organization Profile) Organization that is the custodian of the patient record
ele-1: All FHIR elements must have a @value or children
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other Σ 1..1 Reference(Danish Core Patient Profile | Danish Core Related Person Profile) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.name:official.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.maritalStatusextensible
http://hl7.dk/fhir/core/ValueSet/dk-marital-status
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
marital-status-unknown-usagewarningPatientThe constraint ensures that only permitted forms of marriage can be used in the Danish context, as there will be no authority for other forms. See https://cpr.dk/borgere/hvad-staar-der-om-mig-i-cpr-registerindsigt/hvad-og-hvem-er-registreret-i-cpr-og-hvem-opdaterer-oplysninger-om-dig-i-cpr/
: maritalStatus.coding.where(code = 'P' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() or maritalStatus.coding.where(code = 'A' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty()
Marital status is legally unknown in Denmark

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Note: feedback is most welcome and should be directed to the danish affiliate's github repository (https://github.com/hl7dk/dk-core/).