Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: nl-core-location - Detailed Descriptions

Active as of 2024-04-09

Definitions for the nl-core-location resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Location
2. Location.name
ShortLocationName
Alternate NamesOrganizationLocation, OrganisatieLocatie, DispenseLocation, Afleverlocatie
4. Location.telecom
ShortContactInformation
TypeContactPoint(nl-core-contactpoint)
Alternate NamesContactgegevens
6. Location.address
ShortAddressInformation
TypeAddress(nl-core-address)
Alternate NamesAdresgegevens
8. Location.managingOrganization
TypeReference(nl-core-organization)
10. Location.partOf
TypeReference(nl-core-location)

Guidance on how to interpret the contents of this table can be found here

0. Location
Definition

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

ShortDetails and position information for a physical place
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Location.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. Location.status
Definition

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Shortactive | suspended | inactive
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control0..1
BindingThe codes SHALL be taken from LocationStatushttp://hl7.org/fhir/ValueSet/location-status
(required to http://hl7.org/fhir/ValueSet/location-status)

Indicates whether the location is still in use.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. Location.name
Definition

Name of the location as used by humans. Does not need to be unique.

ShortLocationNameName of the location as used by humans
Comments

If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesOrganizationLocation, OrganisatieLocatie, DispenseLocation, Afleverlocatie
10. Location.mode
Definition

Indicates whether a resource instance represents a specific location or a class of locations.

Shortinstance | kind
Comments

This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood.

Control0..1
BindingThe codes SHALL be taken from LocationModehttp://hl7.org/fhir/ValueSet/location-mode
(required to http://hl7.org/fhir/ValueSet/location-mode)

Indicates whether a resource instance represents a specific location or a class of locations.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

12. Location.telecom
Definition

Contact information includes a person's telephone numbers en e-mail addresses.


The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

ShortContactInformationContact details of the location
Control0..*
This element is affected by the following invariants: ele-1
TypeContactPoint(nl-core-contactpoint)
Alternate NamesContactgegevens
Example<br/><b>Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "work" } <br/><b>Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "mobile" } <br/><b>Primary Home Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Private email address</b>:{ "system" : "email", "value" : "giesput@myweb.nl", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
14. Location.address
Definition

There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world and adds all relevant components to express Dutch addresses.

A Dutch Address is a proper FHIR Address. Systems that do not understand any of the extensions, will be able to render and work with a Dutch address. Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.

To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.

The HCIM defines certain address types in the AdresSoortCodelijst. These do not all have a one to one mapping in the FHIR Address datatype. The following explains how to deal with that. In addition, there are the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType to define this relationship

HCIM Postal Address maps to Address.type 'postal';

HCIM Primary Home Address maps to Address.extension:official 'true' + Address.use 'home' + Address.use.extension 'HP';

HCIM Visit Address (Woon-/verblijfadres) maps to Address.use 'home' + Address.type 'physical' + Address.use.extension 'PHYS';

HCIM Temporary Address maps to Address.use 'temp';

HCIM Work Place Address maps to Address.use 'work';

HCIM Vacation Home Address maps to Address.use 'temp' + Address.use.extension 'HV'.

If Address.type is "both" then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.


Physical location.

ShortAddressInformationPhysical location
Comments

Note: address is for postal addresses, not physical locations.


This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types.

Control0..1
This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts
TypeAddress(nl-core-address)
Requirements

If locations can be visited, we need to keep track of their address.

Alternate NamesAdresInformatie, Adresgegevens
Example<br/><b>Example of a vacation home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : false }], "use" : "temp", "_use" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use", "valueCode" : "HV" }] }, "line" : ["Binnenkant 12A Hoog"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "12" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix", "valueString" : "A" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID", "valueString" : "Hoog" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1000AA", "country" : "NLD" } <br/><b>Example of a primary home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : true }], "use" : "home", "line" : ["Binnenkant to 10"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator", "valueString" : "to" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "10" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1001AA", "country" : "NLD" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value ((extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())))
16. Location.managingOrganization
Definition

The organization responsible for the provisioning and upkeep of the location.

ShortOrganization responsible for provisioning and upkeep
Comments

This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

Control0..1
TypeReference(nl-core-organization, Organization)
Summarytrue
Requirements

Need to know who manages the location.

18. Location.partOf
Definition

Another Location which this Location is physically part of.

ShortAnother Location this one is physically part of
Control0..1
TypeReference(nl-core-location, Location)
Requirements

For purposes of location, display and identification, knowing which locations are located within other locations is important.

Guidance on how to interpret the contents of this table can be found here

0. Location
Definition

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

ShortDetails and position information for a physical place
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Location.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Location.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Summarytrue
6. Location.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. Location.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Common Languages
(extensible to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Location.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Control0..1
This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
12. Location.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
14. Location.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
16. Location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
18. Location.identifier
Definition

Unique code or number identifying the location to its users.

ShortUnique code or number identifying the location to its users
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

Organization label locations in registries, need to keep track of those.

20. Location.status
Definition

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Shortactive | suspended | inactive
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control0..1
BindingThe codes SHALL be taken from LocationStatus
(required to http://hl7.org/fhir/ValueSet/location-status)

Indicates whether the location is still in use.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
22. Location.operationalStatus
Definition

The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance.

ShortThe Operational status of the location (typically only for a bed/room)
Control0..1
BindingThe codes SHOULD be taken from v2 Bed Status
(preferred to http://hl7.org/fhir/ValueSet/v2-0116)

The operational status if the location (where typically a bed/room)

TypeCoding
Summarytrue
24. Location.name
Definition

Name of the location as used by humans. Does not need to be unique.

ShortLocationName
Comments

If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesOrganizationLocation, OrganisatieLocatie, DispenseLocation, Afleverlocatie
26. Location.alias
Definition

A list of alternate names that the location is known as, or was known as in the past.

ShortA list of alternate names that the location is known as, or was known as in the past
Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the location was known by can be very useful.

28. Location.description
Definition

Description of the Location, which helps in finding or referencing the place.

ShortAdditional details about the location that could be displayed as further information to identify the location beyond its name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Humans need additional information to verify a correct location has been identified.

30. Location.mode
Definition

Indicates whether a resource instance represents a specific location or a class of locations.

Shortinstance | kind
Comments

This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood.

Control0..1
BindingThe codes SHALL be taken from LocationMode
(required to http://hl7.org/fhir/ValueSet/location-mode)

Indicates whether a resource instance represents a specific location or a class of locations.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

32. Location.type
Definition

Indicates the type of function performed at the location.

ShortType of function performed
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ServiceDeliveryLocationRoleType
(extensible to http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType)

Indicates the type of function performed at the location.

TypeCodeableConcept
Summarytrue
34. Location.telecom
Definition

Contact information includes a person's telephone numbers en e-mail addresses.

ShortContactInformation
Control0..*
This element is affected by the following invariants: ele-1
TypeContactPoint(nl-core-contactpoint)
Alternate NamesContactgegevens
Example<br/><b>Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "work" } <br/><b>Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "mobile" } <br/><b>Primary Home Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Private email address</b>:{ "system" : "email", "value" : "giesput@myweb.nl", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
36. Location.address
Definition

There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world and adds all relevant components to express Dutch addresses.

A Dutch Address is a proper FHIR Address. Systems that do not understand any of the extensions, will be able to render and work with a Dutch address. Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.

To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.

The HCIM defines certain address types in the AdresSoortCodelijst. These do not all have a one to one mapping in the FHIR Address datatype. The following explains how to deal with that. In addition, there are the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType to define this relationship

HCIM Postal Address maps to Address.type 'postal';

HCIM Primary Home Address maps to Address.extension:official 'true' + Address.use 'home' + Address.use.extension 'HP';

HCIM Visit Address (Woon-/verblijfadres) maps to Address.use 'home' + Address.type 'physical' + Address.use.extension 'PHYS';

HCIM Temporary Address maps to Address.use 'temp';

HCIM Work Place Address maps to Address.use 'work';

HCIM Vacation Home Address maps to Address.use 'temp' + Address.use.extension 'HV'.

If Address.type is "both" then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.

ShortAddressInformation
Comments

Note: address is for postal addresses, not physical locations.

Control0..1
This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts
TypeAddress(nl-core-address)
Requirements

If locations can be visited, we need to keep track of their address.

Alternate NamesAdresInformatie, Adresgegevens
Example<br/><b>Example of a vacation home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : false }], "use" : "temp", "_use" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use", "valueCode" : "HV" }] }, "line" : ["Binnenkant 12A Hoog"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "12" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix", "valueString" : "A" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID", "valueString" : "Hoog" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1000AA", "country" : "NLD" } <br/><b>Example of a primary home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : true }], "use" : "home", "line" : ["Binnenkant to 10"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator", "valueString" : "to" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "10" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1001AA", "country" : "NLD" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value ((extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())))
38. Location.physicalType
Definition

Physical form of the location, e.g. building, room, vehicle, road.

ShortPhysical form of the location
Control0..1
BindingFor example codes, see LocationType
(example to http://hl7.org/fhir/ValueSet/location-physical-type)

Physical form of the location

TypeCodeableConcept
Summarytrue
Requirements

For purposes of showing relevant locations in queries, we need to categorize locations.

40. Location.position
Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

ShortThe absolute geographic location
Control0..1
TypeBackboneElement
Requirements

For mobile applications and automated route-finding knowing the exact location of the Location is required.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
42. Location.position.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
44. Location.position.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
46. Location.position.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
48. Location.position.longitude
Definition

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

ShortLongitude with WGS84 datum
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. Location.position.latitude
Definition

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

ShortLatitude with WGS84 datum
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Location.position.altitude
Definition

Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

ShortAltitude with WGS84 datum
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Location.managingOrganization
Definition

The organization responsible for the provisioning and upkeep of the location.

ShortOrganization responsible for provisioning and upkeep
Comments

This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

Control0..1
TypeReference(nl-core-organization)
Summarytrue
Requirements

Need to know who manages the location.

56. Location.partOf
Definition

Another Location which this Location is physically part of.

ShortAnother Location this one is physically part of
Control0..1
TypeReference(nl-core-location)
Requirements

For purposes of location, display and identification, knowing which locations are located within other locations is important.

58. Location.endpoint
Definition

Technical endpoints providing access to services operated for the location.

ShortTechnical endpoints providing access to services operated for the location
Control0..*
TypeReference(Endpoint)
Requirements

Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.