HL7 FHIR Implementation Guide: DK Core
3.5.0 - ci-build Denmark flag

HL7 FHIR Implementation Guide: DK Core, published by HL7 Denmark. This guide is not an authorized publication; it is the continuous build for version 3.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7dk/dk-core/ and changes regularly. 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.5.0
Draft as of 2024-12-16 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.

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: 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/
... 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
.... Slices for extension Content/Rules for all slices
..... 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-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
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
.... 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(Organization | Practitioner | PractitionerRole) 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 An identifier intended for computation
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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
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/
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... 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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: DK MaritalStatus (extensible)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: DK Related Person Relationship Types (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... 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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier 0..1 SORIdentifier An identifier intended for computation
..... display Σ 0..1 string Text alternative for the resource
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name:official.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|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.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
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
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.generalPractitioner:referencedSORUnit.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
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

Differential View

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: 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/
... 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
.... Slices for extension Content/Rules for all slices
..... 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-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

Key Elements View

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
.... 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(Organization | Practitioner | PractitionerRole) 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 An identifier intended for computation
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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
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/
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... 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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: DK MaritalStatus (extensible)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: DK Related Person Relationship Types (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... 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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier 0..1 SORIdentifier An identifier intended for computation
..... display Σ 0..1 string Text alternative for the resource
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name:official.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|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.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
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
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.generalPractitioner:referencedSORUnit.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
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/).