HL7 BE Laboratory WG Implementation Guide
1.0.0 - STU
This page is part of the HL7 Belgium FHIR Implementation Guide - Lab related profiles (v1.0.0: Trial Use) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Draft as of 2020-09-07 | Maturity Level: 1 |
Definitions for the be-laboratory-report resource profile.
1. DiagnosticReport | |||||
Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. | ||||
Control | 0..* | ||||
Alternate Names | Report, Test, Result, Results, Labs, Laboratory | ||||
Comments | This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. | ||||
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) | ||||
2. DiagnosticReport.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. DiagnosticReport.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. DiagnosticReport.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. DiagnosticReport.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language.
| ||||
Type | code | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. DiagnosticReport.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. DiagnosticReport.text.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
8. DiagnosticReport.text.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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 DiagnosticReport.text.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. DiagnosticReport.text.status | |||||
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NarrativeStatus The status of a resource narrative. | ||||
Type | code | ||||
Pattern Value | empty | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
10. DiagnosticReport.text.div | |||||
Definition | The actual narrative content, a stripped down version of XHTML. | ||||
Control | 1..1 | ||||
Type | xhtml | ||||
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (: htmlChecks()) txt-2: The narrative SHALL have some non-whitespace content (: htmlChecks()) | ||||
11. DiagnosticReport.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
12. DiagnosticReport.extension | |||||
Definition | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Invariants | Defined on this element 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 DiagnosticReport.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
13. DiagnosticReport.extension:note | |||||
SliceName | note | ||||
Definition | BeExtNote | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(BeExtNote) (Extension Type: Annotation) | ||||
Must Support | true | ||||
Invariants | Defined on this element 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()) | ||||
14. DiagnosticReport.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
15. DiagnosticReport.identifier | |||||
Definition | An identifier for this laboratory report. This identifier will be used to determine if a new resource is needed, or if this resource is an update of an existing one. When an identifier is given, a consumer SHALL NOT ignore it. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..* | ||||
Type | Identifier | ||||
Must Support | true | ||||
Requirements | Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. | ||||
Alternate Names | ReportID, Filler ID, Placer ID | ||||
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
16. DiagnosticReport.identifier:DRID | |||||
SliceName | DRID | ||||
Definition | The identifier SHALL at least contain 1 identifier of type BeLabReportDiagnosticReportId. The unicity of this identifier is guaranteed by using the NIHDI number of the lab and a unique number for that lab, separated by a dot. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..1 | ||||
Type | Identifier | ||||
Requirements | Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. | ||||
Alternate Names | ReportID, Filler ID, Placer ID | ||||
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
17. DiagnosticReport.identifier:DRID.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
18. DiagnosticReport.identifier:DRID.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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 DiagnosticReport.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
19. DiagnosticReport.identifier:DRID.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. DiagnosticReport.identifier:DRID.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
21. DiagnosticReport.identifier:DRID.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Comments | Identifier.system is always case sensitive. | ||||
Fixed Value | https://www.ehealth.fgov.be/lab-report/diagnostic-report-id | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
22. DiagnosticReport.identifier:DRID.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Example | General:123456 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. DiagnosticReport.identifier:DRID.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
24. DiagnosticReport.identifier:DRID.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. DiagnosticReport.basedOn | |||||
Definition | Details concerning the prescription this laboratory report fullfills. A reference to a ServiceRequest SHALL be given here that includes the time of prescription in its .authoredOn element. It is RECOMMENDED to also use the .identifier element of the ServiceRequest to identify the original order number. Note, within the Observation resource it is possible to define they were defined on a different serviceRequest (e.g. to clarify it was a sub ordering) | ||||
Control | 1..1 | ||||
Type | Reference(ServiceRequest) | ||||
Must Support | true | ||||
Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. | ||||
Alternate Names | Request | ||||
Comments | Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. DiagnosticReport.status | |||||
Definition | The status of the diagnostic report. Consult the HL7 list of allowed values here. Note when a report should actually replace a previous one, use the Replaces extension. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from DiagnosticReportStatus The status of the diagnostic report. | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | true | ||||
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. DiagnosticReport.category | |||||
Definition | The subject of this specialty, expressed in a LOINC code. The choice of what observations to categorize under what specialty are left ultimately to the discretion of the laboratory sending the results. Some non-restrictive guidelines: *18721-1 (THERAPEUTIC DRUG MONITORING STUDIES) will be used for a section carrying pharmacologyobservations on a patient. *Mycology and parasitology, as well as bacteriology, are part of the 18725-2 (MICROBIOLOGY STUDIES) specialty. *665 Virology MAY be included in 18725-2 (MICROBIOLOGY STUDIES) specialty or 18727-8 (SEROLOGY STUDIES)or split between both specialties, depending upon the Content Creator Actor’s choice | ||||
Control | 1..* | ||||
Binding | For example codes, see DiagnosticServiceSectionCodes Codes for diagnostic service sections. | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Alternate Names | Department, Sub-department, Service, Discipline | ||||
Comments | Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. DiagnosticReport.category.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
29. DiagnosticReport.category.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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 DiagnosticReport.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
30. DiagnosticReport.category.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
31. DiagnosticReport.category.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
32. DiagnosticReport.category.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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 DiagnosticReport.category.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
33. DiagnosticReport.category.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. DiagnosticReport.category.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. DiagnosticReport.category.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. DiagnosticReport.category.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. DiagnosticReport.category.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. DiagnosticReport.category.coding:LABREPORT | |||||
SliceName | LABREPORT | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. DiagnosticReport.category.coding:LABREPORT.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
40. DiagnosticReport.category.coding:LABREPORT.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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 DiagnosticReport.category.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
41. DiagnosticReport.category.coding:LABREPORT.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0074 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. DiagnosticReport.category.coding:LABREPORT.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. DiagnosticReport.category.coding:LABREPORT.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | LAB | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. DiagnosticReport.category.coding:LABREPORT.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Fixed Value | Laboratory | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. DiagnosticReport.category.coding:LABREPORT.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. DiagnosticReport.category.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
47. DiagnosticReport.code | |||||
Definition | A code or name that describes this diagnostic report. | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from LOINCDiagnosticReportCodes Codes that describe Diagnostic Reports. | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Alternate Names | Type | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. DiagnosticReport.subject | |||||
Definition | The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. | ||||
Control | 1..1 | ||||
Type | Reference(BePatient | Group | Device | Location) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Requirements | SHALL know the subject context. | ||||
Alternate Names | Patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. DiagnosticReport.encounter | |||||
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. | ||||
Control | 0..1 | ||||
Type | Reference(Encounter) | ||||
Requirements | Links the request to the Encounter context. | ||||
Alternate Names | Context | ||||
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. DiagnosticReport.effective[x] | |||||
Definition | The time or time-period the observed values are related to. This is the time specimen collection(s) | ||||
Control | 0..1 | ||||
Type | Choice of: dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Requirements | Need to know where in the patient history to file/present this report. | ||||
Alternate Names | Observation time, Effective Time, Occurrence | ||||
Comments | If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. DiagnosticReport.issued | |||||
Definition | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. | ||||
Control | 1..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Requirements | Clinicians need to be able to check the date that the report was released. | ||||
Alternate Names | Date published, Date Issued, Date Verified | ||||
Comments | May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. DiagnosticReport.performer | |||||
Definition | The diagnostic service that is responsible for issuing the report. In the laboratory report, this is typically an organization (i.e. the laboratory) Note the Observation MAY have a different performer. | ||||
Control | 1..* | ||||
Type | Reference(BeOrganization | BePractitioner | CareTeam | BePractitionerRole) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. | ||||
Alternate Names | Laboratory, Service, Practitioner, Department, Company, Authorized by, Director | ||||
Comments | This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
53. DiagnosticReport.resultsInterpreter | |||||
Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. | ||||
Control | 1..* | ||||
Type | Reference(BePractitioner | BePractitionerRole | BeOrganization | CareTeam) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. | ||||
Alternate Names | Analyzed by, Reported by | ||||
Comments | Might not be the same entity that takes responsibility for the clinical report. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. DiagnosticReport.specimen | |||||
Definition | Details about the specimens on which this diagnostic report is based. | ||||
Control | 0..* | ||||
Type | Reference(BeSpecimenLaboratory) | ||||
Must Support | true | ||||
Requirements | Need to be able to report information about the collected specimens on which the report is based. | ||||
Comments | If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. DiagnosticReport.result | |||||
Definition | Observations that are part of this diagnostic report. | ||||
Control | 0..* | ||||
Type | Reference(BeObservationLaboratory) | ||||
Must Support | true | ||||
Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||||
Alternate Names | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||||
Comments | Observations can contain observations. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. DiagnosticReport.imagingStudy | |||||
Definition | One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. | ||||
Control | 0..* | ||||
Type | Reference(ImagingStudy) | ||||
Comments | ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. DiagnosticReport.media | |||||
Definition | A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Requirements | Many diagnostic services include images in the report as part of their service. | ||||
Alternate Names | DICOM, Slides, Scans | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
58. DiagnosticReport.media.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
59. DiagnosticReport.media.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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()) | ||||
60. DiagnosticReport.media.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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | 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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
61. DiagnosticReport.media.comment | |||||
Definition | A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | The provider of the report should make a comment about each image included in the report. | ||||
Comments | The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
62. DiagnosticReport.media.link | |||||
Definition | Reference to the image source. | ||||
Control | 1..1 | ||||
Type | Reference(Media) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. DiagnosticReport.conclusion | |||||
Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. | ||||
Control | 0..1 | ||||
Type | string | ||||
Must Support | true | ||||
Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. | ||||
Alternate Names | Report | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
64. DiagnosticReport.conclusionCode | |||||
Definition | One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. | ||||
Control | 0..* | ||||
Binding | For example codes, see SNOMEDCTClinicalFindings Diagnosis codes provided as adjuncts to the report. | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
65. DiagnosticReport.presentedForm | |||||
Definition | Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. | ||||
Control | 0..* | ||||
Type | Attachment | ||||
Must Support | true | ||||
Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. | ||||
Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |