NHS England FHIR Implementation Guide (deprecated)

Important Announcement regarding this Implementation Guide
  • As of 04/10/2023, this implementation guide has been deprecated and all development on the legacy NHS England FHIR Implementation Guide assets has ceased.
  • Therefore, vendors looking to start new implementations or looking to update existing implementations should use the new NHS England Implementation Guide. Vendors continuing to implement legacy NHS England FHIR Implementation Guide based solutions do so at their own risk and on the understanding that no maintenance or support will be available.

NHSDigital-Location

Conformance Url
https://fhir.nhs.uk/StructureDefinition/NHSDigital-Location

A Location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.



useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
addressS1..1Address
physicalTypeΣ0..1CodeableConcept
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
addressS1..1Address
physicalTypeΣ0..1CodeableConcept
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

keyhumanseverityexpression
nhds-10managingOrganization - a display name should be providedwarning(display.exists())
nhsd-9partOf - display name should be providedwarning(display.exists())

- RBA11

Search Parameters

The following search parameters and search parameter combinations SHALL be supported.:

Name Type Description Conformance Path
adddress-postcode string A postalCode specified in an address MAY Location.address.postalCode
identifier token Any identifier for the location (e.g. SDS/ODS code) MAY Location.identifier

Additional parameters can be on Location - Search Parameters

Mandatory Search Parameters

None

Optional Search Parameters

address-postcode

MAY support searching by the address-postcode search parameter:

GET [baseUrl]/Location?address-postcode=[address-postcode]

Example:

GET [baseUrl]/Location?address-postcode=NG10%201RY

Return all Location resources with Post Code of NG10 1RY.

identifier (SDS/ODS Code)

MAY support searching by the identifier search parameter:

GET [baseUrl]/Location?identifier={system|}[code]

Example:

GET [baseUrl]/Location?identifier=https://fhir.nhs.uk/Id/ods-site-code|RTG08

Return all Location resources with NHS Trust Site of RTG08 (Long Eaton Clinic).

back to top