Important: All content in this FHIR Implementation Guide is under development

DataStandardsWales-Organization

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.

Formal Views of Profile Content

mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
hopitalClassificationI0..1Extension(CodeableConcept)
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)
activeS Σ ?!0..1boolean
typeΣ0..*CodeableConcept
nameS Σ I1..1string
alias0..*string
telecomI0..*ContactPoint
addressI0..*Address
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
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
mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
hopitalClassificationI0..1Extension(CodeableConcept)
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)
activeS Σ ?!0..1boolean
typeΣ0..*CodeableConcept
nameS Σ I1..1string
alias0..*string
telecomI0..*ContactPoint
addressI0..*Address
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
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
mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
hopitalClassificationI0..1Extension(CodeableConcept)
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)
activeS Σ ?!0..1boolean
typeΣ0..*CodeableConcept
nameS Σ I1..1string
alias0..*string
telecomI0..*ContactPoint
addressI0..*Address
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
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

Mandatory and Must Support Data Elements

When an element is mandatory (min=1), the data is expected to always be present. Elements marked with an S must be supported by both producing and receiving systems and SHOULD be populated if the data exists.

Each Organization must have:

  1. A name

Each Organization must support:

  1. An identifier *
  2. A status of the organization (i.e., whether is still active )

*see Implementation Guidance for the identifier element below

Logical Model

The diagram below shows the typical relationship between NHS Wales organizations and locations.


Implementation Guidance

  • 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 Organization's main location, as a reference to a Location resource, which is currently not supported by the FHIR standard.
    • The HL7 common extension organization-period describes the date range that the organization should be considered available.
    • The Extension-DataStandardsWales-HospitalClassification extends the Organization resource to support the communication of hospital type/classification as maintained by the Welsh Reference Data Service (WRDS). It is only required for organisations that are hospitals, and is only expected to be passed from WRDS FHIR APIs.

  • The Organisation.identifier field SHOULD contain all available identifiers. Typical identifiers include:
    • 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 organizations managed by this service should be populated (this includes ANANA format codes).
    • A GP Cluster code for Welsh GP cluster organizations.

  • The Organisation.status field SHOULD be populated to indicate whether the organization is still active.

  • The Organisation.name field SHALL be populated.

Example Organizations

The following example resources are provided within this guide: Glangwili General Hospital, Neath Port Talbot Hospital, Hywel Dda University Local Health Board, Swansea Bay University Local Health Board, GP Practice example, GP Cluster example.

Mandatory Search Parameters

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

  1. SHALL support searching by an organization identifier using the identifier search parameter:

    GET [base]/Organization?identifier={system|}[code]
    

    Example:

    1. GET [base]/Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|7A2
    2. GET [base]/Organization?identifier=https://fhir.nhs.uk/Id/gpcluster-code|CC201

    Implementation Notes: Fetches a bundle containing any Organization resources matching the identifier (how to search by token).

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching by an organization's name or alias using the name search parameter:

    GET [base]/Organization?name=[string]
    

    Example:

    1. GET [base]/Organization?name=Glangwili

    Implementation Notes: Fetches a bundle of all Organization resources that match the address string (how to search by string).