PRSB-Standards/WRIST-ips-datatypes/ips-datatypes v1-build.0.3

The Label Concept IPS data type describes data items that are containers for other data items, as defined in BS EN ISO 27269:2025 section 6.2.2.

The List IPS data type describes an implementation agnostic representation of data items that are containers for lists of other data items (e.g. problem list), as defined in BS EN ISO 27269:2025 section 6.2.3. In PRSB standards lists will usually be represented by record entries with a cardinality of 0 to many or 1 to many. Where there are mandatory data items of the type List in a clinical record, the reason for an empty list must be explicitly stated (e.g. No Known Drug Allergies or Not asked).

The Reference IPS data type provides a representation of an implementation independent directional link from a source data item to an internal (i.e. within the clinical record) or external target object (e.g. URL), as defined in BS EN ISO 27269:2025 section 6.2.4. In PRSB standards references are also defined by specific complex data types indicating the target component, which may be an entire information model (e.g. About Me), section or record entry (e.g. Procedures and therapies) or fewer data items such as clusters or individual elements.

The Person Name IPS data type represents the name of a person structured as a sequence of name parts (e.g. first name, family name, title, suffix), as defined in BS EN ISO 27269:2025 section 6.2.5. PRSB recommends use of NHS Data Dictionary elements for name parts (e.g. PERSON GIVEN NAME for first name).

The Coded Element IPS data type describes elements holding a single concept from a defined code system (e.g. SNOMED CT) as defined in BS EN ISO 27269:2025 section 6.2.6. PRSB recommends the exceptional use of free text in circumstances where no appropriate coded concept is available.

The Date Time IPS data type supports representation of a full or partial date and/or time as defined in BS EN ISO 27269:2025 section 6.2.7.

The Identifier IPS data type defines a unique name for a thing or object, as defined in BS EN ISO 27269:2025 section 6.2.8. For example, NHS number.

The Address IPS data type represents the address of a person or organisation structured as a sequence of address parts (e.g. Address line 1, Address line 2, Postcode etc), as defined in BS EN ISO 27269:2025 section 6.2.9. PRSB recommends use of:

• NHS Data Dictionary attributes for address parts (e.g. ADDRESS LINE 1) and specific use codes (i.e. ADDRESS ASSOCIATION TYPE).
• Unique Property Reference Number (UPRN) identifiers, where available.
• Organisation Data Service (ODS) codes to retrieve address details, where available.

The Telecom IPS data type provides the telecommunication contact details of a person or organisation (e.g. contact telephone number, email address), as defined in BS EN ISO 27269:2025 section 6.2.10. PRSB recommends use of:

• NHS Data Dictionary attributes (i.e. COMMUNICATION CONTACT METHOD and COMMUNICATION CONTACT STRING) and the FHIR value set ContactPointUse for these details.
• Organisation Data Service (ODS) codes to retrieve organisation contact telephone numbers, where available.

This aligns to the IPS data type Organization Name and represents the name for an organisation as a simple string, as defined in BS EN ISO 27269:2025 section 6.2.11. PRSB recommends use of Organisation Data Service (ODS) codes to retrieve organisation names, where available.

The Text IPS data type supports human readable text (e.g. for clinical narrative or a person's About Me responses), as defined in BS EN ISO 27269:2025 section 6.2.12.

The Any IPS data type is an abstract data type of which all other data types are concrete specialisations, as defined in BS EN ISO 27269:2025 section 6.2.13. This data type is not generally used for PRSB data items, which must usually use concrete IPS (i.e. Label Concept, List, Reference (PRSB equivalent), Person Name, Coded Element, Date Time, Identifier, Address, Telecom, Organisation Name (PRSB equivalent), Text, Range, Quantity, Period, General Time Specification (abstract type), String, and Ratio) or PRSB (Code No Text, Timestamp, Document, MultiMedia, Lower Limit Range and Upper Limit Range) data types. Occasionally, Any may be used in draft specifications as a placeholder for another data type.

The Range IPS data type represents an ordered set of quantities usually expressed as lower and upper limit values with units of measure, as defined in BS EN ISO 27269:2025 section 6.2.14. Exceptionally the lower or upper limit value may be omitted (e.g. < 3.0 mmol/ L). PRSB recommends use of UCUM (Unified Code for Units of Measure) for representing units. The PRSB data types Lower Limit Range and Upper Limit Range constrain this data type.

The Quantity IPS data type defines dimensioned quantities that are usually the result of measuring and expressed as values with units of measure (e.g. 120 mmHg), as defined in BS EN ISO 27269:2025 section 6.2.15. PRSB recommends use of UCUM (Unified Code for Units of Measure) for representing units.

The Period IPS data type defines an ordered set of time stamps for start and end date times (e.g. from 1 Aug 2024 to 31 July 2025) or start date time and width (e.g. from 1 Aug 2024 for one year), as defined in BS EN ISO 27269:2025 section 6.2.16.

This aligns to the IPS data type General Time Specification (GTS) and is an abstract data type that defines an unordered set of distinct values that are time quantities used for specifying the timing of certain events and actions that may be cyclical (e.g. every other Wednesday morning from 1 Aug 2024 to 31 July 2025), as defined in BS EN ISO 27269:2025 section 6.2.17.

The String IPS data type supports machine readable text (i.e. character string), as defined in BS EN ISO 27269:2025 section 6.2.18.

The Ratio IPS data type broadly defines a quotient quantity with a numerator and denominator (e.g. an insulin to carbohydrate ratio (ICR) of 1:10), as defined in BS EN ISO 27269:2025 section 6.2.19.