Data Type Profiles

There are four data types that are profiled in PS-CA Version 1.

Data types are profiled in order to enforce constraints on what elements within the data type are required and/or are expected for systems to be able to demonstrate support.

CodeableConcept

The Data Type: Codeable Concept (PS-CA) profile represents the constraint applied to the CodeableConcept data type by the PS-CA project to use the Data Type: Coding (PS-CA) profile in a way that is informed by the constraints of the Codeable Concept (IPS) profile but removes the overarching expectation that all patient summary creators must demonstrate they can support codings for conformance.

codingΣ0..*Data Type: Coding (PS-CA)
textS Σ0..1string

Notes:

  • This profile makes a significant change from the Codeable Concept (IPS) data type profile by removing the Must Support flag from the coding element.
  • This profile also removes the Must Support flag from the CodeableConcept itself. (This has been identified as a modelling issue with IPS.)
  • While coding is not currently considered Must Support in Version 1.0, implementers that support codings should still send the codings for codeable concepts if they are available/appropriate and receivers should not produce failures or rejections if codings are included in the patient summary (a base tenet of FHIR).
  • Additionally, vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content
  • Implementors should also be aware that this constraint will be under consideration to be re-applied in PS-CA Version 2.

Coding

The Data Type: Coding (PS-CA) profile ensures systems support important Coding elements, including system and version. It also raises awareness of the FHIR Core {{link:http://hl7.org/fhir/StructureDefinition/translation} standard extension.

This profile is informed by the constraints of the Coding with translations profile. Unlike IPS, however, the PS-CA profile does not flag the translation extension as Must Support; this may change in future releases.

systemS Σ0..1uri
versionS Σ0..1string
codeS Σ0..1code
translationI0..*Extension(Complex)
userSelectedΣ0..1boolean

Notes:

  • All Must Support elements in this profile are also Must Support in IPS-UV, and there are no differences in element cardinality. Constraints are carried over into a unique PS-CA data type profile to ensure that implementers have clarity and consistency in the expectations this guide puts forth when Must Support is claimed.
  • Unlike IPS, the PS-CA profile does not make the Coding element, itself, Must Support. (This has been identified as a modelling issue with IPS.)
  • Earlier releases of this Implementation Guide included the Must Support flag on the translation extension. Based on public feedback, the Must Support flag has been removed pending a comprehensive approach to multi-language support and conformance.

Extensions

This profile uses the following extensions:

Quantity

The Data Type: Quantity (PS-CA) profile represents the constraint applied to the Quantity data type by the PS-CA project to use UCUM as the code system for units. Informed by the constraints of the Quantity (IPS) profile.

valueΣ0..1decimal
comparatorΣ ?!0..1codeBinding
unitΣ0..1string
systemS Σ I1..1uriFixed Value
codeS Σ1..1code

Notes:

  • All Must Support elements in this profile are also Must Support in IPS-UV, and there are no differences in element cardinality. Constraints are carried over into a unique PS-CA data type profile to ensure that implementers have clarity and consistency in the expectations this guide puts forth when Must Support is claimed.
  • Unlike IPS, the PS-CA profile does not make the Quantity element, itself, Must Support. (This has been identified as a modelling issue with IPS.)

Ratio

The Data Type: Ratio (PS-CA) profile represents the constraint applied to the Ratio data type by the PS-CA project to use UCUM as the code system for units in a way that is informed by the constraints of the Ratio (IPS) profile.

numeratorS Σ I0..1Data Type: Quantity (PS-CA)
denominatorS Σ I0..1Data Type: Quantity (PS-CA)

Notes:

  • All Must Support elements in this profile are also Must Support in IPS-UV, and there are no differences in element cardinality. Constraints are carried over into a unique PS-CA data type profile to ensure that implementers have clarity and consistency in the expectations this guide puts forth when Must Support is claimed.
  • Unlike IPS, the PS-CA profile does not make the Ratio element, itself, Must Support. (This has been identified as a modelling issue with IPS.)