eHealth Platform Federal Core Profiles
2.1.2 - STU1
eHealth Platform Federal Core Profiles
2.1.2 - STU1
eHealth Platform Federal Core Profiles, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/core/ and changes regularly. See the Directory of published versions
| Draft as of 2024-10-02 |
Definitions for the BeModelPatientDocument logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. BeModelPatientDocument | |
| Definition | Data about a patient related document |
| Short | BeModelPatientDocument |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. BeModelPatientDocument.patient | |
| Definition | The subject of the document |
| Short | The subject of the document |
| Control | 1..1 |
| Type | Identifier |
| 4. BeModelPatientDocument.author | |
| Definition | The author of the document, either Practitioner or Organization |
| Short | The author of the document, either Practitioner or Organization |
| Control | 1..1 |
| Type | Identifier |
| 6. BeModelPatientDocument.category | |
| Definition | A number of classifiers for the document, each code refines the previous one |
| Short | A number of classifiers for the document, each code refines the previous one |
| Control | 0..* |
| Type | CodeableConcept |
| 8. BeModelPatientDocument.document | |
| Definition | Document information |
| Short | Document information |
| Control | 1..1 |
| Type | BackboneElement |
| 10. BeModelPatientDocument.document.content | |
| Definition | The content of the document as such |
| Short | The content of the document as such |
| Control | 0..1 |
| Type | Binary |
| 12. BeModelPatientDocument.document.mimetype | |
| Definition | The technical type of the document |
| Short | The technical type of the document |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. BeModelPatientDocument.document.url | |
| Definition | If the document is not in the content, the reference to the document |
| Short | If the document is not in the content, the reference to the document |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. BeModelPatientDocument.context | |
| Definition | Any related resources or elements that provide context for the document, such as institution, encounter,... |
| Short | Any related resources or elements that provide context for the document, such as institution, encounter,... |
| Control | 0..* |
| Type | Element |
Guidance on how to interpret the contents of this table can be found here
| 0. BeModelPatientDocument | |
| Definition | Data about a patient related document |
| Short | BeModelPatientDocument |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. BeModelPatientDocument.patient | |
| Definition | The subject of the document |
| Short | The subject of the document |
| Control | 1..1 |
| Type | Identifier |
| 4. BeModelPatientDocument.author | |
| Definition | The author of the document, either Practitioner or Organization |
| Short | The author of the document, either Practitioner or Organization |
| Control | 1..1 |
| Type | Identifier |
| 6. BeModelPatientDocument.category | |
| Definition | A number of classifiers for the document, each code refines the previous one |
| Short | A number of classifiers for the document, each code refines the previous one |
| Control | 0..* |
| Type | CodeableConcept |
| 8. BeModelPatientDocument.document | |
| Definition | Document information |
| Short | Document information |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. BeModelPatientDocument.document.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. BeModelPatientDocument.document.content | |
| Definition | The content of the document as such |
| Short | The content of the document as such |
| Control | 0..1 |
| Type | Binary |
| 14. BeModelPatientDocument.document.mimetype | |
| Definition | The technical type of the document |
| Short | The technical type of the document |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. BeModelPatientDocument.document.url | |
| Definition | If the document is not in the content, the reference to the document |
| Short | If the document is not in the content, the reference to the document |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. BeModelPatientDocument.context | |
| Definition | Any related resources or elements that provide context for the document, such as institution, encounter,... |
| Short | Any related resources or elements that provide context for the document, such as institution, encounter,... |
| Control | 0..* |
| Type | Element |
Guidance on how to interpret the contents of this table can be found here
| 0. BeModelPatientDocument | |
| Definition | Data about a patient related document |
| Short | BeModelPatientDocument |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. BeModelPatientDocument.patient | |
| Definition | The subject of the document |
| Short | The subject of the document |
| Control | 1..1 |
| Type | Identifier |
| 4. BeModelPatientDocument.author | |
| Definition | The author of the document, either Practitioner or Organization |
| Short | The author of the document, either Practitioner or Organization |
| Control | 1..1 |
| Type | Identifier |
| 6. BeModelPatientDocument.category | |
| Definition | A number of classifiers for the document, each code refines the previous one |
| Short | A number of classifiers for the document, each code refines the previous one |
| Control | 0..* |
| Type | CodeableConcept |
| 8. BeModelPatientDocument.document | |
| Definition | Document information |
| Short | Document information |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. BeModelPatientDocument.document.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 |
| 12. BeModelPatientDocument.document.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 BeModelPatientDocument.document.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. BeModelPatientDocument.document.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()) |
| 16. BeModelPatientDocument.document.content | |
| Definition | The content of the document as such |
| Short | The content of the document as such |
| Control | 0..1 |
| Type | Binary |
| 18. BeModelPatientDocument.document.mimetype | |
| Definition | The technical type of the document |
| Short | The technical type of the document |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. BeModelPatientDocument.document.url | |
| Definition | If the document is not in the content, the reference to the document |
| Short | If the document is not in the content, the reference to the document |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. BeModelPatientDocument.context | |
| Definition | Any related resources or elements that provide context for the document, such as institution, encounter,... |
| Short | Any related resources or elements that provide context for the document, such as institution, encounter,... |
| Control | 0..* |
| Type | Element |
IG © 2021+ eHealth Platform. Package hl7.fhir.be.core#2.1.2 based on FHIR 4.0.1. Generated 2024-10-02
Links: Table of Contents |
QA Report |
Version History |
