Research Data Sharing IG
1.0.0 - CI Build
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/DataRequirement-IEHR | Version: 1.0.0 | |||
| Draft as of 2024-04-08 | Computable Name: DataRequirementWithFrequency | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DataRequirement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DataRequirement |
0..* | DataRequirement | Describes a required data item | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  Function |
0..1 | (Complex) | Function URL: http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR | |
  url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR" | |
| Frequency |
0..1 | (Complex) | Frequency URL: http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR" | |
 codeFilter |
||||
   code |
0..* | CodingIEHR | Coding | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DataRequirement |
0..* | DataRequirement | Describes a required data item | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Function |
0..1 | (Complex) | Function URL: http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Closed by value:url | |
  extension:Name |
1..1 | Extension | Extension | |
   url |
1..1 | uri | "Name" | |
| value[x] |
1..1 | Coding | Value of extension Binding: Function Codes ValueSet (required) | |
 extension:Parameter |
0..* | Extension | Extension | |
| url |
1..1 | uri | "Parameter" | |
| value[x] |
1..1 | string | Value of extension | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR" | |
| Frequency |
0..1 | (Complex) | Frequency URL: http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR" | |
| value[x] |
1..1 | Timing | Value of extension | |
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DataRequirement.extension:Function.extension:Name.value[x] | required | FunctionCodesValueSet (a valid code from Possible codes for the Function Extension)http://interopehrate.eu/fhir/ValueSet/FunctionCodesValueSet-IEHRfrom this IG | |
| DataRequirement.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard |
| 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 |
|---|---|---|---|---|
| DataRequirement |
0..* | DataRequirement | Describes a required data item | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Function |
0..1 | (Complex) | Function URL: http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:Name |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "Name" | |
| value[x] |
1..1 | Coding | Value of extension Binding: Function Codes ValueSet (required) | |
| extension:Parameter |
0..* | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "Parameter" | |
| value[x] |
1..1 | string | Value of extension | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR" | |
| Frequency |
0..1 | (Complex) | Frequency URL: http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR" | |
| value[x] |
1..1 | Timing | Value of extension | |
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data |
 subject[x] |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |
| subjectCodeableConcept |
CodeableConcept | |||
 subjectReference |
Reference(Group) | |||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
| codeFilter |
ΣC | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| path |
Σ | 0..1 | string | A code-valued attribute to filter on |
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on |
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter |
| code |
0..* | CodingIEHR | Coding | |
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| path |
Σ | 0..1 | string | A date-valued attribute to filter on |
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on |
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
| valueDateTime |
dateTime | |||
| valuePeriod |
Period | |||
| valueDuration |
Duration | |||
| limit |
Σ | 0..1 | positiveInt | Number of results |
| sort |
Σ | 0..* | Element | Order of the results |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort |
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DataRequirement.extension:Function.extension:Name.value[x] | required | FunctionCodesValueSet (a valid code from Possible codes for the Function Extension)http://interopehrate.eu/fhir/ValueSet/FunctionCodesValueSet-IEHRfrom this IG | |
| DataRequirement.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | |
| DataRequirement.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | |
| DataRequirement.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| drq-1 | error | DataRequirement.codeFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| drq-2 | error | DataRequirement.dateFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| 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 DataRequirement
Differential View
This structure is derived from DataRequirement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DataRequirement |
0..* | DataRequirement | Describes a required data item | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Function |
0..1 | (Complex) | Function URL: http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR" | |
| Frequency |
0..1 | (Complex) | Frequency URL: http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR" | |
| codeFilter |
||||
| code |
0..* | CodingIEHR | Coding | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DataRequirement |
0..* | DataRequirement | Describes a required data item | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Function |
0..1 | (Complex) | Function URL: http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:Name |
1..1 | Extension | Extension | |
| url |
1..1 | uri | "Name" | |
| value[x] |
1..1 | Coding | Value of extension Binding: Function Codes ValueSet (required) | |
| extension:Parameter |
0..* | Extension | Extension | |
| url |
1..1 | uri | "Parameter" | |
| value[x] |
1..1 | string | Value of extension | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR" | |
| Frequency |
0..1 | (Complex) | Frequency URL: http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR" | |
| value[x] |
1..1 | Timing | Value of extension | |
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DataRequirement.extension:Function.extension:Name.value[x] | required | FunctionCodesValueSet (a valid code from Possible codes for the Function Extension)http://interopehrate.eu/fhir/ValueSet/FunctionCodesValueSet-IEHRfrom this IG | |
| DataRequirement.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard |
| 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 |
|---|---|---|---|---|
| DataRequirement |
0..* | DataRequirement | Describes a required data item | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Function |
0..1 | (Complex) | Function URL: http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Closed by value:url | |
| extension:Name |
1..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "Name" | |
| value[x] |
1..1 | Coding | Value of extension Binding: Function Codes ValueSet (required) | |
| extension:Parameter |
0..* | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "Parameter" | |
| value[x] |
1..1 | string | Value of extension | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FunctionExtension-IEHR" | |
| Frequency |
0..1 | (Complex) | Frequency URL: http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR" | |
| value[x] |
1..1 | Timing | Value of extension | |
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data |
| subject[x] |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |
| subjectCodeableConcept |
CodeableConcept | |||
| subjectReference |
Reference(Group) | |||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
| codeFilter |
ΣC | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| path |
Σ | 0..1 | string | A code-valued attribute to filter on |
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on |
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter |
| code |
0..* | CodingIEHR | Coding | |
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| path |
Σ | 0..1 | string | A date-valued attribute to filter on |
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on |
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
| valueDateTime |
dateTime | |||
| valuePeriod |
Period | |||
| valueDuration |
Duration | |||
| limit |
Σ | 0..1 | positiveInt | Number of results |
| sort |
Σ | 0..* | Element | Order of the results |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort |
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DataRequirement.extension:Function.extension:Name.value[x] | required | FunctionCodesValueSet (a valid code from Possible codes for the Function Extension)http://interopehrate.eu/fhir/ValueSet/FunctionCodesValueSet-IEHRfrom this IG | |
| DataRequirement.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | |
| DataRequirement.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | |
| DataRequirement.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| drq-1 | error | DataRequirement.codeFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| drq-2 | error | DataRequirement.dateFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| 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 DataRequirement
Other representations of profile: CSV, Excel, Schematron