Appointment Framework

WARNING

This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Health Administration

Important: The content on these pages have not been approved or adopted by NHS England.

Comment on building on HL7 v2 with FHIR query api's

Patient Identity Management

This is more widely known as Admission, Discharge and Transfers (ADT)

NHS Standards include:

HL7 v2 Events and Ad Hoc FHIR RESTful Events See ADT section.
NHS England Personal Demographics Service Notifications - FHIR

IHE Standards include:

IHE Patient Identifier Cross-referencing for mobile (PIXm)
Patient Identity Feed FHIR ITI-104

In FHIR, FHIR RESTful is preferred but should you wish to go down a FHIR Messaging route, the following links provide guidance:

HL7 Version 2 to FHIR

Patient Encounter Management

This is more widely known as Admission, Discharge and Transfers (ADT)

NHS Standards include:

HL7 v2 Events and Ad Hoc FHIR RESTful Events See ADT section.

In FHIR, FHIR RESTful is preferred but should you wish to go down a FHIR Messaging route, the following links provide guidance:

HL7 Version 2 to FHIR

Patient Master Identity Registry

IHE Patient Master Identity Registry (PMIR) Profile

Patient Demographic Queries

Patient FHIR API

NHS England Profile

Command 'link' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/StructureDefinition/England-Patient'

GET [base]/Patient?param1=value&...{&_format=[mime-type]}

Search Parameters Patient

The following search parameters should be supported:

Parameters	Type	Optionality	IHE PDQm	PDS
_id	string	SHALL	✓
active	token	SHALL	✓
family	string	SHALL	✓	✓
given	string	SHALL	✓	✓
identifier	token	SHALL	✓
telecom	string	SHALL	✓	Supports email and phohe
birthdate	string	SHALL	✓	✓
address	string	SHALL	✓
address-city	string	SHALL	✓
address-country	string	SHALL	✓
address-postalcode	string	SHALL	✓	✓
address-state	string	SHALL	✓
gender	token	SHALL	✓	✓
mothersMaidenName	string	SHALL	✓

Care Directories

administration-module-prov-dir

IHE Mobile Care Services Discovery (mCSD) The Mobile Care Services Discovery (mCSD) Profile supports RESTful queries across related care services resources.

The loosely coupled design and flexible querying capability of the mCSD Profile means it can be deployed within a variety of eHealth architectures and support a wide array of care workflows.

Organization FHIR API

NHS England Profile

Command 'link' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/StructureDefinition/England-Organization'

GET [base]/Organization?param1=value&...{&_format=[mime-type]}

Search Parameters Organization

The following search parameters should be supported:

Parameters	Type	_include	Modifiers	Optionality	IHE mCSD	ODS STU3
active	token			SHALL	✓	✓
identifier	token			SHALL	✓	✓
name	string			SHALL	✓	✓
partof	reference			SHALL	✓
type	token			SHALL	✓	supports this as ods-org-role
	reference	Organization.endpoint	SHALL		✓
	reference	(reverse) Location:organization	SHALL		✓
	reference	(reverse) OrganizationAffiliation :participating-organization	SHALL		✓
	reference	(reverse) OrganizationAffiliation :primary-organization	SHALL		✓

Practitioner FHIR API

NHS England Profile

Command 'link' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/StructureDefinition/England-Practitioner'

GET [base]/Practitioner?param1=value&...{&_format=[mime-type]}

Search Parameters Practitioner

The following search parameters should be supported:

Parameters	Type	Optionality	IHE mCSD
active	token	SHALL	✓
identifier	token	SHALL	✓
name	string	SHALL	✓
given	string	SHALL	✓
family	string	SHALL	✓

PractitionerRole FHIR API

NHS England Profile

Command 'link' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/StructureDefinition/England-PractitionerRole'

GET [base]/PractitionerRole?param1=value&...{&_format=[mime-type]}

Search Parameters PractitionerRole

The following search parameters should be supported:

Parameters	Type	_include	Optionality	IHE mCSD
active	token		SHALL	✓
location	reference		SHALL	✓
organization	reference		SHALL	✓
practitioner	reference		SHALL	✓
role	token		SHALL	✓
service	reference		SHALL	✓
specialty	token		SHALL	✓
	reference	PractitionerRole:practitioner	SHALL	✓

HealthcareService FHIR API

NHS England Profile

Command 'link' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/StructureDefinition/England-HealthcareService'

GET [base]/HealthcareService?param1=value&...{&_format=[mime-type]}

Search Parameters HealthcareService

The following search parameters should be supported:

Parameters	Type	Optionality	IHE mCSD
active	token	SHALL	✓
identifier	token	SHALL	✓
location	reference	SHALL	✓
name	string	SHALL	✓
organization	reference	SHALL	✓
service-type	token	SHALL	✓

Endpoint FHIR API

NHS England Profile

Command 'link' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/StructureDefinition/England-Endpoint'

GET [base]/Endpoint?param1=value&...{&_format=[mime-type]}

Search Parameters Endpoint

The following search parameters should be supported:

Parameters	Type	Optionality	IHE mCSD	SDS
identifier	token	SHALL	✓	✓
organization	reference	SHALL	✓	supports organization:identifier as organization
status	token	SHALL	✓

OrganizationAffiliation FHIR API

No NHS England or UK Core Profile

GET [base]/OrganizationAffiliation?param1=value&...{&_format=[mime-type]}

Search Parameters OrganizationAffiliation

The following search parameters should be supported:

Parameters	Type	_include	Optionality	IHE mCSD
active	token		SHALL	✓
date	date		SHALL	✓
identifier	token		SHALL	✓
participating-organization	reference		SHALL	✓
primary-organization	reference		SHALL	✓
role	token		SHALL	✓
	reference	OrganizationAffiliation .endpoint	SHALL	✓

Location FHIR API

NHS England Profile

Command 'link' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/StructureDefinition/England-Location'

GET [base]/Location?param1=value&...{&_format=[mime-type]}

Search Parameters Location

The following search parameters should be supported:

Parameters	Type	_include	Optionality	IHE mCSD
identifier	token		SHALL	✓
name	string		SHALL	✓
organization	reference		SHALL	✓
partof	reference		SHALL	✓
status	token		SHALL	✓
type	token		SHALL	✓
		Location:organization	SHALL	✓
near