HL7 FHIR Implementation Guide: DK Core
3.5.0 - ci-build
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
Official URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-related-person | Version: 3.5.0 | |||
Draft as of 2024-12-16 | Computable Name: DkCoreRelatedPerson |
HL7 Denmark core profile for a related person
The Danish Core Related Person profile is intended to encapsulate the most common and basic data model of persons related to patients/persons 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 related persons to those that receive health and social care in municipalities, even in contexts where receivers of care are more commonly known as citizens ([DA] borgere).
Note, that professional relationships between a patient and a healthcare professional are expressed by other means e.g. through Patient.generalPractitioner
.
Note also, that the intended use of Related Person is to describe a relationship, where privileges which might be associated to the relationship should be expressed by other means, e.g.the actual rights associated with being power of attorney, should be described in a legally binding document, and that document can be represented with the Consent resource.
Note furthermore, that a patients primary contact when possible should be expressed through Patient.contact
. However, when this is not feasible Related Person may be used.
This related person profile currently reflects the use of the established national Danish citizen identifiers called CPR and (where relevant) the use of replacement CPR numbers ([DA] Erstatnings-CPR-numre eller eCPR).
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'.
The element RelatedPerson.identifier includes two slices to represent eCPR. Each slice includes an identifier with requirements for the specific eCPR:
The relationships in DK Core Related Person Relationship Types are intended to cover the most common use cases within the Danish healthcare sector. For the relationship codes that are included from the general relationship codes danish translations are provided. In cases when other relationships need to be expressed, codes from the general Related Person Relationship Type or HL7 Role Code System should be used when possible. In the latter system is e.g. the code 'CCO', which is a clinical companion (DA: Servicehund).
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:
<RelatedPerson 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] ...
</RelatedPerson>
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 related person/citizen.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | RelatedPerson | |||
Slices for identifier | 0..* | Identifier | A human identifier for this person 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 | |
patient | 1..1 | Reference(Danish Core Patient Profile) | The patient this person is related to | |
relationship | 0..* | CodeableConcept | The nature of the relationship Binding: DK Related Person Relationship Types (extensible) | |
Slices for name | 0..* | HumanName | A name associated with the person 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') | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care 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 | |
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 | Σ | 0..* | Identifier | A human identifier for this person 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 | |
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children |
patient | Σ | 1..1 | Reference(Danish Core Patient Profile) | The patient this person is related to ele-1: All FHIR elements must have a @value or children |
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: DK Related Person Relationship Types (extensible) ele-1: All FHIR elements must have a @value or children |
Slices for name | Σ | 0..* | HumanName | A name associated with the person 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG | |
RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
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 | Σ | 0..* | Identifier | A human identifier for this person 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 related person's record is in active use | ||||
patient | Σ | 1..1 | Reference(Danish Core Patient Profile) | The patient this person is related to | ||||
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: DK Related Person Relationship Types (extensible) | ||||
Slices for name | Σ | 0..* | HumanName | A name associated with the person 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 person | ||||
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 on which the related person was born | ||||
address | Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
photo | 0..* | Attachment | Image of the person | |||||
period | 0..1 | Period | Period of time that this relationship is considered valid | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's 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.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RelatedPerson.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG | ||||
RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
|
This structure is derived from RelatedPerson
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | RelatedPerson | |||
Slices for identifier | 0..* | Identifier | A human identifier for this person 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 | |
patient | 1..1 | Reference(Danish Core Patient Profile) | The patient this person is related to | |
relationship | 0..* | CodeableConcept | The nature of the relationship Binding: DK Related Person Relationship Types (extensible) | |
Slices for name | 0..* | HumanName | A name associated with the person 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') | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care 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 | |
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 | Σ | 0..* | Identifier | A human identifier for this person 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 | |
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children |
patient | Σ | 1..1 | Reference(Danish Core Patient Profile) | The patient this person is related to ele-1: All FHIR elements must have a @value or children |
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: DK Related Person Relationship Types (extensible) ele-1: All FHIR elements must have a @value or children |
Slices for name | Σ | 0..* | HumanName | A name associated with the person 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG | |
RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
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 | Σ | 0..* | Identifier | A human identifier for this person 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 related person's record is in active use | ||||
patient | Σ | 1..1 | Reference(Danish Core Patient Profile) | The patient this person is related to | ||||
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: DK Related Person Relationship Types (extensible) | ||||
Slices for name | Σ | 0..* | HumanName | A name associated with the person 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 person | ||||
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 on which the related person was born | ||||
address | Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
photo | 0..* | Attachment | Image of the person | |||||
period | 0..1 | Period | Period of time that this relationship is considered valid | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's 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.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RelatedPerson.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG | ||||
RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
|
This structure is derived from RelatedPerson
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron