NHS Digital FHIR Implementation Guide

NHSDigital-Location

Conformance url	FHIR Module	Maturity Level
https://fhir.nhs.uk/StructureDefinition/NHSDigital-Location		draft

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.

Location			Location	There are no (further) constraints on this element Data type Location
identifier				There are no (further) constraints on this element Element id Location.identifier Comments SHOULD contain an ANANA/ODS code. Sliced: Unordered, Open, by system(Value)
odsCode				There are no (further) constraints on this element Element id Location.identifier:odsCode
system		1..	Fixed Value	There are no (further) constraints on this element Element id Location.identifier:odsCode.system Fixed value https://fhir.nhs.uk/Id/ods-organization-code
value		1..		There are no (further) constraints on this element Element id Location.identifier:odsCode.value
address	S	1..		There are no (further) constraints on this element Element id Location.address
managingOrganization	I		Reference(NHSDigitalOrganization)	There are no (further) constraints on this element Element id Location.managingOrganization Data type Reference(NHSDigitalOrganization) Constraints nhds-10: managingOrganization - a display name should be provided `(display.exists())`
identifier		1..		There are no (further) constraints on this element Element id Location.managingOrganization.identifier
system		1..		There are no (further) constraints on this element Element id Location.managingOrganization.identifier.system
value		1..		There are no (further) constraints on this element Element id Location.managingOrganization.identifier.value
partOf	I			There are no (further) constraints on this element Element id Location.partOf Constraints nhsd-9: partOf - display name should be provided `(display.exists())`
identifier		1..		There are no (further) constraints on this element Element id Location.partOf.identifier
system		1..		There are no (further) constraints on this element Element id Location.partOf.identifier.system
value		1..		There are no (further) constraints on this element Element id Location.partOf.identifier.value

Location			Location	There are no (further) constraints on this element Data type Location
identifier				There are no (further) constraints on this element Element id Location.identifier Comments SHOULD contain an ANANA/ODS code. Sliced: Unordered, Open, by system(Value)
odsCode				There are no (further) constraints on this element Element id Location.identifier:odsCode
system		1..	Fixed Value	There are no (further) constraints on this element Element id Location.identifier:odsCode.system Fixed value https://fhir.nhs.uk/Id/ods-organization-code
value		1..		There are no (further) constraints on this element Element id Location.identifier:odsCode.value
address	S	1..		There are no (further) constraints on this element Element id Location.address
managingOrganization	I		Reference(NHSDigitalOrganization)	There are no (further) constraints on this element Element id Location.managingOrganization Data type Reference(NHSDigitalOrganization) Constraints nhds-10: managingOrganization - a display name should be provided `(display.exists())`
identifier		1..		There are no (further) constraints on this element Element id Location.managingOrganization.identifier
system		1..		There are no (further) constraints on this element Element id Location.managingOrganization.identifier.system
value		1..		There are no (further) constraints on this element Element id Location.managingOrganization.identifier.value
partOf	I			There are no (further) constraints on this element Element id Location.partOf Constraints nhsd-9: partOf - display name should be provided `(display.exists())`
identifier		1..		There are no (further) constraints on this element Element id Location.partOf.identifier
system		1..		There are no (further) constraints on this element Element id Location.partOf.identifier.system
value		1..		There are no (further) constraints on this element Element id Location.partOf.identifier.value

You dot not have a license to run FQL queries.

Command 'pagelink' could not render: Page not found.

Search Parameters
- Mandatory Search Parameters
- Optional Search Parameters

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).