Profile Descriptions

Overview

This section provides an overview of the FHIR resource being profiled. Links are provided to the UK Core and base profiles from which the Data Standards Wales profile is derived.

Formal Views of Profile Content

The following formal views of the profile content are provided:

  • The Snapshot View provides a hierarchical table that presents a logical view of the profile content based on the Logical Table view described in FHIR specification.
  • The Differential View shows the difference between the Data Standards Wales profile and the base UK Core profile from which it is derived.
  • The Hybrid View provides a combination of the above views.
  • FHIR resources that implement the profiles are provided in the Examples view.

Mandatory and Must Support Data Elements

Each profile description includes Mandatory and Must Support elements.

In order to be compliant, when an element is mandatory (min=1), the data is expected to always be present - i.e. SHALL be present. Figure 1 below shows how Mandatory elements are presented in the Snapshot View.

Figure 1: Mandatory Elements

Elements marked with an S must be supported. While the definition of Must Support is quite general, in this implementation guide defines that to mean that provider SHOULD populate these elements, and consumer systems SHOULD act on this information if provided.

In the case of the Oganization.active element, Must Support would mean, for example:

  • A provider system would be expected to provide the relevant indicator to show if the organisation is still active.
  • A consuming system would be expected to act on this information and not include an organisation marked as inactive within a list of active organisations.

Figure 2 below shows how Must Support elements are presented in the Snapshot View.

Figure 2: Must Support Elements

Terminology Bindings

This section shows any terminiology bindings defined for use within the Data Standards Wales profile.

Note that this section does not repeat information on bindings defined for use within the FHIR R4 or UK Core implementation guides.

Implementation Guidance

This section provides additional guidance. While the Formal Views section described above provides the formal summary, definitions, and terminology requirements for the profile, this section seeks to provide additional information to help implementers. It may describe, for example:

  • The extensions that have been specified for use within the profile. This may include extensions defined by the following FHIR implementation guides:
    • FHIR R4
    • UK Core
    • Data Standards Wales
  • Additional guidance for those elements marked as Must Support.
  • Other relevant profile specific guidance.

Logical Model

Some profile descriptions contain a logical model to aid understanding of how a clical data is modelled using FHIR. These models may also show how different FHIR resources are linked to tell represent a complex item of clincial data.

Examples

This section profides links example resources. Every effort has been made to ensure that the examples are correct and useful, but they should not be considered a normative part of the specification.

Search Parameters

This section defines a minimum set of mandatory and optional search parameters to be implemented by API providers. It also show examples of use and links to relevant search guidance from the FHIR R4 specification.