CareCitizen - v1.2.0

1.2.0 - release

This page is part of the KL Gateway (v1.2.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CareCitizen

Official URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-citizen				Version: 1.2.0
Active as of 2024-10-31				Computable Name: KLGatewayCareCitizen

Administrative information about a citizen receiving care or care related services.

Scope and usage

Citizen is used to identify the subject of a delivery report 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 then 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.

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.

FKI-attribut	Definition	FHIR
cpr-nummer	Officielt cpr-nummer på borgeren	identifier.value
Journalførende organisation	Organisation som ejer journalen med oplysninger	managingOrganization.identifier.value

FKI-attribut

Definition

FHIR

cpr-nummer

Officielt cpr-nummer på borgeren

identifier.value

Journalførende organisation

Organisation som ejer journalen med oplysninger

managingOrganization.identifier.value

Usage:

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from DkCorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	DkCorePatient	Information about an individual or animal receiving health care services data-about-deceased-citizen-warning: Warning: Data about deceased citizen is reported to kl-gateway
identifier		1..1	Identifier	[DK] borgerCprNummer
Slices for identifier				Content/Rules for all slices
identifier:cpr		1..1	DkCoreCprIdentifier	An identifier intended for computation
identifier:x-ecpr		0..0
identifier:d-ecpr		0..0
active		0..1	boolean	[DK] harAktivJournal
name		0..0
Slices for name				Content/Rules for all slices
name:official		0..0
telecom		0..0
gender		0..0
birthDate		0..0
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime		0..0
deceased[x]:deceasedBoolean		0..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
Slices for generalPractitioner				Content/Rules for all slices
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

Constraints

Id	Grade	Path(s)	Details	Requirements
data-about-deceased-citizen-warning	warning	Patient	Warning: Data about deceased citizen is reported to kl-gateway : (deceased.empty()) or (deceased.ofType(boolean) = false)

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	DkCorePatient	Information about an individual or animal receiving health care services marital-status-unknown-usage: Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK. 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/ data-about-deceased-citizen-warning: Warning: Data about deceased citizen is reported to kl-gateway
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	Identifier	[DK] borgerCprNummer Slice: Unordered, Open by value:system
identifier:cpr		1..1	DkCoreCprIdentifier	An identifier intended for computation
active	?!Σ	0..1	boolean	[DK] harAktivJournal
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
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 URI

Patient.name:official.use

Id	Grade	Path(s)	Details	Requirements
data-about-deceased-citizen-warning	warning	Patient	Warning: Data about deceased citizen is reported to kl-gateway : (deceased.empty()) or (deceased.ofType(boolean) = false)
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. 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

Id	Grade	Path(s)	Details	Requirements
data-about-deceased-citizen-warning	warning	Patient	Warning: Data about deceased citizen is reported to kl-gateway : (deceased.empty()) or (deceased.ofType(boolean) = false)
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. 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

Id	Grade	Path(s)	Details	Requirements
data-about-deceased-citizen-warning	warning	Patient	Warning: Data about deceased citizen is reported to kl-gateway : (deceased.empty()) or (deceased.ofType(boolean) = false)
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. 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

Id	Grade	Path(s)	Details	Requirements
data-about-deceased-citizen-warning	warning	Patient	Warning: Data about deceased citizen is reported to kl-gateway : (deceased.empty()) or (deceased.ofType(boolean) = false)
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. 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