GP Connect Get Record FHIR API Implementation Guide

GPConnect-Location-1

The Location resource provides information and details on the physical location and the services provided.

View Location Resource Changes for a delta of changes made to the standard FHIR DSTU2 Location resource for use within the GP Connect APIs.

NameCard.TypeDescription & Constraints
..LocationLocationThis location resource is constrained for GP Connect requirements

...identifierUnique code or number identifying the location to its users
Slice: Ordering: Unordered, Rules: Open at End

...identifier (ODS Site Code)0..1IdentifierODS Site code to identify the organisation at site level

....system1..1UriODS Code
Fixed Value http://fhir.nhs.net/Id/ods-site-code

....value1..1StringThe ODS Site code name, to reflect the code used
Example Value RJZ46

...identifier (Other Identifier)0..1IdentifierOther identifier used to identify the location

....system0..1UriThe namespace for the identifier

....value0..1StringThe Local Location Identifier code name, to reflect the code used
Example Value 123456

...status0..1Codeactive | suspended | inactive
Binding Indicates whether the location is still in use (http://hl7.org/fhir/ValueSet/location-status)
Binding Strength Required

...name1..1StringName of the location
Example Value Haematology Clinics

...description0..1StringThe description of the Location.

...type0..1CodeableConceptThe type of functions performed at the location
Binding Indicates the type of function performed at the location (http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType)
Binding Strength Example

....coding0..1CodingA code taken from the location role type list of codes.

.....system1..1UriIdentity of the terminology system
Fixed Value http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType

.....code1..1CodeSymbol in syntax defined by the system
Example Value HEM

.....display1..1StringRepresentation defined by the system
Example Value Hematology clinic

....text0..1StringPlain text representation of the concept

...telecom0..*ContactPointContact details of the location

....system0..1Codephone | fax | email | url.
Binding Telecommunications form for contact point (http://hl7.org/fhir/valueset-contact-point-system)
Binding Strength Required

....value0..1StringThe actual contact details

....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/valueset-contact-point-use)
Binding Strength Required

....period0..1PeriodTime period when the contact point was/is in use

.....start1..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...address0..1AddressThe address for the location

....use0..1Codehome | work | temp | old - purpose of this address
Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use)
Binding Strength Required
Example Value work

....type0..1Codepostal | physical | both
Binding The type of an address (physical/postal) (http://hl7.org/fhir/ValueSet/address-type)
Binding Strength Required
Example Value both

....text0..1StringText representation of the address
Example Value Denmark Hill, London, SE5 9RS

....line0..*StringStreet name, number, direction & P.O. Box etc
Example Value Denmark Hill

....city0..1StringName of city, town etc.
Example Value London

....district0..1StringDistrict name (aka county)
Example Value

....postalCode0..1StringPostal code for area
Example Value SE5 9RS

....country0..1StringCountry (can be ISO 3166 3 letter code)
Example Value GBR

....period0..1PeriodTime period when address was/is in use

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...physicalType0..1CodeableConceptPhysical form of the location
Binding Physical form of the location (http://hl7.org/fhir/ValueSet/location-physical-type)
Binding Strength Example

....codingCode defined by a terminology system
Slice: Ordering: Ordered, Discriminator: system, Rules: Closed

....coding (SNOMED CT)0..1CodingSNOMED CT representation of the physical form of the location
Binding Physical form of the location (http://fhir.nhs.net/ValueSet/cda-care-setting-type-snct-1)
Binding Strength Required

.....system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

....coding (READ V2)0..1CodingREAD V2 representation of the physical form of the location
Binding Physical form of the location (http://read.info/readv2)
Binding Strength Required

.....system1..1UriIdentity of the terminology system
Fixed Value http://read.info/readv2

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

....coding (READ CTV3)0..1CodingREAD CTV3 representation of the physical form of the location
Binding Physical form of the location (http://read.info/ctv3)
Binding Strength Required

.....system1..1UriIdentity of the terminology system
Fixed Value http://read.info/ctv3

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

....text0..1StringPlain text representation of the concept

...managingOrganization0..1Reference (gpconnect-organization-1)The organization that is responsible for the provisioning and upkeep of the location

....reference1..1StringRelative URL reference to the Organization resource
Example Value Organization/1474506e-609d-412e-952b-4bc74d769038

....display0..1StringNarrative text for the resource
Example Value King's College Hospital

...partOf0..1Reference (gpconnect-location-1)Another Location which this Location is physically part of

....reference1..1StringRelative URL reference to the Location resource

....display0..1StringNarrative text for the resource

Path Name Binding Strength ValueSet
.Location.status status Required http://hl7.org/fhir/ValueSet/location-status
.Location.type type Example http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType
.Location.telecom.system system Required http://hl7.org/fhir/valueset-contact-point-system
.Location.telecom.use use Required http://hl7.org/fhir/valueset-contact-point-use
.Location.address.use use Required http://hl7.org/fhir/ValueSet/address-use
.Location.address.type type Required http://hl7.org/fhir/ValueSet/address-type
.Location.physicalType.coding SNOMED CT Required http://fhir.nhs.net/ValueSet/cda-care-setting-type-snct-1
.Location.physicalType.coding READ V2 Required http://read.info/readv2
.Location.physicalType.coding READ CTV3 Required http://read.info/ctv3

GPConnect-Location-1

Examples Description XML File JSON File
Location-1a Hematology clinic
Location-1b Hospital