KLChildren implementation guide, an implementation of FBU
2.1.0 - Release
KLChildren implementation guide, an implementation of FBU
2.1.0 - Release
This page is part of the KLChildren (v2.1.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
| Official URL: http://fhir.kl.dk/children/StructureDefinition/klgateway-children-related-parent | Version: 2.1.0 | |||
| Active as of 2024-10-31 | Computable Name: KLGatewayChildrenRelatedParent | |||
Profile for describing the relationship between the child, and the parents who are also relevant for the journal
KLGatewayChildrenRelatedParent is used to identify the relationship between a child and its parents. Include Citizen and RelatedPerson resources for the parents only when relevant to the child’s report.
In this implementation:
It might seem counter intuitive that this resource does not have a cpr identifier, or other identifier. However, such identifiers are stored in the Citizen resources of the parents, which links back to the RelatedPerson resource. Therefore, duplicating this information in the RelatedPerson resource is unnecessary.
The RelatedPerson.active attribute is optional and assumed to be true unless otherwise specified. Setting RelatedPerson.active to false should only be used to indicate that the entry was made in error and that the relationship does not exist in the municipal system and should not have been recorded.
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 |
|---|---|---|
| forælderHarBarn | Relation til den borger, der er barn af denne forælder | RelatedPerson.patient |
| forælderType | Typen af relation (som altid er sat til forælder) | ReleatedPerson.relationship |
| forældrerelationHarAktivJournal | Angiver om relationen er sand i den journalførende organisation eller ej | RelatedPerson.active |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DkCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson |
DkCoreRelatedPerson | |||
  identifier |
0..0 | |||
  Slices for identifier |
Content/Rules for all slices | |||
   identifier:cpr |
0..0 | |||
| identifier:x-ecpr |
0..0 | |||
 identifier:d-ecpr |
0..0 | |||
| active |
0..1 | boolean | [DK] harAktivJournal | |
 patient |
1..1 | Reference(KLGatewayChildrenCitizen) {b} | [DK] harBarn | |
| relationship |
0..* | CodeableConcept | [DK] type Binding: ForælderTyper (required) | |
| name |
0..0 | |||
| Slices for name |
Content/Rules for all slices | |||
| name:official |
0..0 | |||
| telecom |
0..0 | |||
| gender |
0..0 | |||
| birthDate |
0..0 | |||
| address |
0..0 | |||
| photo |
0..0 | |||
| period |
0..0 | |||
 communication |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | required | ParentTypeshttp://fhir.kl.dk/children/ValueSet/ParentTypesfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
0..* | DkCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | [DK] harAktivJournal |
| patient |
Σ | 1..1 | Reference(KLGatewayChildrenCitizen) {b} | [DK] harBarn |
 relationship |
Σ | 0..* | CodeableConcept | [DK] type Binding: ForælderTyper (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | |||
| RelatedPerson.relationship | required | ParentTypeshttp://fhir.kl.dk/children/ValueSet/ParentTypesfrom this IG | ||||
| RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | DkCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| 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 | ||||
| active |
?!Σ | 0..1 | boolean | [DK] harAktivJournal | ||||
| patient |
Σ | 1..1 | Reference(KLGatewayChildrenCitizen) {b} | [DK] harBarn | ||||
| relationship |
Σ | 0..* | CodeableConcept | [DK] type Binding: ForælderTyper (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| RelatedPerson.relationship | required | ParentTypeshttp://fhir.kl.dk/children/ValueSet/ParentTypesfrom this IG | ||||
| RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() |
This structure is derived from DkCoreRelatedPerson
Differential View
This structure is derived from DkCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
DkCoreRelatedPerson | |||
| identifier |
0..0 | |||
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:cpr |
0..0 | |||
| identifier:x-ecpr |
0..0 | |||
| identifier:d-ecpr |
0..0 | |||
| active |
0..1 | boolean | [DK] harAktivJournal | |
| patient |
1..1 | Reference(KLGatewayChildrenCitizen) {b} | [DK] harBarn | |
| relationship |
0..* | CodeableConcept | [DK] type Binding: ForælderTyper (required) | |
| name |
0..0 | |||
| Slices for name |
Content/Rules for all slices | |||
| name:official |
0..0 | |||
| telecom |
0..0 | |||
| gender |
0..0 | |||
| birthDate |
0..0 | |||
| address |
0..0 | |||
| photo |
0..0 | |||
| period |
0..0 | |||
| communication |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | required | ParentTypeshttp://fhir.kl.dk/children/ValueSet/ParentTypesfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
0..* | DkCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | [DK] harAktivJournal |
| patient |
Σ | 1..1 | Reference(KLGatewayChildrenCitizen) {b} | [DK] harBarn |
| relationship |
Σ | 0..* | CodeableConcept | [DK] type Binding: ForælderTyper (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | |||
| RelatedPerson.relationship | required | ParentTypeshttp://fhir.kl.dk/children/ValueSet/ParentTypesfrom this IG | ||||
| RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | DkCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| 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 | ||||
| active |
?!Σ | 0..1 | boolean | [DK] harAktivJournal | ||||
| patient |
Σ | 1..1 | Reference(KLGatewayChildrenCitizen) {b} | [DK] harBarn | ||||
| relationship |
Σ | 0..* | CodeableConcept | [DK] type Binding: ForælderTyper (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| RelatedPerson.relationship | required | ParentTypeshttp://fhir.kl.dk/children/ValueSet/ParentTypesfrom this IG | ||||
| RelatedPerson.name:official.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() |
This structure is derived from DkCoreRelatedPerson
Other representations of profile: CSV, Excel, Schematron