Details
-
Change Request
-
Resolution: Unresolved
-
High
-
FHIR Core (FHIR)
-
R5
-
Conformance
-
(profiles)
Description
Data Usage Conformance Extension
Following best practices for V2 (see attached) – we propose to add the following extension for profile development to support an accurate definitions and understanding of the expectations of the information provided via FHIR applications supporting a profile.
<extension url="+http://hl7.org/fhir/Profile/usagerequirement#sendingapplication+" >
<valueCode value="Required" />
</extension>
The following codes will be leveraged in support of sending application usage requirements
| Indicator | Description | Implementation Requirement | Operational Requirement |
| R | Required | The application must support an element with an “R” usage designation. | The application must value an element with an “R” usage designation. |
| RE | Required, but may be empty | The application must support an element with an “RE” usage designation. | The application must value an element with an “RE” designation if data is known for that element. |
| C | Undeclared Conditional | There are no implementation requirements. The “C” usage designation is a placeholder indicating that the usage for this element has not yet been specified. | Not Applicable. |
| C(a/b) | Declared Conditional | The application must support the implementation requirements as indicated by the true (“a”) outcome and by the false (“b”) outcome usage indicators in the declared conditional definition. | The operational usage designation for the element is determined based on the outcome of an associated predicate at runtime. If the predicate associated with the element is true, follow the usage rule requirements for “a”, which must be one of “R”, “RE”, “O”, or X”: If the predicate associated with the element is false, follow the usage rule requirements for “b”, which must be one of “R”, “RE”, “O”, or X”. |
| X | Not supported | There are no implementation requirements. | The application must not value an element with an “X” usage designation. |
| O | Optional | There are no implementation requirements. The “O” usage designation is a placeholder indicating that the usage for this element has not yet been specified. | Not Applicable. |
| B | Backwards Compatible | There are no implementation requirements. The “B” usage indicates that the element is retained for backwards compatibility of the element. Another usage indicator may be assigned in a derived profile. | Not Applicable |
<extension url="+http://hl7.org/fhir/Profile/usagerequirement#receivingapplication+" >
<valueCode value="Optional" />
</extension>
The following represents the value set for receiving applications
| R | Required | The application must support an element with an “R” usage designation. | The receiving application must process in a meaningful way the information conveyed by an element with an “R” usage designation. A receiving application must raise an exception due to the absence of a required element. A receiving application must not raise an exception due to the presence of a required element . | |
| RE | Required, but may be empty | The application must support an element with an “RE” usage designation. | The receiving application must process in a meaningful way the information conveyed by an element with an “RE” usage designation. | The receiving application must process the message if the element is omitted (that is, an exception must not be raised because the element is missing). A receiving application must not raise an exception due to the presence of a required element . |
| C | Undeclared Conditional | There are no implementation requirements. The “C” usage designation is a placeholder indicating that the usage for this element has not yet been specified. | Not Applicable. | |
| C(a/b) | Declared Conditional | The application must support the implementation requirements as indicated by the true (“a”) outcome and by the false (“b”) outcome usage indicators in the declared conditional definition. | The operational usage designation for the element is determined based on the outcome of an associated predicate at runtime. If the predicate associated with the element is true, follow the usage rule requirements for “a”, which must be one of “R”, “RE”, “O”, or X”: If the predicate associated with the element is false, follow the usage rule requirements for “b”, which must be one of “R”, “RE”, “O”, or X”. | |
| X | Not supported | There are no implementation requirements. | None if the element is not present. If the element is present, the receiving application may process the message but must ignore the element content and may raise an exception. The receiving application must not process the information conveyed in an element with an “X” usage designation. | |
| O | Optional | There are no implementation requirements. The “O” usage designation is a placeholder indicating that the usage for this element has not yet been specified. | Not Applicable. The receiver in an implementation profile or implementation makes a choice of an allowable usage indicator and operates based on that usage. | |
| B | Backwards Compatible | There are no implementation requirements. The “B” usage indicates that the element is retained for backwards compatibility of the element. Another usage indicator may be assigned in a derived profile. | Not Applicable. |
