1.0.0 - Release
This page is part of the KLChildren (v1.0.0: Release) based on FHIR 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
Official URL: http://fhir.kl.dk/children/StructureDefinition/klgateway-children-citizen | Version: 1.0.0 | |||
Active as of 2023-09-30 | Computable Name: KLGatewayChildrenCitizen |
Administrative information about a citizen receiving care or care related services.
KLGatewayChildrenCitizen is used to identify the subject of a delivery report by the personal id number (CPR-nummer), which should go into Patient.identifier. The personal id number must be an official Danish CPR-nummer without hyphen.
The model also identifies the managing organization that acts as the custodian of the reported data. The managing organisation is identified by its official SOR code. The SOR codes should be documented in Patient.managingOrganization.identifier.
For most municipalities the SOR code will be the code for the municipality, but if a municipality delivers services in different departments using different record systems (thus having mulitple custodians) the SOR codes of the department that acts as custodian is used.
Citizen resources can be used to identify both child and parents. However, the parents should only be includes when and if, they are relevant for the child reporting e.g. when reporting the mental state of the mother. In this case, a relatedPerson ressource should also be included and referes using Patient.link.
Patient.link is a reference to a relatedPerson object. In the context of the childrens database, it is used to link a grown-up citizen with the relatedPerson ressource. The relatedPerson ressource defines that this grown-up is actually the child’s parent. In other words, a citizen object cannot hold information about relationships between citizens, for that we use the relatedPerson ressource.
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 |
---|---|---|
borgersCpr | Officielt cpr-nummer på borgeren | Patient.identifier |
borgersJournalførendeOrganisation | Organisation som ejer journalen med oplysninger | Patient.managingOrganization.identifier |
borgerErSammePersonSom | Reference til et pårørende-objekt, som er samme person som denne borger | Patient.link |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DkCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | DkCorePatient | |||
identifier | 1..1 | DkCoreCprIdentifier | [DK] cpr | |
active | 0..0 | |||
name | 0..0 | |||
name:official | 0..0 | |||
telecom | 0..0 | |||
gender | 0..0 | |||
birthDate | 0..0 | |||
deceased[x] | 0..0 | |||
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] journalførendeOrganisation | |
reference | 0..0 | |||
type | 0..0 | |||
identifier | 1..1 | SORIdentifier | An identifier intended for computation | |
display | 0..0 | |||
link | S | 0..* | BackboneElement | [DK] erSammePersonSom |
other | 1..1 | Reference(KLGatewayChildrenRelatedParent) {b} | The other patient or related person resource that the link refers to | |
type | 1..1 | code | replaced-by | replaces | refer | seealso Required Pattern: seealso | |
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] cpr Slice: Unordered, Open by value:system |
identifier:cpr | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret | |
managingOrganization | Σ | 1..1 | Reference(Organization) | [DK] journalførendeOrganisation |
identifier | 1..1 | SORIdentifier | An identifier intended for computation | |
link | ?!SΣ | 0..* | BackboneElement | [DK] erSammePersonSom |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(KLGatewayChildrenRelatedParent) {b} | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso |
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.name:official.use | required | Fixed Value: official | ||||
Patient.address.use | required | AddressUse | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | Pattern: seealso |
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.
| |||||
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] cpr Slice: Unordered, Open by value:system | ||||
identifier:cpr | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret | |||||
managingOrganization | Σ | 1..1 | Reference(Organization) | [DK] journalfø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 | |||||
link | ?!SΣ | 0..* | BackboneElement | [DK] erSammePersonSom | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(KLGatewayChildrenRelatedParent) {b} | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.language | preferred | CommonLanguages
| ||||
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
| ||||
Patient.generalPractitioner:referencedSORUnit.type | extensible | ResourceType | ||||
Patient.link.type | required | Pattern: seealso |
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: 2 elements
Must-Support: 1 element
Prohibited: 18 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from DkCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | DkCorePatient | |||
identifier | 1..1 | DkCoreCprIdentifier | [DK] cpr | |
active | 0..0 | |||
name | 0..0 | |||
name:official | 0..0 | |||
telecom | 0..0 | |||
gender | 0..0 | |||
birthDate | 0..0 | |||
deceased[x] | 0..0 | |||
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] journalførendeOrganisation | |
reference | 0..0 | |||
type | 0..0 | |||
identifier | 1..1 | SORIdentifier | An identifier intended for computation | |
display | 0..0 | |||
link | S | 0..* | BackboneElement | [DK] erSammePersonSom |
other | 1..1 | Reference(KLGatewayChildrenRelatedParent) {b} | The other patient or related person resource that the link refers to | |
type | 1..1 | code | replaced-by | replaces | refer | seealso Required Pattern: seealso | |
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] cpr Slice: Unordered, Open by value:system |
identifier:cpr | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret | |
managingOrganization | Σ | 1..1 | Reference(Organization) | [DK] journalførendeOrganisation |
identifier | 1..1 | SORIdentifier | An identifier intended for computation | |
link | ?!SΣ | 0..* | BackboneElement | [DK] erSammePersonSom |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(KLGatewayChildrenRelatedParent) {b} | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso |
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.name:official.use | required | Fixed Value: official | ||||
Patient.address.use | required | AddressUse | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | Pattern: seealso |
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.
| |||||
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] cpr Slice: Unordered, Open by value:system | ||||
identifier:cpr | 0..1 | DkCoreCprIdentifier | [DA] cpr-nummer, som det fremgår af CPR registeret | |||||
managingOrganization | Σ | 1..1 | Reference(Organization) | [DK] journalfø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 | |||||
link | ?!SΣ | 0..* | BackboneElement | [DK] erSammePersonSom | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(KLGatewayChildrenRelatedParent) {b} | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.language | preferred | CommonLanguages
| ||||
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
| ||||
Patient.generalPractitioner:referencedSORUnit.type | extensible | ResourceType | ||||
Patient.link.type | required | Pattern: seealso |
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: 2 elements
Must-Support: 1 element
Prohibited: 18 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron