DataStandardsWales-Organization

Overview

The Organization resource contains information about health and care organisations. Examples include Health Boards and NHS Trusts, Hospitals, Dental practices GP practices and GP clusters. The DataStandardsWales-Organization profile is derived from the UK Core Organization Profile. It defines additional rules for use within health and care organisations in Wales. Further guidance on the use of the Organization resource along with other administrative FHIR resources is provided within the guidance section of this guide.

A direct link to the Data Standards Wales asset can be accessed here - Data Standards Wales Organization

Formal Views of Profile Content

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
mainLocationC0..*Extension(Reference(Location))
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valuePeriodPeriod
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
activeS Σ ?!0..1boolean
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
nameS Σ C1..1string
id0..1string
aliasTypeC0..1Extension(CodeableConcept)
value0..1System.String
id0..1string
extensionC0..*Extension
systemΣ C0..1codeBinding
valueΣ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ C0..1Period
id0..1string
addressKeyC0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ C0..1Period
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomC0..*ContactPoint
id0..1string
addressKeyC0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ C0..1Period
endpointC0..*Reference(DataStandardsWalesEndpoint)
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
mainLocationC0..*Extension(Reference(Location))
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valuePeriodPeriod
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
activeS Σ ?!0..1boolean
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
nameS Σ C1..1string
id0..1string
aliasTypeC0..1Extension(CodeableConcept)
value0..1System.String
id0..1string
extensionC0..*Extension
systemΣ C0..1codeBinding
valueΣ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ C0..1Period
id0..1string
addressKeyC0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ C0..1Period
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomC0..*ContactPoint
id0..1string
addressKeyC0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ C0..1Period
endpointC0..*Reference(DataStandardsWalesEndpoint)
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
mainLocationC0..*Extension(Reference(Location))
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valuePeriodPeriod
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
activeS Σ ?!0..1boolean
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..0string
nameS Σ C1..1string
id0..1string
aliasTypeC0..1Extension(CodeableConcept)
value0..1System.String
id0..1string
extensionC0..*Extension
systemΣ C0..1codeBinding
valueΣ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ C0..1Period
id0..1string
addressKeyC0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ C0..1Period
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomC0..*ContactPoint
id0..1string
addressKeyC0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ C0..1Period
endpointC0..*Reference(DataStandardsWalesEndpoint)

Mandatory and Must Support Data Elements

Refer to the Mandatory and Must Support page for guidance on how these elements should be interpreted.

Each Organisation must have:

  • A name
    • The Organization.name field SHALL be populated.

Each Organisation must support:

  • An identifier*

    • The Organization.identifier field SHOULD contain all available identifiers. In particular:
      • The Organisation Data Service (ODS) issues and manages unique identification codes and accompanying reference data for organisations that interact with any area of the NHS. The ODS code for organisations managed by this service SHOULD be populated (this includes ANANA format codes).

  • The active status of the organisation

    • The Organization.active field SHOULD be populated to indicate whether the organisation is still active.

  • Details of Organization.type, structured to comprise sector plus a hierarchical organisation type

    • sector SHOULD be provided to distinguish public, private and third sector organisations
    • domain SHOULD be provided to identify the domain or industry in which the organisation operates
    • classification SHOULD be provided as a high level classification of the organisation type within the applicable domain.
    • subclassification SHOULD be provided as a lower level classification of the organisation type within the applicable domain.

  • For each Organization.alias, an aliasType extension SHOULD specify the nature of the alias.

  • Where applicable:

    • the Organization.partOf field SHOULD contain a reference to the parent Organization
    • the Organization.telecon field SHOULD contain at least one contact point (e.g. telephone number)
    • the Organization.address field SHOULD contain at least one address for the organisation

*See implementation guidance for the identifier element in the Slices section below

Extensions

The following extensions are defined for use within this profile:

  • The UK Core extension Extension-UKCore-MainLocation extends the Organization resource to support the exchange of information on the organisation's main location, as a reference to a Location resource, which is currently not supported by the FHIR standard.

  • The UK Core extension Extension-UKCore-AddressKey extends the Address datatype to support the storage of address identifiers such as the Unique Property Reference Number (UPRN).

  • The HL7 common extension organization-period describes the date range that the organisation should be considered available.

  • Extension-DataStandardsWales-AliasType is used to specify the nature of each alias.

Slices

Slices apply to the following elements:

  • Organization.identifier

    • Organization.identifier:odsOrganisationCode. The ODS Organisation Code is further described here: UK Core Naming System
    • Organization.identifier:gpClusterCode. This slice is marked as deprecated because it applies to only a small proportion of organisations and is misnamed for its current use. The identifier for a primary care cluster can be recorded as a generic identifier distinguished by its system value. It is further described under the GP Cluster Code entry in the NHS Wales Data Dictionary.

  • Organization.type includes a slice for each of the four organisation type variants described above under Mandatory and Must Support Data Elements:

    • Organization.type:sector
    • Organization.type:domain
    • Organization.type:classification
    • Organization.type:subclassification