ZD Location
Resources conforming to this profile are sent by ZorgDomein as part of a Bundle that is sent to deliver a FHIR document to the information system of the referrer or care provider.
The canonical URL for this profile is:
http://zorgdomein.nl/fhir/StructureDefinition/zd-location
This profile builds on Location.
Location | S | 0..* | Location | Element Id
Location A grouping of people or organizations with a common purpose DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
|
identifier | S Σ | 0..* | Identifier | Element Id
Location.identifier Identifies this organization across multiple systems DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Unordered, Open, by system(Value) Constraints
|
AGB-code | Σ | 0..1 | Identifier | Element Id
Location.identifier:AGB-code Identifies this location by AGB-code DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those.
|
use | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Location.identifier:AGB-code.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
|
type | Σ | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Location.identifier:AGB-code.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
|
system | Σ | 1..1 | uriFixed Value | Element Id
Location.identifier:AGB-code.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://fhir.nl/fhir/NamingSystem/agb-z
|
value | Σ | 1..1 | string | Element Id
Location.identifier:AGB-code.value AGB-code of location DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General
123456 Mappings
|
period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Location.identifier:AGB-code.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
assigner | Σ | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
Location.identifier:AGB-code.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
status | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Location.status active | suspended | inactive DefinitionThe 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. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
|
operationalStatus | Σ | 0..1 | CodingBinding |
There are no (further) constraints on this element Element Id
Location.operationalStatus The Operational status of the location (typically only for a bed/room) DefinitionThe 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. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.
|
name | S Σ | 1..1 | string | Element Id
Location.name Name of location DefinitionName of the location as used by humans. Does not need to be unique. 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.
|
alias | S | 0..* | string | Element Id
Location.alias "Schermvermelding" for this location DefinitionA list of alternate names that the location is known as, or was known as in the past. 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. 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.
|
description | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. Note that FHIR strings may not exceed 1MB in size
|
mode | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Location.mode instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Location.type Type of function performed DefinitionIndicates the type of function performed at the location. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. ServiceDeliveryLocationRoleType (extensible) Constraints
|
telecom | 0..* | ContactPoint | Element Id
Location.telecom A contact detail for the location DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
|
|
system | Σ | 1..1 | codeBinding |
There are no (further) constraints on this element Element Id
Location.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size
|
value | Σ | 1..1 | string |
There are no (further) constraints on this element Element Id
Location.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 1..1 | codeBinding |
There are no (further) constraints on this element Element Id
Location.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
|
rank | Σ | 0..1 | positiveInt |
There are no (further) constraints on this element Element Id
Location.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Location.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
address | 0..1 | nl-core-address | Element Id
Location.address An address for the location Alternate namesAdresInformatie DefinitionThis datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. 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. Separate address parts The first addition is that 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. Custom address types The second addition is that the HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The HCIM code itself should also be included using the AddressType extension.
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. NOTE: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension. If locations can be visited, we need to keep track of their address. Note: address is for postal addresses, not physical locations.
Example of a Vacation Home address
{ "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "HV", "display": "Vakantie adres" } ] } } ], "use": "temp", "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" } Example of a Primary Home address
{ "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "HP", "display": "Officieel adres" } ] } }, { "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" } Mappings
|
|
extension | 0..* | Extension |
There are no (further) constraints on this element Element Id
Location.address.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
|
AddressType | 0..1 | Extension(CodeableConcept) |
There are no (further) constraints on this element Element Id
Location.address.extension:AddressType Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.extension:AddressType.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
|
|
valueCodeableConcept | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Location.address.extension:AddressType.value[x]:valueCodeableConcept AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. This extension can be used to include the HCIM AddressType code. See the documentation on the root level for mapping these codes to the various elements of this datatype. NOTE: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension. AdresSoortCodelijst (extensible) Constraints
|
|
official | 0..1 | Extension(boolean) |
There are no (further) constraints on this element Element Id
Location.address.extension:official Mark an address as an 'officially registered' address. Alternate namesextensions, user content, Markeer een adres als een 'officieel geregistreerd adres. DefinitionMark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP) 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. http://fhir.nl/fhir/StructureDefinition/nl-core-address-official Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.extension:official.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
|
|
valueBoolean | 1..1 | boolean |
There are no (further) constraints on this element Element Id
Location.address.extension:official.valueBoolean:valueBoolean true if part of an official registry. false if it is not Alternate namestrue als deze deel is van een officieel register. false indien dat niet het geval is DefinitionWhen the value is true, this address is marked to be part of an official registry (Dutch realm: BRP). When the value is false, this address is explicitly marked as not part of an official registry. A stream of bytes, base64 encoded
|
|
use | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Location.address.use home | work | temp | old - purpose of this address DefinitionPurpose of this address Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. Permitted Values AdresSoortCodelijst-to-AddressUse Constraints
General
home Mappings
|
type | Σ | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Location.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size Permitted Values AdresSoortCodelijst-to-AddressType Constraints
General
both Mappings
|
text | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.text Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts.
General
137 Nowhere Street, Erewhon 9132 Mappings
|
line | Σ | 0..* | string |
There are no (further) constraints on this element Element Id
Location.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size
General
137 Nowhere Street Mappings
|
extension | 0..* | Extension |
There are no (further) constraints on this element Element Id
Location.address.line.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
|
streetName | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Location.address.line.extension:streetName streetName Alternate namesextensions, user content DefinitionStreet name. If the address is a P.O. Box then the Dutch word "Postbus" shall be communicated. If the address is an answer number (mailing address where the receiver pays postage) then the Dutch word "Antwoordnummer" shall be communicated. Basisregistratie Persoonsgegevens 11.10 Straatnaam 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.line.extension:streetName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
|
|
valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.line.extension:streetName.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
houseNumber | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Location.address.line.extension:houseNumber houseNumber Alternate namesextensions, user content DefinitionThe element houseNumber shall contain the house number. The house number may contains non-numeric parts that further determine the address, e.g. "23a", but only if the source system cannot discretely communicate those. House letter shall, if possible, be communicated through the element buildingNumberSuffix. Information such as "to" (house boats that do not have their own house number, but are across (tegenover) a house with a house number or "3 hoog achter" are not part of this attribute. This type of information is conveyed elsewhere in the Address datatype. Basisregistratie Persoonsgegevens 11.20 Huisnummer 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.line.extension:houseNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
|
|
valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.line.extension:houseNumber.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
buildingNumbersuffix | 0..* | Extension(string) |
There are no (further) constraints on this element Element Id
Location.address.line.extension:buildingNumbersuffix buildingNumberSuffix Alternate namesextensions, user content DefinitionHouseNumberLetter
HouseNumberAddition
Basisregistratie Persoonsgegevens 11.30 Huisletter 11.40 Huisnummertoevoeging 12.10 Locatieomschrijving Export
Import
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.line.extension:buildingNumbersuffix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
|
|
valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.line.extension:buildingNumbersuffix.value[x]:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
unitID | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Location.address.line.extension:unitID unitID Alternate namesextensions, user content DefinitionExtra information such as the building name, building number, entrance, route number. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.line.extension:unitID.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
|
|
valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.line.extension:unitID.value[x]:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
additionalLocator | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Location.address.line.extension:additionalLocator additionalLocator Alternate namesextensions, user content DefinitionHouseNumberIndication - The indication used for addresses that do not consist of the usual street name and house number. Basisregistratie Persoonsgegevens 11.50 Aanduiding bij huisnummer 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.line.extension:additionalLocator.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
|
|
valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.line.extension:additionalLocator.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
buildingNumberSuffix | 0..* | Extension |
There are no (further) constraints on this element Element Id
Location.address.line.extension:buildingNumberSuffix Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.line.extension:buildingNumberSuffix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
buildingNumberSuffix
|
|
valueString | 0..1 |
There are no (further) constraints on this element Element Id
Location.address.line.extension:buildingNumberSuffix.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
||
valueBase64Binary | base64Binary |
There are no (further) constraints on this element Data Type
|
||
valueBoolean | boolean |
There are no (further) constraints on this element Data Type
|
||
valueCode | code |
There are no (further) constraints on this element Data Type
|
||
valueDate | date |
There are no (further) constraints on this element Data Type
|
||
valueDateTime | dateTime |
There are no (further) constraints on this element Data Type
|
||
valueDecimal | decimal |
There are no (further) constraints on this element Data Type
|
||
valueId | id |
There are no (further) constraints on this element Data Type
|
||
valueInstant | instant |
There are no (further) constraints on this element Data Type
|
||
valueInteger | integer |
There are no (further) constraints on this element Data Type
|
||
valueMarkdown | markdown |
There are no (further) constraints on this element Data Type
|
||
valueOid | oid |
There are no (further) constraints on this element Data Type
|
||
valuePositiveInt | positiveInt |
There are no (further) constraints on this element Data Type
|
||
valueString | string |
There are no (further) constraints on this element Data Type
|
||
valueTime | time |
There are no (further) constraints on this element Data Type
|
||
valueUnsignedInt | unsignedInt |
There are no (further) constraints on this element Data Type
|
||
valueUri | uri |
There are no (further) constraints on this element Data Type
|
||
valueAddress | Address |
There are no (further) constraints on this element Data Type
|
||
valueAge | Age |
There are no (further) constraints on this element Data Type
|
||
valueAnnotation | Annotation |
There are no (further) constraints on this element Data Type
|
||
valueAttachment | Attachment |
There are no (further) constraints on this element Data Type
|
||
valueCodeableConcept | CodeableConcept |
There are no (further) constraints on this element Data Type
|
||
valueCoding | Coding |
There are no (further) constraints on this element Data Type
|
||
valueContactPoint | ContactPoint |
There are no (further) constraints on this element Data Type
|
||
valueCount | Count |
There are no (further) constraints on this element Data Type
|
||
valueDistance | Distance |
There are no (further) constraints on this element Data Type
|
||
valueDuration | Duration |
There are no (further) constraints on this element Data Type
|
||
valueHumanName | HumanName |
There are no (further) constraints on this element Data Type
|
||
valueIdentifier | Identifier |
There are no (further) constraints on this element Data Type
|
||
valueMoney | Money |
There are no (further) constraints on this element Data Type
|
||
valuePeriod | Period |
There are no (further) constraints on this element Data Type
|
||
valueQuantity | Quantity |
There are no (further) constraints on this element Data Type
|
||
valueRange | Range |
There are no (further) constraints on this element Data Type
|
||
valueRatio | Ratio |
There are no (further) constraints on this element Data Type
|
||
valueSampledData | SampledData |
There are no (further) constraints on this element Data Type
|
||
valueSignature | Signature |
There are no (further) constraints on this element Data Type
|
||
valueTiming | Timing |
There are no (further) constraints on this element Data Type
|
||
valueMeta | Meta |
There are no (further) constraints on this element Data Type
|
||
valueReference | Reference() |
There are no (further) constraints on this element Data Type
|
||
unitID | 0..* | Extension |
There are no (further) constraints on this element Element Id
Location.address.line.extension:unitID Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.line.extension:unitID.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
unitID
|
|
valueString | 0..1 |
There are no (further) constraints on this element Element Id
Location.address.line.extension:unitID.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
||
valueBase64Binary | base64Binary |
There are no (further) constraints on this element Data Type
|
||
valueBoolean | boolean |
There are no (further) constraints on this element Data Type
|
||
valueCode | code |
There are no (further) constraints on this element Data Type
|
||
valueDate | date |
There are no (further) constraints on this element Data Type
|
||
valueDateTime | dateTime |
There are no (further) constraints on this element Data Type
|
||
valueDecimal | decimal |
There are no (further) constraints on this element Data Type
|
||
valueId | id |
There are no (further) constraints on this element Data Type
|
||
valueInstant | instant |
There are no (further) constraints on this element Data Type
|
||
valueInteger | integer |
There are no (further) constraints on this element Data Type
|
||
valueMarkdown | markdown |
There are no (further) constraints on this element Data Type
|
||
valueOid | oid |
There are no (further) constraints on this element Data Type
|
||
valuePositiveInt | positiveInt |
There are no (further) constraints on this element Data Type
|
||
valueString | string |
There are no (further) constraints on this element Data Type
|
||
valueTime | time |
There are no (further) constraints on this element Data Type
|
||
valueUnsignedInt | unsignedInt |
There are no (further) constraints on this element Data Type
|
||
valueUri | uri |
There are no (further) constraints on this element Data Type
|
||
valueAddress | Address |
There are no (further) constraints on this element Data Type
|
||
valueAge | Age |
There are no (further) constraints on this element Data Type
|
||
valueAnnotation | Annotation |
There are no (further) constraints on this element Data Type
|
||
valueAttachment | Attachment |
There are no (further) constraints on this element Data Type
|
||
valueCodeableConcept | CodeableConcept |
There are no (further) constraints on this element Data Type
|
||
valueCoding | Coding |
There are no (further) constraints on this element Data Type
|
||
valueContactPoint | ContactPoint |
There are no (further) constraints on this element Data Type
|
||
valueCount | Count |
There are no (further) constraints on this element Data Type
|
||
valueDistance | Distance |
There are no (further) constraints on this element Data Type
|
||
valueDuration | Duration |
There are no (further) constraints on this element Data Type
|
||
valueHumanName | HumanName |
There are no (further) constraints on this element Data Type
|
||
valueIdentifier | Identifier |
There are no (further) constraints on this element Data Type
|
||
valueMoney | Money |
There are no (further) constraints on this element Data Type
|
||
valuePeriod | Period |
There are no (further) constraints on this element Data Type
|
||
valueQuantity | Quantity |
There are no (further) constraints on this element Data Type
|
||
valueRange | Range |
There are no (further) constraints on this element Data Type
|
||
valueRatio | Ratio |
There are no (further) constraints on this element Data Type
|
||
valueSampledData | SampledData |
There are no (further) constraints on this element Data Type
|
||
valueSignature | Signature |
There are no (further) constraints on this element Data Type
|
||
valueTiming | Timing |
There are no (further) constraints on this element Data Type
|
||
valueMeta | Meta |
There are no (further) constraints on this element Data Type
|
||
valueReference | Reference() |
There are no (further) constraints on this element Data Type
|
||
city | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.city Name of city, town etc. Alternate namesMunicpality, Municipality, woonplaats DefinitionThe name of the city, town, village or other community or delivery center. Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam Note that FHIR strings may not exceed 1MB in size
General
Erewhon Example city
Den Haag Mappings
|
district | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.district District name (aka county) Alternate namesCounty, Gemeente DefinitionThe name of the administrative area (county). Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. In a Dutch address this element is used for the population of a "gemeente"
General
Madison Example district
Wateringen Mappings
|
state | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.state Sub-unit of country (abbreviations ok). Alternate namesProvince, Territory, Provincie DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). For Dutch addresses this element should contain the "provincie" code Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and Geesteren (Gelderland / Overijssel). Note that FHIR strings may not exceed 1MB in size
Example province
ZH Mappings
|
postalCode | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.postalCode Postal code for area Alternate namesZip, Postcode DefinitionA postal code designating a region defined by the postal service. Dutch postal codes have pattern '\d{4}[A-Z]{2}' so they do not have spaces. Systems can easily render postal codes with a space if necessary.
General
9132 Example postcode
9132AG Mappings
|
country | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.country Country (can be ISO 3166 3 letter code) Alternate namesland DefinitionA country (code) for the address. The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the code-specification extension under Address.country.
Example country
NLD Mappings
|
extension | 0..* | Extension |
There are no (further) constraints on this element Element Id
Location.address.country.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
|
countryCode | 0..1 | Extension(CodeableConcept) |
There are no (further) constraints on this element Element Id
Location.address.country.extension:countryCode CountryGBACode | CountryISOCode Alternate namesextensions, user content, Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet. DefinitionDefines a more specific coded value for a code or string. Especially useful for FHIR's required ValueSets. These extensions are primarily used on codes bound to a required value set, where you would like to use a more specific code than the codes in the bounded value set. 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. http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Location.address.country.extension:countryCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://nictiz.nl/fhir/StructureDefinition/code-specification
|
|
valueCodeableConcept | 1..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
Location.address.country.extension:countryCode.value[x]:valueCodeableConcept CountryGBACode | CountryISOCode Alternate namesLandGBACodelijst, LandISOCodelijst DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
coding | Σ | 1..* | Coding |
There are no (further) constraints on this element Element Id
Location.address.country.extension:countryCode.value[x]:valueCodeableConcept.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
countryGBACodelist | Σ | 0..* | CodingBinding |
There are no (further) constraints on this element Element Id
Location.address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "urn:oid:2.16.840.1.113883.2.4.4.16.34" }
|
countryISOCodelist | Σ | 0..* | CodingBinding |
There are no (further) constraints on this element Element Id
Location.address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelist Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "urn:iso:std:iso:3166" }
|
text | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Location.address.country.extension:countryCode.value[x]:valueCodeableConcept.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Location.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
General
{ "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
physicalType | Σ | 0..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
Location.physicalType Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
|
position | 0..1 | BackboneElement |
There are no (further) constraints on this element Element Id
Location.position The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required.
|
|
longitude | 1..1 | decimal |
There are no (further) constraints on this element Element Id
Location.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
|
latitude | 1..1 | decimal |
There are no (further) constraints on this element Element Id
Location.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
|
altitude | 0..1 | decimal |
There are no (further) constraints on this element Element Id
Location.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
|
managingOrganization | Σ | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
Location.managingOrganization Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. 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.
|
partOf | 0..1 | Reference(Location) |
There are no (further) constraints on this element Element Id
Location.partOf Another Location this one is physically part of DefinitionAnother Location which this Location is physically part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
|
endpoint | 0..* | Reference(Endpoint) |
There are no (further) constraints on this element Element Id
Location.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
See the profile on simplifier.net for additional details.
Resource example
Below you find an example of a Location resource that conforms to the ZD Location profile.
{
"resourceType" : "Location",
"id" : "zd-location-1",
"meta" : {
"profile" : [
"http://zorgdomein.nl/fhir/StructureDefinition/zd-location"
]
},
"identifier" : [
{
"system" : "http://fhir.nl/fhir/NamingSystem/agb-z",
"value" : "12341234"
}
],
"name" : "Locatie Breukelen",
"alias" : "Oefenziekenhuis, Locatie Breukelen",
"telecom" : [
{
"system" : "phone",
"value" : "030-1234567",
"use" : "work"
}
],
"address" : {
"extension" : [
{
"url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean" : true
}
],
"type" : "physical",
"text" : "Straatweg 68 bII, 3621 BR Breukelen",
"line" : [
"Straatweg 68 bII"
],
"_line" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString" : "Straatweg"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString" : "68"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix",
"valueString" : "bII"
}
]
}
],
"city" : "Breukelen",
"postalCode" : "3621 BR",
"country" : "NL"
}
}
<Location xmlns='http://hl7.org/fhir'>
<id value='zd-location-1'/>
<meta>
<profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-location'/>
</meta>
<identifier>
<system value='http://fhir.nl/fhir/NamingSystem/agb-z'/>
<value value='12341234'/>
</identifier>
<name value='Locatie Breukelen'/>
<alias value='Oefenziekenhuis, Locatie Breukelen'/>
<telecom>
<system value='phone'/>
<value value='030-1234567'/>
<use value='work'/>
</telecom>
<address>
<extension url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'>
<valueBoolean value='true'/>
</extension>
<type value='physical'/>
<text value='Straatweg 68 bII, 3621 BR Breukelen'/>
<line value='Straatweg 68 bII'>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'>
<valueString value='Straatweg'/>
</extension>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber'>
<valueString value='68'/>
</extension>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix'>
<valueString value='bII'/>
</extension>
</line>
<city value='Breukelen'/>
<postalCode value='3621 BR'/>
<country value='NL'/>
</address>
</Location>