eHealth Infrastructure
2.9.0 - release

eHealth Infrastructure - Local Development build (v2.9.0). See the Directory of published versions

Resource Profile: ehealth-patient

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient Version: 2.9.0
Active as of 2023-08-23 Computable Name: ehealth-patient

Introduction

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.

Scope and Usage

In the eHealth Infrastructure the Patient resource is primarily used in conjunction with the following resources:

  • Communication
    • As sender or recipient of a message
  • Appointment
    • As participant on an ehealth-appointment
  • CarePlan
    • As the subject in question
  • ClinicalImpression
    • As the subject in question
  • EpisodeOfCare
    • As the focus of an episode of care
  • Observation
    • As the subject in question
  • RelatedPerson
    • As the patient who a person is related to

Update rules

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.*  

Name and Address Protection

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”

Resolving general practitioner

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from DkCorePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*DkCorePatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... itCompetenceLevel 0..*(Complex)IT competence level
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-itcompetencelevel
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/patient-interpreterRequired
... nameAndAddressProtection 0..1PeriodPeriod of name and address protection
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection
... identifier:cpr 1..1DkCoreCprIdentifierAn identifier intended for computation
... Slices for telecom 0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:value
.... telecom:NemSMS 0..*ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: other
..... value 1..1stringThe actual contact point details
Fixed Value: NemSMS
..... use 0..0
..... rank 0..0
.... telecom:eBoks 0..*ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: other
..... value 1..1stringThe actual contact point details
Fixed Value: eBoks
..... use 0..0
..... rank 0..0
... gender 1..1codemale | female | other | unknown
... Slices for address 0..*AddressAn address for the individual
Slice: Unordered, Open by value:use
.... address:officialHomeAddress 0..1AddressAn address for the individual
..... extension:municipalityCode 0..*MunicipalityCodesDanish Core Municipality codes
..... extension:regionalSubDivisionCodes 0..*RegionalSubDivisionCodesDanish Core Regional Sub Division Codes Extension
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Fixed Value: home
... contact
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patientContactnote 0..*stringNote regarding patient contact
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient-contactnote
.... address
..... municipalityCodes 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
... communication
.... language
..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: urn:ietf:bcp:47
... generalPractitioner 0..*Reference(Organization | Practitioner) {r}Patient's nominated primary care provider
... generalPractitioner:referencedSORUnit 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*DkCorePatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... itCompetenceLevel 0..*(Complex)IT competence level
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-itcompetencelevel
... generalHealthCondition 0..*(Complex)General health condition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-general-health-condition
... nameAndAddressProtection 0..1PeriodPeriod of name and address protection
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:cpr 1..1DkCoreCprIdentifierAn identifier intended for computation
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ0..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:official Σ0..1HumanNameA name associated with the patient
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family Σ1..1stringFamily name (often called 'Surname')
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:value
.... telecom:NemSMS Σ0..*ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: NemSMS
.... telecom:eBoks Σ0..*ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: eBoks
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address Σ0..*AddressAn address for the individual
Slice: Unordered, Open by value:use
.... address:All Slices Content/Rules for all slices
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... address:officialHomeAddress Σ0..1AddressAn address for the individual
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: home
... Slices for generalPractitioner 0..*Reference(Organization | Practitioner) {r}Patient's nominated primary care provider
Slice: Unordered, Open by value:identifier.system
.... generalPractitioner:referencedSORUnit 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.name:official.userequiredFixed Value: official
Patient.telecom:NemSMS.systemrequiredPattern: other
Patient.telecom:eBoks.systemrequiredPattern: other
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address:officialHomeAddress.userequiredFixed Value: home
Patient.link.typerequiredLinkType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*DkCorePatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... itCompetenceLevel 0..*(Complex)IT competence level
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-itcompetencelevel
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/patient-interpreterRequired
... generalHealthCondition 0..*(Complex)General health condition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-general-health-condition
... nameAndAddressProtection 0..1PeriodPeriod of name and address protection
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:cpr 1..1DkCoreCprIdentifierAn identifier intended for computation
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ0..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:official Σ0..1HumanNameA name associated with the patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:value
.... telecom:NemSMS Σ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: NemSMS
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:eBoks Σ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: eBoks
..... period Σ0..1PeriodTime period when the contact point was/is in use
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address Σ0..*AddressAn address for the individual
Slice: Unordered, Open by value:use
.... address:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:officialHomeAddress Σ0..1AddressAn address for the individual
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: DK MaritalStatus (extensible)
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patientContactnote 0..*stringNote regarding patient contact
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient-contactnote
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... municipalityCodes 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: urn:ietf:bcp:47
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... preferred 0..1booleanLanguage preference indicator
... Slices for generalPractitioner 0..*Reference(Organization | Practitioner) {r}Patient's nominated primary care provider
Slice: Unordered, Open by value:identifier.system
.... generalPractitioner:referencedSORUnit 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier 0..1SORIdentifierAn identifier intended for computation
..... display Σ0..1stringText alternative for the resource
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name:official.userequiredFixed Value: official
Patient.telecom:NemSMS.systemrequiredPattern: other
Patient.telecom:eBoks.systemrequiredPattern: other
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address:officialHomeAddress.userequiredFixed Value: home
Patient.address:officialHomeAddress.typerequiredAddressType
Patient.maritalStatusextensibleDK Marital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.address.userequiredAddressUse
Patient.contact.address.typerequiredAddressType
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.generalPractitioner:referencedSORUnit.typeextensibleResourceType
Patient.link.typerequiredLinkType

This structure is derived from DkCorePatient

Differential View

This structure is derived from DkCorePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*DkCorePatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... itCompetenceLevel 0..*(Complex)IT competence level
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-itcompetencelevel
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/patient-interpreterRequired
... nameAndAddressProtection 0..1PeriodPeriod of name and address protection
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection
... identifier:cpr 1..1DkCoreCprIdentifierAn identifier intended for computation
... Slices for telecom 0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:value
.... telecom:NemSMS 0..*ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: other
..... value 1..1stringThe actual contact point details
Fixed Value: NemSMS
..... use 0..0
..... rank 0..0
.... telecom:eBoks 0..*ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: other
..... value 1..1stringThe actual contact point details
Fixed Value: eBoks
..... use 0..0
..... rank 0..0
... gender 1..1codemale | female | other | unknown
... Slices for address 0..*AddressAn address for the individual
Slice: Unordered, Open by value:use
.... address:officialHomeAddress 0..1AddressAn address for the individual
..... extension:municipalityCode 0..*MunicipalityCodesDanish Core Municipality codes
..... extension:regionalSubDivisionCodes 0..*RegionalSubDivisionCodesDanish Core Regional Sub Division Codes Extension
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Fixed Value: home
... contact
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patientContactnote 0..*stringNote regarding patient contact
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient-contactnote
.... address
..... municipalityCodes 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
... communication
.... language
..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: urn:ietf:bcp:47
... generalPractitioner 0..*Reference(Organization | Practitioner) {r}Patient's nominated primary care provider
... generalPractitioner:referencedSORUnit 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*DkCorePatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... itCompetenceLevel 0..*(Complex)IT competence level
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-itcompetencelevel
... generalHealthCondition 0..*(Complex)General health condition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-general-health-condition
... nameAndAddressProtection 0..1PeriodPeriod of name and address protection
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:cpr 1..1DkCoreCprIdentifierAn identifier intended for computation
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ0..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:official Σ0..1HumanNameA name associated with the patient
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family Σ1..1stringFamily name (often called 'Surname')
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:value
.... telecom:NemSMS Σ0..*ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: NemSMS
.... telecom:eBoks Σ0..*ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: eBoks
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address Σ0..*AddressAn address for the individual
Slice: Unordered, Open by value:use
.... address:All Slices Content/Rules for all slices
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... address:officialHomeAddress Σ0..1AddressAn address for the individual
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: home
... Slices for generalPractitioner 0..*Reference(Organization | Practitioner) {r}Patient's nominated primary care provider
Slice: Unordered, Open by value:identifier.system
.... generalPractitioner:referencedSORUnit 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.name:official.userequiredFixed Value: official
Patient.telecom:NemSMS.systemrequiredPattern: other
Patient.telecom:eBoks.systemrequiredPattern: other
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address:officialHomeAddress.userequiredFixed Value: home
Patient.link.typerequiredLinkType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*DkCorePatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... itCompetenceLevel 0..*(Complex)IT competence level
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-itcompetencelevel
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/patient-interpreterRequired
... generalHealthCondition 0..*(Complex)General health condition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-general-health-condition
... nameAndAddressProtection 0..1PeriodPeriod of name and address protection
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:cpr 1..1DkCoreCprIdentifierAn identifier intended for computation
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ0..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:official Σ0..1HumanNameA name associated with the patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:value
.... telecom:NemSMS Σ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: NemSMS
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:eBoks Σ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: other
..... value Σ1..1stringThe actual contact point details
Fixed Value: eBoks
..... period Σ0..1PeriodTime period when the contact point was/is in use
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... Slices for address Σ0..*AddressAn address for the individual
Slice: Unordered, Open by value:use
.... address:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:officialHomeAddress Σ0..1AddressAn address for the individual
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... municipalityCode 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: DK MaritalStatus (extensible)
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patientContactnote 0..*stringNote regarding patient contact
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient-contactnote
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... municipalityCodes 0..*CodeableConceptDanish Core Municipality codes
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes
..... regionalSubDivisionCodes 0..*CodeableConceptDanish Core Regional Sub Division Codes Extension
URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: urn:ietf:bcp:47
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... preferred 0..1booleanLanguage preference indicator
... Slices for generalPractitioner 0..*Reference(Organization | Practitioner) {r}Patient's nominated primary care provider
Slice: Unordered, Open by value:identifier.system
.... generalPractitioner:referencedSORUnit 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier 0..1SORIdentifierAn identifier intended for computation
..... display Σ0..1stringText alternative for the resource
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name:official.userequiredFixed Value: official
Patient.telecom:NemSMS.systemrequiredPattern: other
Patient.telecom:eBoks.systemrequiredPattern: other
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address:officialHomeAddress.userequiredFixed Value: home
Patient.address:officialHomeAddress.typerequiredAddressType
Patient.maritalStatusextensibleDK Marital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.address.userequiredAddressUse
Patient.contact.address.typerequiredAddressType
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.generalPractitioner:referencedSORUnit.typeextensibleResourceType
Patient.link.typerequiredLinkType

This structure is derived from DkCorePatient

 

Other representations of profile: CSV, Excel, Schematron