Scope and usage

klgateway-119-citizen is used to identify the subject of a prevention/health promotion reporting by the personal id number (CPR-nummer) and the managing organization that acts as the custodian of the reported data. The personal id number must be an official Danish CPR-nummer without hyphen, and the SOR code must be an official SOR code.

The managing organization is given by its SOR code. For most municipalities this will be the code for the municipality, but if a municipality delivers services covered by FSIII in different departments using different record systems (thus having mulitple custodians) the SOR codes of the department that acts as custodian is used.

Patient.deceasedBoolean is a statement of whether the citizen is alive or dead.

Conversions between Danish information model and FHIR-profile

Nedenstående tabel oversætter mellem de attributter, der er defineret i den fælleskommunale informationsmodel (FKI), definerer kort den enkelte attribut på dansk og specificerer, hvilke af FHIR-profilens atributter der skal bruges til specifikation af indholdet.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from DkCorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient			DkCorePatient
identifier		1..1	DkCoreCprIdentifier	[DK] borgerCprNummer
active		0..0
name		0..0
name:official		0..0
telecom		0..0
gender		0..0
birthDate		0..0
Slices for deceased[x]		1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime		0..0
deceased[x]:deceasedBoolean		1..1	boolean	[DK] borgerErDød
address		0..0
maritalStatus		0..0
multipleBirth[x]		0..0
photo		0..0
contact		0..0
communication		0..0
generalPractitioner		0..0
generalPractitioner:referencedSORUnit		0..0
managingOrganization		1..1	Reference(Organization)	[DK] borgerJournalførendeOrganisation
reference		0..0
type		0..0
identifier		1..1	SORIdentifier	An identifier intended for computation
display		0..0
link		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	DkCorePatient	Information about an individual or animal receiving health care services
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	Σ	1..1	DkCoreCprIdentifier	[DK] borgerCprNummer Slice: Unordered, Open by value:system
identifier:cpr		0..1	DkCoreCprIdentifier	[DA] cpr-nummer, som det fremgår af CPR registeret
Slices for deceased[x]	?!Σ	1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	[DK] borgerErDød
managingOrganization	Σ	1..1	Reference(Organization)	[DK] borgerJournalførendeOrganisation
identifier		1..1	SORIdentifier	An identifier intended for computation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.name:official.use	required	Fixed Value: official
Patient.address.use	required	AddressUse
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
marital-status-unknown-usage	warning	Patient	Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : 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()

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	DkCorePatient	Information about an individual or animal receiving health care services
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..1	DkCoreCprIdentifier	[DK] borgerCprNummer Slice: Unordered, Open by value:system
identifier:cpr		0..1	DkCoreCprIdentifier	[DA] cpr-nummer, som det fremgår af CPR registeret
Slices for deceased[x]	?!Σ	1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	[DK] borgerErDød
managingOrganization	Σ	1..1	Reference(Organization)	[DK] borgerJournalførendeOrganisation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
identifier		1..1	SORIdentifier	An identifier intended for computation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Patient.name:official.use	required	Fixed Value: official
Patient.address.use	required	AddressUse
Patient.address.type	required	AddressType
Patient.contact.relationship	extensible	PatientContactRelationship
Patient.contact.gender	required	AdministrativeGender
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Patient.generalPractitioner:referencedSORUnit.type	extensible	ResourceType
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
marital-status-unknown-usage	warning	Patient	Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : 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()

Differential View

This structure is derived from DkCorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient			DkCorePatient
identifier		1..1	DkCoreCprIdentifier	[DK] borgerCprNummer
active		0..0
name		0..0
name:official		0..0
telecom		0..0
gender		0..0
birthDate		0..0
Slices for deceased[x]		1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime		0..0
deceased[x]:deceasedBoolean		1..1	boolean	[DK] borgerErDød
address		0..0
maritalStatus		0..0
multipleBirth[x]		0..0
photo		0..0
contact		0..0
communication		0..0
generalPractitioner		0..0
generalPractitioner:referencedSORUnit		0..0
managingOrganization		1..1	Reference(Organization)	[DK] borgerJournalførendeOrganisation
reference		0..0
type		0..0
identifier		1..1	SORIdentifier	An identifier intended for computation
display		0..0
link		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	DkCorePatient	Information about an individual or animal receiving health care services
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	Σ	1..1	DkCoreCprIdentifier	[DK] borgerCprNummer Slice: Unordered, Open by value:system
identifier:cpr		0..1	DkCoreCprIdentifier	[DA] cpr-nummer, som det fremgår af CPR registeret
Slices for deceased[x]	?!Σ	1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	[DK] borgerErDød
managingOrganization	Σ	1..1	Reference(Organization)	[DK] borgerJournalførendeOrganisation
identifier		1..1	SORIdentifier	An identifier intended for computation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.name:official.use	required	Fixed Value: official
Patient.address.use	required	AddressUse
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
marital-status-unknown-usage	warning	Patient	Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : 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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	DkCorePatient	Information about an individual or animal receiving health care services
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..1	DkCoreCprIdentifier	[DK] borgerCprNummer Slice: Unordered, Open by value:system
identifier:cpr		0..1	DkCoreCprIdentifier	[DA] cpr-nummer, som det fremgår af CPR registeret
Slices for deceased[x]	?!Σ	1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	[DK] borgerErDød
managingOrganization	Σ	1..1	Reference(Organization)	[DK] borgerJournalførendeOrganisation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
identifier		1..1	SORIdentifier	An identifier intended for computation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Patient.name:official.use	required	Fixed Value: official
Patient.address.use	required	AddressUse
Patient.address.type	required	AddressType
Patient.contact.relationship	extensible	PatientContactRelationship
Patient.contact.gender	required	AdministrativeGender
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Patient.generalPractitioner:referencedSORUnit.type	extensible	ResourceType
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
marital-status-unknown-usage	warning	Patient	Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : 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()

This structure is derived from DkCorePatient

Summary

Mandatory: 3 elements (1 nested mandatory element)
Prohibited: 19 elements

Structures

This structure refers to these other structures:

• Danish Central Person Register (CPR) Identifier (http://hl7.dk/fhir/core/StructureDefinition/dk-core-cpr-identifier)
• SOR Identifier (http://hl7.dk/fhir/core/StructureDefinition/dk-core-sor-identifier)

Slices

This structure defines the following Slices:

• The element Patient.deceased[x] is sliced based on the value of type:$this