HL7 FHIR Implementation Guide: DK Core
3.4.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.4.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-patient | Version: 3.4.0 | |||
Draft as of 2024-11-19 | Computable Name: DkCorePatient |
HL7 Denmark core profile for a patient
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).
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:
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.
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.
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:
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 |
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.
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.
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from IPAPatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | IPAPatient | 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 | |
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 | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: DK MaritalStatus (extensible) | |
contact | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: DK Related Person Relationship Types (extensible) | |
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 | |
generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |
identifier | 0..1 | SORIdentifier | An identifier intended for computation | |
managingOrganization | 0..1 | Reference(Danish Core Organization Profile) | Organization that is the custodian of the patient record | |
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 | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.maritalStatus | extensible | http://hl7.dk/fhir/core/ValueSet/dk-marital-status from this IG | |
Patient.contact.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG |
Id | Grade | Path(s) | Details | Requirements |
marital-status-unknown-usage | warning | Patient | 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/ : 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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | IPAPatient | 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/ |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:cpr | SC | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:x-ecpr | SC | 0..1 | DkCoreXeCprIdentifier | [DA] X-eCPR, tildelt fra den nationale eCPR service ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:d-ecpr | SC | 0..1 | DkCoreDeCprIdentifier | [DA] D-eCPR, decentral eCPR ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
active | ?!SΣC | 0..1 | boolean | Whether this patient's record is in active use ipa-pat-4: If Patient.link is present, then Patient.active SHALL be present |
Slices for name | SΣC | 0..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
name:official | SΣC | 0..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 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 |
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 | |
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 | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: DK MaritalStatus (extensible) | |
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 | |
generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |
identifier | 0..1 | SORIdentifier | An identifier intended for computation | |
managingOrganization | Σ | 0..1 | Reference(Danish Core Organization Profile) | Organization that is the custodian of the patient record |
link | ?!SΣC | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:cpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:x-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:d-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.maritalStatus | extensible | http://hl7.dk/fhir/core/ValueSet/dk-marital-status from this IG | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
marital-status-unknown-usage | warning | Patient | 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/ : 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 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | IPAPatient | 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 | ||||
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 | SΣC | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:cpr | SC | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:x-ecpr | SC | 0..1 | DkCoreXeCprIdentifier | [DA] X-eCPR, tildelt fra den nationale eCPR service ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:d-ecpr | SC | 0..1 | DkCoreDeCprIdentifier | [DA] D-eCPR, decentral eCPR ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!SΣC | 0..1 | boolean | Whether this patient's record is in active use ipa-pat-4: If Patient.link is present, then Patient.active SHALL be present | ||||
Slices for name | SΣC | 0..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. | ||||
name:official | SΣC | 0..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. | ||||
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 | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 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 | |||||
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 | |||||
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.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
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 | |||||
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(Danish Core Organization Profile) | Organization that is the custodian of the patient record | ||||
link | ?!SΣC | 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. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:cpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:cpr.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:x-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:x-ecpr.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:d-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:d-ecpr.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | http://hl7.dk/fhir/core/ValueSet/dk-marital-status from this IG | ||||
Patient.contact.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.generalPractitioner:referencedSORUnit.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
marital-status-unknown-usage | warning | Patient | 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/ : 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 |
This structure is derived from IPAPatient
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from IPAPatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | IPAPatient | 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 | |
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 | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: DK MaritalStatus (extensible) | |
contact | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: DK Related Person Relationship Types (extensible) | |
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 | |
generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |
identifier | 0..1 | SORIdentifier | An identifier intended for computation | |
managingOrganization | 0..1 | Reference(Danish Core Organization Profile) | Organization that is the custodian of the patient record | |
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 | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.maritalStatus | extensible | http://hl7.dk/fhir/core/ValueSet/dk-marital-status from this IG | |
Patient.contact.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG |
Id | Grade | Path(s) | Details | Requirements |
marital-status-unknown-usage | warning | Patient | 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/ : 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | IPAPatient | 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/ |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:cpr | SC | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:x-ecpr | SC | 0..1 | DkCoreXeCprIdentifier | [DA] X-eCPR, tildelt fra den nationale eCPR service ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:d-ecpr | SC | 0..1 | DkCoreDeCprIdentifier | [DA] D-eCPR, decentral eCPR ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
active | ?!SΣC | 0..1 | boolean | Whether this patient's record is in active use ipa-pat-4: If Patient.link is present, then Patient.active SHALL be present |
Slices for name | SΣC | 0..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
name:official | SΣC | 0..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 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 |
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 | |
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 | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: DK MaritalStatus (extensible) | |
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 | |
generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |
identifier | 0..1 | SORIdentifier | An identifier intended for computation | |
managingOrganization | Σ | 0..1 | Reference(Danish Core Organization Profile) | Organization that is the custodian of the patient record |
link | ?!SΣC | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:cpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:x-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:d-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.maritalStatus | extensible | http://hl7.dk/fhir/core/ValueSet/dk-marital-status from this IG | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
marital-status-unknown-usage | warning | Patient | 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/ : 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
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | IPAPatient | 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 | ||||
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 | SΣC | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:cpr | SC | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:x-ecpr | SC | 0..1 | DkCoreXeCprIdentifier | [DA] X-eCPR, tildelt fra den nationale eCPR service ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:d-ecpr | SC | 0..1 | DkCoreDeCprIdentifier | [DA] D-eCPR, decentral eCPR ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!SΣC | 0..1 | boolean | Whether this patient's record is in active use ipa-pat-4: If Patient.link is present, then Patient.active SHALL be present | ||||
Slices for name | SΣC | 0..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. | ||||
name:official | SΣC | 0..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. | ||||
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 | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 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 | |||||
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 | |||||
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.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
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 | |||||
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(Danish Core Organization Profile) | Organization that is the custodian of the patient record | ||||
link | ?!SΣC | 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. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:cpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:cpr.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:x-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:x-ecpr.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:d-ecpr.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:d-ecpr.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | http://hl7.dk/fhir/core/ValueSet/dk-marital-status from this IG | ||||
Patient.contact.relationship | extensible | RelatedPersonRelationshipTypeshttp://hl7.dk/fhir/core/ValueSet/dk-core-RelatedPersonRelationshipTypes from this IG | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.generalPractitioner:referencedSORUnit.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
marital-status-unknown-usage | warning | Patient | 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/ : 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 |
This structure is derived from IPAPatient
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Note: feedback is most welcome and should be directed to the danish affiliate's github repository (https://github.com/hl7dk/dk-core/).