Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
Draft as of 2024-11-06 |
Definitions for the DiagnosticReport resource profile.
Guidance on how to interpret the contents of this table can be found here
0. DiagnosticReport | |||||||
2. DiagnosticReport.identifier | |||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Slicing | This element introduces a set of slices on DiagnosticReport.identifier . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
4. DiagnosticReport.identifier:CommonResourceIdentifiers | |||||||
Slice Name | CommonResourceIdentifiers | ||||||
Short | Common Resource Identifiers | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* | ||||||
Type | Identifier(Common Resource Identifiers) | ||||||
6. DiagnosticReport.code | |||||||
Obligations |
| ||||||
Standard Status | Normative (from Trial Use) | ||||||
8. DiagnosticReport.subject | |||||||
10. DiagnosticReport.subject.reference | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
12. DiagnosticReport.subject.identifier | |||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Type | Identifier(NHS, HCSN and CHI Numbers) | ||||||
14. DiagnosticReport.effective[x] | |||||||
Control | 1..? | ||||||
Type | dateTime, Period | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Standard Status | Normative (from Trial Use) | ||||||
16. DiagnosticReport.performer | |||||||
Type | Reference(Practitioner) | ||||||
Must Support | true | ||||||
18. DiagnosticReport.performer.reference | |||||||
Control | 1..? |
Guidance on how to interpret the contents of this table can be found here
0. 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. | ||||||
Short | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | ||||||
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. | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Alternate Names | Report, Test, Result, Results, Labs, Laboratory | ||||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management (text.`div`.exists()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) | ||||||
2. 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. | ||||||
Short | A set of rules under which this content was created | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
4. DiagnosticReport.extension:compositionReferenceR5 | |||||||
Slice Name | compositionReferenceR5 | ||||||
Definition | A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. | ||||||
Short | A Composition reference for a DiagnosticReport. This is a R5 backport. | ||||||
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..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core Diagnostic Report Composition) (Extension Type: Reference(Composition)) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
6. DiagnosticReport.extension:compositionReferenceR5.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | ||||||
8. DiagnosticReport.extension:compositionReferenceR5.value[x] | |||||||
Definition | Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Reference to a Composition resource.Value of extension | ||||||
Control | 10..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Composition), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
10. DiagnosticReport.extension:noteR5 | |||||||
Slice Name | noteR5 | ||||||
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. | ||||||
Short | Comments about the diagnostic report. This is a R5 backport. | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core Diagnostic Report Note) (Extension Type: Annotation) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
12. DiagnosticReport.extension:noteR5.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | ||||||
14. DiagnosticReport.extension:noteR5.value[x] | |||||||
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Comments about the diagnostic report.Value of extension | ||||||
Control | 10..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Annotation, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
16. DiagnosticReport.extension:supportingInfoR5 | |||||||
Slice Name | supportingInfoR5 | ||||||
Definition | This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. | ||||||
Short | Additional info supporting the diagnostic report. This is a R5 backport. | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core Diagnostic Report Supporting Info) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
18. DiagnosticReport.extension:supportingInfoR5.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 | 20..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() )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.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
20. DiagnosticReport.extension:supportingInfoR5.extension:type | |||||||
Slice Name | type | ||||||
Definition | The code value for the role of the supporting information in the diagnostic report. | ||||||
Short | Supporting information role code.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 | 10..1* This element is affected by the following invariants: ele-1 | ||||||
Binding | For example codes, see For codes, see hl7VS-VS-observationType (example to http://terminology.hl7.org/ValueSet/v2-0936 ) | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
22. DiagnosticReport.extension:supportingInfoR5.extension:type.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | type | ||||||
24. DiagnosticReport.extension:supportingInfoR5.extension:type.value[x] | |||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 10..1 This element is affected by the following invariants: ele-1 | ||||||
Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
26. DiagnosticReport.extension:supportingInfoR5.extension:reference | |||||||
Slice Name | reference | ||||||
Definition | The reference for the supporting information in the diagnostic report. | ||||||
Short | Who or what participated in the activities related to the family member history.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 | 10..1* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
28. DiagnosticReport.extension:supportingInfoR5.extension:reference.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | reference | ||||||
30. DiagnosticReport.extension:supportingInfoR5.extension:reference.value[x] | |||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 10..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Procedure, Observation, DiagnosticReport, http://hl7.org/fhir/StructureDefinition/Citation ), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
32. DiagnosticReport.extension:supportingInfoR5.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | ||||||
34. DiagnosticReport.extension:supportingInfoR5.value[x] | |||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..01 This element is affected by the following invariants: ele-1 | ||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
36. 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). | ||||||
Short | Extensions that cannot be ignored | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 | ||||||
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() )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.modifierExtension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
38. DiagnosticReport.identifier | |||||||
Definition | Identifiers assigned to this report by the performer or other systems. | ||||||
Short | Business identifier for report | ||||||
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 10..* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | 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 | ||||||
Invariants | 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 areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
40. DiagnosticReport.identifier:CommonResourceIdentifiers | |||||||
Slice Name | CommonResourceIdentifiers | ||||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Identifiers assigned to this report by the performer or other systems. | ||||||
Short | Common Resource IdentifiersBusiness identifier for report | ||||||
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(Common Resource Identifiers) | ||||||
Is Modifier | false | ||||||
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 | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
42. DiagnosticReport.status | |||||||
Definition | The status of the diagnostic report. | ||||||
Short | registered | partial | preliminary | final + | ||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | The codes SHALL be taken from DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 )The status of the diagnostic report. | ||||||
Type | code | ||||||
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
44. DiagnosticReport.category | |||||||
Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. | ||||||
Short | Service category | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Binding | For example codes, see DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections )Codes for diagnostic service sections. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Department, Sub-department, Service, Discipline | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
46. DiagnosticReport.code | |||||||
Definition | A code or name that describes this diagnostic report. | ||||||
Short | Name/Code for this diagnostic report | ||||||
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. | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | The codes SHOULD be taken from UK Core Report Codehttp://hl7.org/fhir/ValueSet/report-codes (preferred to https://fhir.hl7.org.uk/ValueSet/UKCore-ReportCode )Codes that describe Diagnostic Reports. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | Type | ||||||
Invariants | 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. | ||||||
Short | The subject of the report - usually, but not always, the patient | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Patient, Group, Device, Location) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | true | ||||||
Requirements | SHALL know the subject context. | ||||||
Alternate Names | Patient | ||||||
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')) ) | ||||||
50. DiagnosticReport.subject.reference | |||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
Short | Literal reference, Relative, internal or absolute URL | ||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
Control | 10..1 This element is affected by the following invariants: ref-1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
52. DiagnosticReport.subject.identifier | |||||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||
Short | An identifier intended for computationLogical reference, when literal reference is not known | ||||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(NHS, HCSN and CHI Numbers) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
54. DiagnosticReport.encounter | |||||||
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. | ||||||
Short | Health care event when test ordered | ||||||
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). | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Encounter) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Links the request to the Encounter context. | ||||||
Alternate Names | Context | ||||||
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')) ) | ||||||
56. DiagnosticReport.effective[x] | |||||||
Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. | ||||||
Short | Clinically relevant time/time-period for report | ||||||
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. | ||||||
Control | 10..1 This element is affected by the following invariants: ele-1 | ||||||
Type | dateTime, Period | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Need to know where in the patient history to file/present this report. | ||||||
Alternate Names | Observation time, Effective Time, Occurrence | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
58. 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. | ||||||
Short | DateTime this version was made | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | instant | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Clinicians need to be able to check the date that the report was released. | ||||||
Alternate Names | Date published, Date Issued, Date Verified | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
60. DiagnosticReport.performer | |||||||
Definition | The diagnostic service that is responsible for issuing the report. | ||||||
Short | Responsible Diagnostic Service | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Practitioner, Practitioner, PractitionerRole, Organization, CareTeam) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 | ||||||
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')) ) | ||||||
62. DiagnosticReport.performer.extension:deviceReference | |||||||
Slice Name | deviceReference | ||||||
Definition | An additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport | ||||||
Short | An additional Device reference for a DiagnosticReport. | ||||||
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..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core DeviceReference) (Extension Type: Reference(Device)) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
64. DiagnosticReport.performer.reference | |||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
Short | Literal reference, Relative, internal or absolute URL | ||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
Control | 10..1 This element is affected by the following invariants: ele-1, ref-1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
66. DiagnosticReport.result | |||||||
Definition | Observations that are part of this diagnostic report. | ||||||
Short | Observations | ||||||
Comments | Observations can contain observations. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Observation) | ||||||
Is Modifier | false | ||||||
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 | ||||||
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')) ) |
Guidance on how to interpret the contents of this table can be found here
0. 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. | ||||||
Short | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | ||||||
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. | ||||||
Control | 0..* | ||||||
Alternate Names | Report, Test, Result, Results, Labs, Laboratory | ||||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management ( text.`div`.exists() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() ) | ||||||
2. DiagnosticReport.id | |||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||
Short | Logical id of this artifact | ||||||
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. | ||||||
Control | 0..1 | ||||||
Type | id | ||||||
Summary | true | ||||||
4. 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. | ||||||
Short | Metadata about the resource | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Meta | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
6. 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. | ||||||
Short | A set of rules under which this content was created | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
8. DiagnosticReport.language | |||||||
Definition | The base language in which the resource is written. | ||||||
Short | Language of the resource content | ||||||
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). | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Type | code | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
10. 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. | ||||||
Short | Text summary of the resource, for human interpretation | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Narrative | ||||||
Alternate Names | narrative, html, xhtml, display | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
12. 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. | ||||||
Short | Contained, inline 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. | ||||||
Control | 0..* | ||||||
Type | Resource | ||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||
14. DiagnosticReport.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
16. DiagnosticReport.extension:compositionReferenceR5 | |||||||
Slice Name | compositionReferenceR5 | ||||||
Definition | A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. | ||||||
Short | A Composition reference for a DiagnosticReport. This is a R5 backport. | ||||||
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..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core Diagnostic Report Composition) (Extension Type: Reference(Composition)) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
18. DiagnosticReport.extension:compositionReferenceR5.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 | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
20. DiagnosticReport.extension:compositionReferenceR5.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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
22. DiagnosticReport.extension:compositionReferenceR5.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | ||||||
24. DiagnosticReport.extension:compositionReferenceR5.value[x] | |||||||
Definition | Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. | ||||||
Short | Reference to a Composition resource. | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Composition) | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
26. DiagnosticReport.extension:noteR5 | |||||||
Slice Name | noteR5 | ||||||
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. | ||||||
Short | Comments about the diagnostic report. This is a R5 backport. | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core Diagnostic Report Note) (Extension Type: Annotation) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
28. DiagnosticReport.extension:noteR5.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 | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
30. DiagnosticReport.extension:noteR5.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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
32. DiagnosticReport.extension:noteR5.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | ||||||
34. DiagnosticReport.extension:noteR5.value[x] | |||||||
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. | ||||||
Short | Comments about the diagnostic report. | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Annotation | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
36. DiagnosticReport.extension:supportingInfoR5 | |||||||
Slice Name | supportingInfoR5 | ||||||
Definition | This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. | ||||||
Short | Additional info supporting the diagnostic report. This is a R5 backport. | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core Diagnostic Report Supporting Info) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
38. DiagnosticReport.extension:supportingInfoR5.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 | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
40. DiagnosticReport.extension:supportingInfoR5.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 | 2..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
42. DiagnosticReport.extension:supportingInfoR5.extension:type | |||||||
Slice Name | type | ||||||
Definition | The code value for the role of the supporting information in the diagnostic report. | ||||||
Short | Supporting information role code. | ||||||
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 | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | For example codes, see hl7VS-VS-observationType (example to http://terminology.hl7.org/ValueSet/v2-0936 ) | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
44. DiagnosticReport.extension:supportingInfoR5.extension:type.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 | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
46. DiagnosticReport.extension:supportingInfoR5.extension:type.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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
48. DiagnosticReport.extension:supportingInfoR5.extension:type.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | type | ||||||
50. DiagnosticReport.extension:supportingInfoR5.extension:type.value[x] | |||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
52. DiagnosticReport.extension:supportingInfoR5.extension:reference | |||||||
Slice Name | reference | ||||||
Definition | The reference for the supporting information in the diagnostic report. | ||||||
Short | Who or what participated in the activities related to the family member history. | ||||||
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 | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
54. DiagnosticReport.extension:supportingInfoR5.extension:reference.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 | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
56. DiagnosticReport.extension:supportingInfoR5.extension:reference.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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
58. DiagnosticReport.extension:supportingInfoR5.extension:reference.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | reference | ||||||
60. DiagnosticReport.extension:supportingInfoR5.extension:reference.value[x] | |||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Procedure, Observation, DiagnosticReport, http://hl7.org/fhir/StructureDefinition/Citation ) | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
62. DiagnosticReport.extension:supportingInfoR5.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies the meaning of the extension | ||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | ||||||
64. DiagnosticReport.extension:supportingInfoR5.value[x] | |||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
66. 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). | ||||||
Short | Extensions that cannot be ignored | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 | ||||||
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 DiagnosticReport.modifierExtension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
68. DiagnosticReport.identifier | |||||||
Definition | Identifiers assigned to this report by the performer or other systems. | ||||||
Short | Business identifier for report | ||||||
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier | ||||||
Must Support | true | ||||||
Summary | 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 | ||||||
Invariants | 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 areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
70. DiagnosticReport.identifier:CommonResourceIdentifiers | |||||||
Slice Name | CommonResourceIdentifiers | ||||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||||
Short | Common Resource Identifiers | ||||||
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(Common Resource Identifiers) | ||||||
Is Modifier | false | ||||||
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 | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
72. DiagnosticReport.basedOn | |||||||
Definition | Details concerning a service requested. | ||||||
Short | What was requested | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest) | ||||||
Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. | ||||||
Alternate Names | Request | ||||||
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')) ) | ||||||
74. DiagnosticReport.status | |||||||
Definition | The status of the diagnostic report. | ||||||
Short | registered | partial | preliminary | final + | ||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | The codes SHALL be taken from DiagnosticReportStatus (required to http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 )The status of the diagnostic report. | ||||||
Type | code | ||||||
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
76. DiagnosticReport.category | |||||||
Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. | ||||||
Short | Service category | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Binding | For example codes, see DiagnosticServiceSectionCodes (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections )Codes for diagnostic service sections. | ||||||
Type | CodeableConcept | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Department, Sub-department, Service, Discipline | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
78. DiagnosticReport.code | |||||||
Definition | A code or name that describes this diagnostic report. | ||||||
Short | Name/Code for this diagnostic report | ||||||
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. | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | The codes SHOULD be taken from UK Core Report Code (preferred to https://fhir.hl7.org.uk/ValueSet/UKCore-ReportCode )Codes that describe Diagnostic Reports. | ||||||
Type | CodeableConcept | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | Type | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
80. 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. | ||||||
Short | The subject of the report - usually, but not always, the patient | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Patient, Group, Device, Location) | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | true | ||||||
Requirements | SHALL know the subject context. | ||||||
Alternate Names | Patient | ||||||
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')) ) | ||||||
82. DiagnosticReport.subject.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 | ||||||
84. DiagnosticReport.subject.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 DiagnosticReport.subject.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
86. DiagnosticReport.subject.reference | |||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
Short | Literal reference, Relative, internal or absolute URL | ||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
88. DiagnosticReport.subject.type | |||||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||
Short | Type the reference refers to (e.g. "Patient") | ||||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||
Control | 0..1 | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
90. DiagnosticReport.subject.identifier | |||||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||||
Short | An identifier intended for computation | ||||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(NHS, HCSN and CHI Numbers) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
92. DiagnosticReport.subject.display | |||||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||||
Short | Text alternative for the resource | ||||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
94. DiagnosticReport.encounter | |||||||
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. | ||||||
Short | Health care event when test ordered | ||||||
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). | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Encounter) | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Links the request to the Encounter context. | ||||||
Alternate Names | Context | ||||||
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')) ) | ||||||
96. DiagnosticReport.effective[x] | |||||||
Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. | ||||||
Short | Clinically relevant time/time-period for report | ||||||
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. | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Type | dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | Need to know where in the patient history to file/present this report. | ||||||
Alternate Names | Observation time, Effective Time, Occurrence | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
98. 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. | ||||||
Short | DateTime this version was made | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | instant | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Clinicians need to be able to check the date that the report was released. | ||||||
Alternate Names | Date published, Date Issued, Date Verified | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
100. DiagnosticReport.performer | |||||||
Definition | The diagnostic service that is responsible for issuing the report. | ||||||
Short | Responsible Diagnostic Service | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Practitioner) | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 | ||||||
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')) ) | ||||||
102. DiagnosticReport.performer.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 | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
104. DiagnosticReport.performer.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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.performer.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
106. DiagnosticReport.performer.extension:deviceReference | |||||||
Slice Name | deviceReference | ||||||
Definition | An additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport | ||||||
Short | An additional Device reference for a DiagnosticReport. | ||||||
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..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core DeviceReference) (Extension Type: Reference(Device)) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
108. DiagnosticReport.performer.reference | |||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
Short | Literal reference, Relative, internal or absolute URL | ||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1, ref-1 | ||||||
Type | string | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
110. DiagnosticReport.performer.type | |||||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||
Short | Type the reference refers to (e.g. "Patient") | ||||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||||
Type | uri | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
112. DiagnosticReport.performer.identifier | |||||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||
Short | Logical reference, when literal reference is not known | ||||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
114. DiagnosticReport.performer.display | |||||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||||
Short | Text alternative for the resource | ||||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | string | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
116. DiagnosticReport.resultsInterpreter | |||||||
Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. | ||||||
Short | Primary result interpreter | ||||||
Comments | Might not be the same entity that takes responsibility for the clinical report. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam) | ||||||
Summary | true | ||||||
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 | ||||||
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')) ) | ||||||
118. DiagnosticReport.resultsInterpreter.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 | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
120. DiagnosticReport.resultsInterpreter.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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.resultsInterpreter.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
122. DiagnosticReport.resultsInterpreter.extension:deviceReference | |||||||
Slice Name | deviceReference | ||||||
Definition | An additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport | ||||||
Short | An additional Device reference for a DiagnosticReport. | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Extension UK Core DeviceReference) (Extension Type: Reference(Device)) | ||||||
Is Modifier | false | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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() ) | ||||||
124. DiagnosticReport.resultsInterpreter.reference | |||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
Short | Literal reference, Relative, internal or absolute URL | ||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1, ref-1 | ||||||
Type | string | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
126. DiagnosticReport.resultsInterpreter.type | |||||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||
Short | Type the reference refers to (e.g. "Patient") | ||||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||||
Type | uri | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
128. DiagnosticReport.resultsInterpreter.identifier | |||||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||
Short | Logical reference, when literal reference is not known | ||||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
130. DiagnosticReport.resultsInterpreter.display | |||||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||||
Short | Text alternative for the resource | ||||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | string | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
132. DiagnosticReport.specimen | |||||||
Definition | Details about the specimens on which this diagnostic report is based. | ||||||
Short | Specimens this report is based on | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Specimen) | ||||||
Requirements | Need to be able to report information about the collected specimens on which the report is based. | ||||||
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')) ) | ||||||
134. DiagnosticReport.result | |||||||
Definition | Observations that are part of this diagnostic report. | ||||||
Short | Observations | ||||||
Comments | Observations can contain observations. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Observation) | ||||||
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 | ||||||
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')) ) | ||||||
136. 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. | ||||||
Short | Reference to full details of imaging associated with the diagnostic report | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(ImagingStudy) | ||||||
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')) ) | ||||||
138. 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). | ||||||
Short | Key images associated with this report | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | BackboneElement | ||||||
Summary | true | ||||||
Requirements | Many diagnostic services include images in the report as part of their service. | ||||||
Alternate Names | DICOM, Slides, Scans | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
140. 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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
142. 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. | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension | ||||||
Standard Status | Normative (from Trial Use) | ||||||
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 DiagnosticReport.media.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
144. 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). | ||||||
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..* This element is affected by the following invariants: ele-1 | ||||||
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() ) | ||||||
146. 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. | ||||||
Short | Comment about the image (e.g. explanation) | ||||||
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. | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | string | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Requirements | The provider of the report should make a comment about each image included in the report. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
148. DiagnosticReport.media.link | |||||||
Definition | Reference to the image source. | ||||||
Short | Reference to the image source | ||||||
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. | ||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Reference(Media) | ||||||
Summary | true | ||||||
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')) ) | ||||||
150. DiagnosticReport.conclusion | |||||||
Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. | ||||||
Short | Clinical conclusion (interpretation) of test results | ||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | string | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. | ||||||
Alternate Names | Report | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
152. DiagnosticReport.conclusionCode | |||||||
Definition | One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. | ||||||
Short | Codes for the clinical conclusion of test results | ||||||
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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Binding | The codes SHOULD be taken from SNOMEDCTClinicalFindings (preferred to http://hl7.org/fhir/ValueSet/clinical-findings )Diagnosis codes provided as adjuncts to the report. | ||||||
Type | CodeableConcept | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
154. 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. | ||||||
Short | Entire report as issued | ||||||
Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Attachment | ||||||
Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )att-1: If the Attachment has data, it SHALL have a contentType ( data.empty() or contentType.exists() ) |