Research Data Sharing IG
1.0.0 - CI Build
Research Data Sharing IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/research-data-sharing/ and changes regularly. See the Directory of published versions
Official URL: http://interopehrate.eu/fhir/StructureDefinition/Coding-IEHR | Version: 1.0.0 | |||
Draft as of 2024-04-08 | Computable Name: CodingIEHR |
The Operator extension is optional in this profile and the default value is exact.
So if the extension is missing in a Coding-IEHR the meaning is the same as if the extension was present with the code exact.
If the Operator extension is missing or the value is exact, the coding is to be used as normal with the system in the system attribute, the relevant code in the code attribute and an optional display in the display attribute.
However, if the Operator extension has the value startsWith, the code attribute should remain empty, and the prefix should be in the display attribute. The reason for this is that the validator automatically checks all codes and since most prefixes are not valid codes on their own it will cause an error during validation if the prefix is in the code attribute.
The AutomaticallyGenerated extension is optional in this profile and the default value is false.
So if the extension is missing in a Coding-IEHR the meaning is the same as if the extension was present with the value false.
If the AutomaticallyGenerated extension is missing or the value is false, the coding was added by the creator of the resource and can be assumed to be precise.
However, if the AutomaticallyGenerated extension has the value true, the code was added automatically by an translation service, that translated the original code into the code provided by the coding.
This is necessary, if the author provided a code in an local CodeSystem and the translation service has to translate the code into the system required by the relevant IEHR profile to make the resource pass validation.
In that case this extension must be added with the value true, to alert any readers, that this code was automatically provided and there is no guarantee, that it is a perfect match for the original code.
If a translated code is used, the original code must always be provided as well and for critical operations it might be necessary, to use the original and query the meaning of the code from the author to ensure, that there is no misunderstanding.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Coding
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | Coding | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Operator | 0..1 | Coding | Optional Extensions Element URL: http://interopehrate.eu/fhir/StructureDefinition/Operator-Extension-IEHR Binding: CodingOperatorValueSet-IEHR (required) | |
AutomaticallyGenerated | 0..1 | boolean | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | Coding | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Operator | 0..1 | Coding | Optional Extensions Element URL: http://interopehrate.eu/fhir/StructureDefinition/Operator-Extension-IEHR Binding: CodingOperatorValueSet-IEHR (required) | |
AutomaticallyGenerated | 0..1 | boolean | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | Coding | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Operator | 0..1 | Coding | Optional Extensions Element URL: http://interopehrate.eu/fhir/StructureDefinition/Operator-Extension-IEHR Binding: CodingOperatorValueSet-IEHR (required) | |
AutomaticallyGenerated | 0..1 | boolean | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coding
Differential View
This structure is derived from Coding
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | Coding | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Operator | 0..1 | Coding | Optional Extensions Element URL: http://interopehrate.eu/fhir/StructureDefinition/Operator-Extension-IEHR Binding: CodingOperatorValueSet-IEHR (required) | |
AutomaticallyGenerated | 0..1 | boolean | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | Coding | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Operator | 0..1 | Coding | Optional Extensions Element URL: http://interopehrate.eu/fhir/StructureDefinition/Operator-Extension-IEHR Binding: CodingOperatorValueSet-IEHR (required) | |
AutomaticallyGenerated | 0..1 | boolean | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Coding | 0..* | Coding | Coding | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Operator | 0..1 | Coding | Optional Extensions Element URL: http://interopehrate.eu/fhir/StructureDefinition/Operator-Extension-IEHR Binding: CodingOperatorValueSet-IEHR (required) | |
AutomaticallyGenerated | 0..1 | boolean | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coding
Other representations of profile: CSV, Excel, Schematron