GPConnect-Location-1
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. |
Control | 1..1 |
Type | Location |
Comments | |
Location.identifier(ODS Site Code) | |
Definition |
ODS Site code to identify the organisation at site level. |
Control | 0..1 |
Type | Identifier |
Requirements |
Organization label locations in registries, need to keep track of those. |
Comments | |
Location.identifier.system | |
Definition |
Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements |
There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Fixed Value | http://fhir.nhs.net/Id/ods-site-code |
Location.identifier.value | |
Definition |
The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments |
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | RJZ46 |
Location.identifier(Other Identifier) | |
Definition |
Other identifier used to identify the location. |
Control | 0..1 |
Type | Identifier |
Requirements |
Organization label locations in registries, need to keep track of those. |
Comments | |
Location.identifier.system | |
Definition |
Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements |
There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Fixed Value | http://fhir.nhs.net/Id/ods-site-code |
Location.identifier.value | |
Definition |
The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments |
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | RJZ46 |
Location.status | |
Definition |
active | suspended | inactive |
Control | 0..1 |
Binding |
Indicates whether the location is still in use The codes SHALL be taken from http://hl7.org/fhir/ValueSet/location-status |
Type | Code |
Is Modifier | True |
Comments | |
Location.name | |
Definition |
Name of the location used for the appointment |
Control | 1..1 |
Type | String |
Comments |
The name used to identify the location of the appointment. |
Example | Haematology Clinics |
Location.description | |
Definition |
The description of the Location. |
Control | 0..1 |
Type | String |
Requirements |
Humans need additional information to verify a correct location has been identified. |
Comments | |
Location.type | |
Definition |
The type of functions performed at the location |
Control | 0..1 |
Binding |
Indicates the type of function performed at the location For example codes, see http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments | |
Location.type.coding | |
Definition |
A code taken from the location role type list of codes. |
Control | 0..1 |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Location.type.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType |
Location.type.coding.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
A code selected from the Location Type value set. |
Example | HEM |
Location.type.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
The display name for the code selected from the Location Function Type value set. |
Example | Hematology clinic |
Location.type.text | |
Definition |
A 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. |
Control | 0..1 |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Location.telecom | |
Definition |
The contact details of the location, including phone numbers, fax numbers, mobile numbers, email addresses. |
Control | 0..* |
Type | ContactPoint |
Comments | |
Location.telecom.system | |
Definition |
Telecommunications form for contact point - what communications system is required to make use of the contact |
Control | 0..1 ? |
Binding |
Telecommunications form for contact point The codes SHALL be taken from http://hl7.org/fhir/valueset-contact-point-system |
Type | Code |
Comments | |
Location.telecom.value | |
Definition |
The actual contact details (i.e. phone number or email address). |
Control | 0..1 |
Type | String |
Requirements |
Need to support legacy numbers that are not in a tightly controlled format. |
Comments |
Contact details in the form of telephone numbers, fax numbers and email addresses. |
Location.telecom.use | |
Definition |
Identifies the purpose for the contact point. |
Control | 0..1 |
Binding |
Use of contact point The codes SHALL be taken from http://hl7.org/fhir/valueset-contact-point-use |
Type | Code |
Is Modifier | True |
Requirements |
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments |
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. |
Location.telecom.period | |
Definition |
Time period when the contact point was/is in use. |
Control | 0..1 |
Type | Period |
Comments | |
Location.telecom.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 1..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Location.telecom.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Location.address | |
Definition |
The address for the location. |
Control | 0..1 |
Type | Address |
Requirements |
If locations can be visited, we need to keep track of their address. |
Comments |
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. |
Location.address.use | |
Definition |
The purpose of this address. |
Control | 0..1 |
Binding |
The use of an address The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows an appropriate address to be chosen from a list of many. |
Comments |
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. |
Example | work |
Location.address.type | |
Definition |
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Control | 0..1 |
Binding |
The type of an address (physical/postal) The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-type |
Type | Code |
Comments | |
Example | both |
Location.address.text | |
Definition |
A full text representation of the address. |
Control | 0..1 |
Type | String |
Requirements |
A renderable, unencoded form. |
Comments |
Can provide both a text representation and parts. |
Example | Denmark Hill, London, SE5 9RS |
Location.address.line | |
Definition |
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Control | 0..* |
Type | String |
Requirements |
home | work | temp | old - purpose of this address. |
Comments | |
Example | Denmark Hill |
Location.address.city | |
Definition |
The name of the city, town, village or other community or delivery center. |
Control | 0..1 |
Type | String |
Aliases | Muncipality |
Comments | |
Example | London |
Location.address.district | |
Definition |
The name of the administrative area (county). |
Control | 0..1 |
Type | String |
Aliases | County |
Comments |
District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead. |
Example | |
Location.address.postalCode | |
Definition |
A postal code designating a region defined by the postal service. |
Control | 0..1 |
Type | String |
Aliases | Zip |
Comments | |
Example | SE5 9RS |
Location.address.country | |
Definition |
Country - a nation as commonly understood or generally accepted. |
Control | 0..1 |
Type | String |
Comments |
ISO 3166 3 letter codes can be used in place of a full country name. |
Example | GBR |
Location.address.period | |
Definition |
Time period when address was/is in use. |
Control | 0..1 |
Type | Period |
Requirements |
Allows addresses to be placed in historical context. |
Comments | |
Location.address.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Location.address.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Location.physicalType | |
Definition |
Physical form of the location, e.g. building, room, vehicle, road. |
Control | 0..1 |
Binding |
Physical form of the location For example codes, see http://hl7.org/fhir/ValueSet/location-physical-type ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements |
For purposes of showing relevant locations in queries, we need to categorize locations. |
Comments | |
Location.physicalType.coding(SNOMED CT) | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..1 |
Binding |
Physical form of the location The codes SHALL be taken from http://fhir.nhs.net/ValueSet/cda-care-setting-type-snct-1 |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
Location.physicalType.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Location.physicalType.coding.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
A code selected from the Location Physical Type value set. |
Location.physicalType.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
The display name for the code selected from the Location Physical Type value set. |
Location.physicalType.coding(READ V2) | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..1 |
Binding |
Physical form of the location The codes SHALL be taken from http://read.info/readv2 |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
Location.physicalType.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Location.physicalType.coding.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
A code selected from the Location Physical Type value set. |
Location.physicalType.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
The display name for the code selected from the Location Physical Type value set. |
Location.physicalType.coding(READ CTV3) | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..1 |
Binding |
Physical form of the location The codes SHALL be taken from http://read.info/ctv3 |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
Location.physicalType.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Location.physicalType.coding.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
A code selected from the Location Physical Type value set. |
Location.physicalType.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
The display name for the code selected from the Location Physical Type value set. |
Location.physicalType.text | |
Definition |
A 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. |
Control | 0..1 |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Location.managingOrganization | |
Definition |
The organization that is responsible for the provisioning and upkeep of the location. |
Control | 0..1 |
Requirements |
Need to know who manages the location. |
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. |
Location.managingOrganization.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the url conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Example | Organization/1474506e-609d-412e-952b-4bc74d769038 |
Location.managingOrganization.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | King's College Hospital |
Location.partOf | |
Definition |
Another Location which this Location is physically part of. |
Control | 0..1 |
Requirements |
For purposes of location, display and identification, knowing which locations are located within other locations is important. |
Comments | |
Location.partOf.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the url conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Location.partOf.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |