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

This page is part of the HL7 FHIR Implementation Guide: DK Core (v3.2.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). 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.2.0
Active as of 2024-05-06 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. However, it is currently not recommended to use this code, due to known problems with the validation tool when validating the code ‘NNDNK’.

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

Use of security label on patients

Danish citizens that have requested name and address protection (Navne- og adressebeskyttelse) should be labeled 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.

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
marital-status-unknown-usage: Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK. 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/
... Slices for identifier 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:cpr 0..1 DkCoreCprIdentifier [DA] cpr-nummer, som det fremgår af CPR registeret
.... identifier:x-ecpr 0..1 DkCoreXeCprIdentifier [DA] X-eCPR, tildelt fra den nationale eCPR service
.... identifier:d-ecpr 0..1 DkCoreDeCprIdentifier [DA] D-eCPR, decentral eCPR
... Slices for name 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use
.... name:official 0..1 HumanName [DA] Officielt navn, som det fremgår af CPR registeret
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... family 1..1 string Family name (often called 'Surname')
... address 0..* Address An address for the individual
.... municipalityCode 0..1 CodeableConcept [DA] Kommunekode
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
.... regionalSubDivisionCodes 0..1 CodeableConcept [DA] Regionskode
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
... contact
.... relationship 0..* CodeableConcept The kind of relationship
Binding: DK Related Person Relationship Types (extensible)
... Slices for generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Slice: Unordered, Open by value:identifier.system
.... generalPractitioner:referencedSORUnit 0..* Reference(Organization | Practitioner | PractitionerRole) [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau
..... identifier 0..1 SORIdentifier An identifier intended for computation
... link
.... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.maritalStatusextensible
http://hl7.dk/fhir/core/ValueSet/dk-marital-status
from this IG
Patient.contact.relationshipextensibleRelatedPersonRelationshipTypes
http://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
marital-status-unknown-usagewarningPatientStatus in maritalStatus is unknown in a danish context. Consider mapping the value to UNK. 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/).