Sample Implementation Guide for HDS, published by IMEC - AI & Data. 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/imec-int/hds_fhir and changes regularly. See the Directory of published versions
Active as of 2024-05-03 |
Definitions for the HDS-Sample-Model logical model.
Guidance on how to interpret the contents of this table can be found here
0. HDS-Sample-Model | |
Definition | HDS Sample Model |
Short | HDS-Sample-Model |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HDS-Sample-Model.dateTimeReceived | |
Definition | Timestamp received |
Short | Timestamp received |
Control | 1..1 |
Type | Element(TS) |
4. HDS-Sample-Model.dataProvider | |
Definition | Data provider |
Short | Data provider |
Control | 0..1 |
Type | BackboneElement(Class) |
6. HDS-Sample-Model.dataProvider.officeName | |
Definition | Office name |
Short | Office name |
Control | 0..1 |
Type | Element(ST20) |
8. HDS-Sample-Model.dataProvider.practitionerCircleName | |
Definition | Practitioner Circle name |
Short | Practitioner Circle name |
Control | 0..1 |
Type | Element(ST20) |
10. HDS-Sample-Model.dataProvider.practiceType | |
Definition | Practice Type |
Short | Practice Type |
Control | 0..1 |
Type | Element(ST20) |
12. HDS-Sample-Model.dataProvider.contactEmail | |
Definition | contact email |
Short | contact email |
Control | 0..1 |
Type | Element(ST20) |
14. HDS-Sample-Model.dataProvider.caregiverIdentifier | |
Definition | Identifier(s) of the provider |
Short | Identifier(s) of the provider |
Control | 0..1 |
Type | BackboneElement(Class) |
16. HDS-Sample-Model.dataProvider.caregiverIdentifier.nihdii | |
Definition | nihdii number |
Short | nihdii number |
Control | 0..1 |
Type | Element(ST20) |
18. HDS-Sample-Model.dataProvider.postalCode | |
Definition | Postal code |
Short | Postal code |
Control | 0..1 |
Type | Element(ST20) |
20. HDS-Sample-Model.dataProvider.street | |
Definition | Street name |
Short | Street name |
Control | 0..1 |
Type | Element(ST20) |
22. HDS-Sample-Model.dataProvider.houseNr | |
Definition | House number |
Short | House number |
Control | 0..1 |
Type | Element(ST20) |
24. HDS-Sample-Model.dataProvider.postbox | |
Definition | Post box |
Short | Post box |
Control | 0..1 |
Type | Element(ST20) |
Guidance on how to interpret the contents of this table can be found here
0. HDS-Sample-Model | |
Definition | HDS Sample Model |
Short | HDS-Sample-Model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HDS-Sample-Model.dateTimeReceived | |
Definition | Timestamp received |
Short | Timestamp received |
Control | 1..1 |
Type | Element(TS) |
4. HDS-Sample-Model.dataProvider | |
Definition | Data provider |
Short | Data provider |
Control | 0..1 |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. HDS-Sample-Model.dataProvider.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
8. HDS-Sample-Model.dataProvider.officeName | |
Definition | Office name |
Short | Office name |
Control | 0..1 |
Type | Element(ST20) |
10. HDS-Sample-Model.dataProvider.practitionerCircleName | |
Definition | Practitioner Circle name |
Short | Practitioner Circle name |
Control | 0..1 |
Type | Element(ST20) |
12. HDS-Sample-Model.dataProvider.practiceType | |
Definition | Practice Type |
Short | Practice Type |
Control | 0..1 |
Type | Element(ST20) |
14. HDS-Sample-Model.dataProvider.contactEmail | |
Definition | contact email |
Short | contact email |
Control | 0..1 |
Type | Element(ST20) |
16. HDS-Sample-Model.dataProvider.caregiverIdentifier | |
Definition | Identifier(s) of the provider |
Short | Identifier(s) of the provider |
Control | 0..1 |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
18. HDS-Sample-Model.dataProvider.caregiverIdentifier.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
20. HDS-Sample-Model.dataProvider.caregiverIdentifier.nihdii | |
Definition | nihdii number |
Short | nihdii number |
Control | 0..1 |
Type | Element(ST20) |
22. HDS-Sample-Model.dataProvider.postalCode | |
Definition | Postal code |
Short | Postal code |
Control | 0..1 |
Type | Element(ST20) |
24. HDS-Sample-Model.dataProvider.street | |
Definition | Street name |
Short | Street name |
Control | 0..1 |
Type | Element(ST20) |
26. HDS-Sample-Model.dataProvider.houseNr | |
Definition | House number |
Short | House number |
Control | 0..1 |
Type | Element(ST20) |
28. HDS-Sample-Model.dataProvider.postbox | |
Definition | Post box |
Short | Post box |
Control | 0..1 |
Type | Element(ST20) |
Guidance on how to interpret the contents of this table can be found here
0. HDS-Sample-Model | |
Definition | HDS Sample Model |
Short | HDS-Sample-Model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HDS-Sample-Model.dateTimeReceived | |
Definition | Timestamp received |
Short | Timestamp received |
Control | 1..1 |
Type | Element(TS) |
4. HDS-Sample-Model.dataProvider | |
Definition | Data provider |
Short | Data provider |
Control | 0..1 |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. HDS-Sample-Model.dataProvider.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
8. HDS-Sample-Model.dataProvider.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on HDS-Sample-Model.dataProvider.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
10. HDS-Sample-Model.dataProvider.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
12. HDS-Sample-Model.dataProvider.officeName | |
Definition | Office name |
Short | Office name |
Control | 0..1 |
Type | Element(ST20) |
14. HDS-Sample-Model.dataProvider.practitionerCircleName | |
Definition | Practitioner Circle name |
Short | Practitioner Circle name |
Control | 0..1 |
Type | Element(ST20) |
16. HDS-Sample-Model.dataProvider.practiceType | |
Definition | Practice Type |
Short | Practice Type |
Control | 0..1 |
Type | Element(ST20) |
18. HDS-Sample-Model.dataProvider.contactEmail | |
Definition | contact email |
Short | contact email |
Control | 0..1 |
Type | Element(ST20) |
20. HDS-Sample-Model.dataProvider.caregiverIdentifier | |
Definition | Identifier(s) of the provider |
Short | Identifier(s) of the provider |
Control | 0..1 |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. HDS-Sample-Model.dataProvider.caregiverIdentifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
24. HDS-Sample-Model.dataProvider.caregiverIdentifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on HDS-Sample-Model.dataProvider.caregiverIdentifier.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
26. HDS-Sample-Model.dataProvider.caregiverIdentifier.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
28. HDS-Sample-Model.dataProvider.caregiverIdentifier.nihdii | |
Definition | nihdii number |
Short | nihdii number |
Control | 0..1 |
Type | Element(ST20) |
30. HDS-Sample-Model.dataProvider.postalCode | |
Definition | Postal code |
Short | Postal code |
Control | 0..1 |
Type | Element(ST20) |
32. HDS-Sample-Model.dataProvider.street | |
Definition | Street name |
Short | Street name |
Control | 0..1 |
Type | Element(ST20) |
34. HDS-Sample-Model.dataProvider.houseNr | |
Definition | House number |
Short | House number |
Control | 0..1 |
Type | Element(ST20) |
36. HDS-Sample-Model.dataProvider.postbox | |
Definition | Post box |
Short | Post box |
Control | 0..1 |
Type | Element(ST20) |