Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-TextResult

WARNING This page contains a draft CBB, as raw output from the zib export and automatic conversion to CBB. It requires thorough review and adaption to the Belgian realm. This CBB is merely added for informative use.

CBB	Description	Status
HdBe-TextResult	Textual results describe the findings and interpretation of diagnostic or therapeutic procedures carried out on patients or on specimens from the patient. Purpose Recording the results of diagnostic procedures for the purpose of communicating these with the person requesting the procedure and documenting the findings resulting from therapeutic procedures. Evidence Base Most results of procedures and some laboratory test results are descriptive by nature. This includes reports from radiology, pathology, scopies, ultrasounds, etc. and laboratory tests such as cultures, in which results, interpretation and advice form integral parts of the result. This information model can be used for these (mainly unstructured) results. For laboratory test results, it is difficult to clearly indicate exactly when to use this information model and when to use the LaboratoryTestResult information model. In general, laboratory tests resulting in a value (7.1 mmol/L), ordinal number (++ from series to ++++) or a quantitative result (Low) can best be transferred using the LaboratoryTestResult, whereas this information model is better suited for textual results containing more than just a few words. Both types of tests occur in almost all laboratories. Applicability is not determined by the kind of lab but by the kind of result.	draft

CBB

Description

Status

HdBe-TextResult

Textual results describe the findings and interpretation of diagnostic or therapeutic procedures carried out on patients or on specimens from the patient.

Purpose

Recording the results of diagnostic procedures for the purpose of communicating these with the person requesting the procedure and documenting the findings resulting from therapeutic procedures.

Evidence Base

Most results of procedures and some laboratory test results are descriptive by nature. This includes reports from radiology, pathology, scopies, ultrasounds, etc. and laboratory tests such as cultures, in which results, interpretation and advice form integral parts of the result. This information model can be used for these (mainly unstructured) results.

For laboratory test results, it is difficult to clearly indicate exactly when to use this information model and when to use the LaboratoryTestResult information model. In general, laboratory tests resulting in a value (7.1 mmol/L), ordinal number (++ from series to ++++) or a quantitative result (Low) can best be transferred using the LaboratoryTestResult, whereas this information model is better suited for textual results containing more than just a few words. Both types of tests occur in almost all laboratories. Applicability is not determined by the kind of lab but by the kind of result.

draft

TextResult			TextResult	Element id TextResult Short description TextResult Definition Root concept of the TextResult information model. This root concept contains all data elements of the TextResult information model. Data type TextResult Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id TextResult.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id TextResult.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
TextResultDateTime		0..1	dateTime	Element id TextResult.TextResultDateTime Short description TextResultDateTime Definition Date and if possible time of the result report. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
Procedure	I	0..1	Reference(HdBe-Procedure)	Element id TextResult.Procedure Short description Procedure Definition Reference to the Procedure information model including the date of the procedure, requesting and executive specialty. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(HdBe-Procedure) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
TextResultStatus		0..1	CodeableConceptBinding	Element id TextResult.TextResultStatus Short description TextResultStatus Definition The status of the result. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding TextResultStatus codes TextResultStatus (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
TextResultReport		1..1	string	Element id TextResult.TextResultReport Short description TextResultReport Definition The text report detailing the actual results of the test or procedure. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
VisualResult		0..*	base64Binary	Element id TextResult.VisualResult Short description VisualResult Definition Visual examination results that are the starting point and reason for the textual report. These results include visual material - e.g. radiological images, scopy images, medical photos and videos - as well as graphic recordings - e.g. ECGs, EEGs etc. Comments A stream of bytes, base64 encoded Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
TextResultType		1..1	CodeableConceptBinding	Element id TextResult.TextResultType Short description TextResultType Definition The type of result. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding TextResultType codes TextResultType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

TextResult		0..*
TextResult.TextResultDateTime	dateTime	0..1
TextResult.Procedure	Reference(HdBe-Procedure)	0..1
TextResult.TextResultStatus	CodeableConcept	0..1
TextResult.TextResultReport	string	1..1
TextResult.VisualResult	base64Binary	0..*
TextResult.TextResultType	CodeableConcept	1..1

TextResult
Definition	Root concept of the TextResult information model. This root concept contains all data elements of the TextResult information model.
Cardinality	0...*
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
TextResult.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
TextResult.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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
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()`
Mappings	rim: n/a rim: N/A
TextResult.TextResultDateTime
Definition	Date and if possible time of the result report.
Cardinality	0...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
TextResult.Procedure
Definition	Reference to the Procedure information model including the date of the procedure, requesting and executive specialty.
Cardinality	0...1
Type	Reference(HdBe-Procedure)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
TextResult.TextResultStatus
Definition	The status of the result.
Cardinality	0...1
Type	CodeableConcept
Binding	TextResultStatus codes TextResultStatus (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
TextResult.TextResultReport
Definition	The text report detailing the actual results of the test or procedure.
Cardinality	1...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
TextResult.VisualResult
Definition	Visual examination results that are the starting point and reason for the textual report. These results include visual material - e.g. radiological images, scopy images, medical photos and videos - as well as graphic recordings - e.g. ECGs, EEGs etc.
Cardinality	0...*
Type	base64Binary
Comments	A stream of bytes, base64 encoded
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
TextResult.TextResultType
Definition	The type of result.
Cardinality	1...1
Type	CodeableConcept
Binding	TextResultType codes TextResultType (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

Example instances

[CBB name]
[Concept name ]	[example value]

// example of NameInformation

## Example instances

| NameInformation      |                   |
|----------------------|-------------------|
| FirstNames | Johanna Petronella Maria   
| Initials | J.P.M. 
| GivenName | Jo 
| NameUsage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| LastName.Prefix | van
| LastName.LastName | Putten
| LastNamePartner.PartnerPrefix | van der
| LastNamePartner.PartnerLastName | Giessen
| Titles |

zib [zib name + version](https://zibs.nl/wiki/[zib name + version(release)]) difference

Concept	Category	Description
`[element.path]`	[category of change]	[Description of change]([Reference to ticket/issue/zulip chat using MarkDown link])

Terminology Bindings

Path	Name	Strength	URL
TextResultStatus	TextResultStatus	extensible	https://fhir.healthdata.be/ValueSet/TextResultStatus
TextResultType	TextResultType	extensible	https://fhir.healthdata.be/ValueSet/TextResultType