KLChildren implementation guide, an implementation of FBU
2.0.1 - Release
This page is part of the KLChildren (v2.0.1: 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-location | Version: 2.0.1 | |||
Active as of 2024-07-01 | Computable Name: KLGatewayChildrenLocation |
Profile representing a location, in this implementation guide only used to represent a school
KLGatewayChildrenLocation is used to identify the school of the child.
Location.identifier holds the Danish institution identifier. Only schools are permitted, which result in Location.type always having the value ‘SCHOOL’.
Location.status is optional and assumed active, if not given. Location.status = inactive is used to report entered-in-error. However, this option should only be used, if the school is fully unknown to the municipality system, and should never have been in the system at all.
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 |
---|---|---|
Lokationsid | Lokations-id, her altid skolekoden, som kan findes i institutionsregisteret | Location.identifier |
Lokationstype | Typen af lokation (som altid er sat til skole) | Location.type |
Lokationsstatus | Angiver om lokationen er aktiv | Location.status |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | Location | |||
identifier | 1..1 | Identifier | [DK] Lokationsid | |
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://viden.stil.dk/display/OFFINSTREG/Institutionsregisteret | |
value | 1..1 | string | The value that is unique | |
period | 0..0 | |||
assigner | 0..0 | |||
status | 0..1 | code | [DK] Lokationsstatus | |
operationalStatus | 0..0 | |||
name | 0..0 | |||
alias | 0..0 | |||
description | 0..0 | |||
mode | 0..0 | |||
type | 1..1 | CodeableConcept | [DK] Lokationstype Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SCHOOL | |
telecom | 0..0 | |||
address | 0..0 | |||
physicalType | 0..0 | |||
position | 0..0 | |||
managingOrganization | 0..0 | |||
partOf | 0..0 | |||
hoursOfOperation | 0..0 | |||
availabilityExceptions | 0..0 | |||
endpoint | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | [DK] Lokationsid |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://viden.stil.dk/display/OFFINSTREG/Institutionsregisteret |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 0..1 | code | [DK] Lokationsstatus Binding: LocationStatus (required): Indicates whether the location is still in use. |
type | Σ | 1..1 | CodeableConcept | [DK] Lokationstype Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SCHOOL | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.type | extensible | Pattern: SCHOOLhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | 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 | Location | 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 | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | 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 | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |||||
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 | ||||
identifier | Σ | 1..1 | Identifier | [DK] Lokationsid | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://viden.stil.dk/display/OFFINSTREG/Institutionsregisteret | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
status | ?!Σ | 0..1 | code | [DK] Lokationsstatus Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
type | Σ | 1..1 | CodeableConcept | [DK] Lokationstype Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SCHOOL | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | Pattern: SCHOOLhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | 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 | Location | 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 | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | 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 Location
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | Location | |||
identifier | 1..1 | Identifier | [DK] Lokationsid | |
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://viden.stil.dk/display/OFFINSTREG/Institutionsregisteret | |
value | 1..1 | string | The value that is unique | |
period | 0..0 | |||
assigner | 0..0 | |||
status | 0..1 | code | [DK] Lokationsstatus | |
operationalStatus | 0..0 | |||
name | 0..0 | |||
alias | 0..0 | |||
description | 0..0 | |||
mode | 0..0 | |||
type | 1..1 | CodeableConcept | [DK] Lokationstype Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SCHOOL | |
telecom | 0..0 | |||
address | 0..0 | |||
physicalType | 0..0 | |||
position | 0..0 | |||
managingOrganization | 0..0 | |||
partOf | 0..0 | |||
hoursOfOperation | 0..0 | |||
availabilityExceptions | 0..0 | |||
endpoint | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | [DK] Lokationsid |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://viden.stil.dk/display/OFFINSTREG/Institutionsregisteret |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 0..1 | code | [DK] Lokationsstatus Binding: LocationStatus (required): Indicates whether the location is still in use. |
type | Σ | 1..1 | CodeableConcept | [DK] Lokationstype Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SCHOOL | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.type | extensible | Pattern: SCHOOLhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | 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 | Location | 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 | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | 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 | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |||||
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 | ||||
identifier | Σ | 1..1 | Identifier | [DK] Lokationsid | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://viden.stil.dk/display/OFFINSTREG/Institutionsregisteret | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
status | ?!Σ | 0..1 | code | [DK] Lokationsstatus Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
type | Σ | 1..1 | CodeableConcept | [DK] Lokationstype Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SCHOOL | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | Pattern: SCHOOLhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | 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 | Location | 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 | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | 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 Location
Other representations of profile: CSV, Excel, Schematron