eHealth Infrastructure
3.4.1 - release
eHealth Infrastructure
3.4.1 - release
eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.4.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions
| Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient | Version: 3.4.1 | |||
| Active as of 2025-03-14 | Computable Name: ehealth-patient | |||
An ehealth-patient is a central entity, which is referenced by many other entities in the FUT infrastructure. The ehealth-patient inherits characteristics from https://hl7.dk/fhir/core/1.1.0/StructureDefinition-dk-core-patient.html.
In the eHealth Infrastructure the Patient resource is primarily used in conjunction with the following resources:
Certain data on an ehealth-patient are automatically updated based on the CPR system. This includes official name, address, and of course the CPR number itself.
When adding/updating an address (non-home address), the service will by default "wash" the address using DAWA (Danmarks Adressers Web API).
See https://dawadocs.dataforsyningen.dk/dok/api/adresse#datavask.
A client may overrule the default validation strategy by setting a request header x-address-validation-strategy
with the value "STRICT", "WASH" or "NONE".
If "STRICT" is used the request will fail if the address does not match strictly an address in DAWA.
If "WASH" is used (the default strategy) the client may want to verify that the wash outcome was as expected.
If "NONE" is used no validation/modification is performed (the address is stored as is).
An ehealth-patient may be PATCH updated on paths complying with the regular expressions below.
| Path | Description |
|---|---|
| /implicitRules.* | |
| /language.* | |
| /contained.* | |
| /identifier.* | CPR number may not be changed, but addition of other identifiers are allowed |
| /name.* | The official name (use=official) may not be changed, as it is automatically synchronized with the CPR system |
| /address.* | The home address may not be changed (use=home), as it is automatically synchronized with the CPR system |
| /maritalStatus.* | |
| /multipleBirth.* | |
| /photo.* | |
| /contact.* | |
| /telecom.* | |
| /communication.* | |
| /link.* | |
| /itcompetencelevel.* | |
| /interpreterRequired.* | |
| /generalHealthCondition.* | |
| /functionalCapacity.* | |
| /extension.* |
Patients with name and address protection are marked with security label 'restricted' (R in http://hl7.org/fhir/v3/Confidentiality).
The period of the name and address protection is expressed in an extention with url: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection"
When creating and updating a patient, the infrastructure gets information about the patients general practitioner. The information about the general practitioner origins from the provider registry (Yderregister: https://sundhedsdatastyrelsen.dk/da/registre-og-services/om-de-nationale-sundhedsregistre/personoplysninger-og-sundhedsfaglig-beskaeftigelse/yderregisteret) and results in a provider identifier. Under normal circumstances, the provider identifier identifies an organization in SOR registry (Sundhedsvæsenets Organisationsregister: https://sundhedsdatastyrelsen.dk/da/registre-og-services/om-sor) which resolves to an organization in the Organization service in the infrastructure. If the organization cannot be identified as an organization in the Organization service, the reference on the general practitioner remains as an logical reference (http://hl7.org/fhir/R4/references.html#logical) containing the provider identifier.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient |
C | 0..* | DkCorePatient | 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: Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK |
  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 |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:itCompetenceLevel |
0..* | (Complex) | IT competence level URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-itcompetencelevel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:interpreterRequired |
0..1 | boolean | Whether the patient needs an interpreter URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/patient-interpreterRequired ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:generalHealthCondition |
0..* | (Complex) | General health condition URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-general-health-condition ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 extension:nameAndAddressProtection |
0..1 | Period | Period of name and address protection URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 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 |
SΣ | 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 |
1..1 | DkCoreCprIdentifier | An identifier intended for computation ele-1: All FHIR elements must have a @value or children | |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
| Slices for name |
SΣ | 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 | A name associated with the patient 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 |
| Slices for telecom |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:value ele-1: All FHIR elements must have a @value or children |
 telecom:NemSMS |
Σ | 0..* | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
 system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: other |
| value |
Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children Fixed Value: NemSMS |
| telecom:eBoks |
Σ | 0..* | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: other |
| value |
Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children Fixed Value: eBoks |
| gender |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. 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 | |||
| Slices for address |
Σ | 0..* | Address | An address for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
 address:All Slices |
Content/Rules for all slices | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:municipalityCode |
0..* | CodeableConcept | Danish Core Municipality codes 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 | |
| extension:regionalSubDivisionCodes |
0..* | CodeableConcept | Danish Core Regional Sub Division Codes Extension 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 |
| address:officialHomeAddress |
Σ | 0..1 | 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 | |||
 extension:municipalityCode |
0..* | CodeableConcept | Danish Core Municipality codes 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 | |
| extension:regionalSubDivisionCodes |
0..* | CodeableConcept | Danish Core Regional Sub Division Codes Extension 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 |
?!Σ | 1..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 Fixed Value: home |
| Slices for generalPractitioner |
0..* | Reference(Organization | Practitioner) {r} | 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) | Patient's nominated primary care provider 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(Patient | RelatedPerson) | 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Patient.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Patient.telecom:NemSMS.system | required | Pattern: otherhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Patient.telecom:eBoks.system | required | Pattern: otherhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.address:officialHomeAddress.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#3.4.1 based on FHIR 4.0.1. Generated 2025-03-14
