NHS Digital FHIR Implementation Guide

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

NHSDigital-Organization

Conformance url FHIR Module Maturity Level
https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization Administration normative

Conformance Rules



UK Core Organization

mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
relationshipsI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
activePeriodI0..*Extension(Complex)
organisationRoleI0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ I0..1string
alias0..*string
systemΣ I0..1codeBinding
valueΣ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
addressS I0..*Address
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
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
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

from UK Core Organization

mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
relationshipsI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
activePeriodI0..*Extension(Complex)
organisationRoleI0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ I0..1string
alias0..*string
systemΣ I0..1codeBinding
valueΣ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
addressS I0..*Address
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
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
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
nhsd-6partOf.display - a display name should be providedwarningdisplay.exists()

Constraint Profiles

nameprofilepurpose
NHSDigitalOrganizationODShttps://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization-ODS

Constraint profile which represents the full NHS Digital requirement for Organization resources as defined in ODS.

NHSDigitalOrganizationSDShttps://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization-SDS

To constraint a profile for HL7 v3 backwards compatability in EPS. This will also mirror data held within the SDS LDAP database.


Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Constraints

  • org-1 (ERROR) The organization SHALL at least have a name or an identifier, and possibly more than one

extension:organizationPeriod.url

Element Id Organization.extension:organizationPeriod.url
Cardinality 1..1
Fixed Value http://hl7.org/fhir/StructureDefinition/organization-period
type http://hl7.org/fhirpath/System.String

Definition

Source of the definition for the extension code - a logical name or a URL.

Comment

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

identifier

Element Id Organization.identifier
Cardinality 1..*
Slicing OPEN discriminator - VALUE system
type Identifier

Definition

MUST contain an ANANA/ODS code.

 "identifier":  [
        {
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RR805"
        }
    ],

Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Comment

MUST contain an ANANA/ODS code.

identifier:odsOrganisationCode

Element Id Organization.identifier:odsOrganisationCode
Cardinality 1..1
Slice Name odsOrganisationCode
type Identifier

Definition

Identifier code supplier by the Organisation Data Service.

Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

identifier:odsOrganisationCode.system

Element Id Organization.identifier:odsOrganisationCode.system
Cardinality 1..1
Fixed Value https://fhir.nhs.uk/Id/ods-organization-code
type uri

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:odsSiteCode

Element Id Organization.identifier:odsSiteCode
Cardinality 0..0
Slice Name odsSiteCode
type Identifier

Definition

ODS Site code to identify the organisation at site level.

Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

identifier:odsSiteCode.system

Element Id Organization.identifier:odsSiteCode.system
Cardinality 1..1
Fixed Value https://fhir.nhs.uk/Id/ods-site-code
type uri

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

type.coding.system

Element Id Organization.type.coding.system
Cardinality 1..1
Fixed Value https://fhir.nhs.uk/CodeSystem/organisation-role
type uri

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comment

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 reference to some definition that establishes the system clearly and unambiguously.

name

Element Id Organization.name
Cardinality 0..1
type string

Definition

The ODS/SDS name of the Organisation


    "name": "NHS NIGHTINGALE HOSPITAL YORKSHIRE AND THE HUMBER"

Requirements

Need to use the name as the label of the organization.

Comment

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

telecom

Element Id Organization.telecom
Cardinality 0..*
type ContactPoint

Definition

Contact phone numbers and address of the organisation.


    "telecom":  [
        {
            "system": "fax",
            "value": "0113 242 6496",
            "use": "work"
        },
        {
            "system": "phone",
            "value": "0113 243 3144",
            "use": "work"
        }
    ],
    "address":  [
        {
            "line":  [
                "KINGS ROAD"
            ],
            "city": "HARROGATE",
            "postalCode": "HG1 5LA",
            "country": "ENGLAND"
        }
    ],
    "partOf": {
        "reference": "https://directory.spineservices.nhs.uk/R4/Organization/RR805",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RR8"
        }
    }

Requirements

Human contact for the organization.

Comment

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Constraints

  • org-3 (ERROR) The telecom of an organization can never be of use 'home'
back to top