StructureDefinition

Context of Use DiagnosticReport

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfoactive1.0.12025-02-11

An extension to support adding additional info supporting the diagnostic report.

This is a Pathology use case to support the backporting of R5 functionality to support adding additional supporting information that was used in the creation of the diagnostic report.


Tree View

id0..1string
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
valueCodeableConceptCodeableConcept
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
valueReferenceReference(Procedure | Observation | DiagnosticReport)
url1..1uriAuto Value

Detailed Descriptions

Extension
ShortAdditional information supporting the diagnostic report.
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.

Cardinality0..*
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Extension.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension
ShortAdditional content defined by implementations
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.

Cardinality1..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:type
ShortSupporting information role code.
Definition

The code value for the role of the supporting information in the diagnostic report.

Cardinality1..1
TypeExtension
Binding

http://terminology.hl7.org/ValueSet/v2-0936 (example)

Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:type.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:type.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
type
Mappings
  • rim: N/A
Extension.extension:type.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
TypeCodeableConcept
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:reference
ShortWho or what participated in the activities related to the family member history.
Definition

The reference for the supporting information in the diagnostic report.

Cardinality1..1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:reference.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:reference.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:reference.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
reference
Mappings
  • rim: N/A
Extension.extension:reference.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
TypeReference(Procedure | Observation | DiagnosticReport)
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
Mappings
  • rim: N/A
Extension.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..0
Typebase64Binary, 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
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A

Table View

Extension..
Extension.extension1..
Extension.extension:type1..1
Extension.extension:type.url..
Extension.extension:type.value[x]CodeableConcept1..
Extension.extension:reference1..1
Extension.extension:reference.url..
Extension.extension:reference.value[x]Reference(Procedure | Observation | DiagnosticReport)1..1
Extension.url..
Extension.value[x]..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-DiagnosticReportSupportingInfo" />
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" />
<version value="1.0.1" />
<name value="ExtensionUKCoreDiagnosticReportSupportingInfo" />
<title value="Extension UK Core Diagnostic Report Supporting Info" />
<status value="active" />
<date value="2025-02-11" />
<publisher value="HL7 UK" />
<name value="HL7 UK" />
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="An extension to support adding additional info supporting the diagnostic report." />
<purpose value="This is a Pathology use case to support the backporting of R5 functionality to support adding additional supporting information that was used in the creation of the diagnostic report." />
<copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." />
<fhirVersion value="4.0.1" />
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<type value="element" />
<expression value="DiagnosticReport" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<element id="Extension">
<path value="Extension" />
<short value="Additional information supporting the diagnostic report." />
<definition value="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." />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
<min value="1" />
</element>
<element id="Extension.extension:type">
<path value="Extension.extension" />
<sliceName value="type" />
<short value="Supporting information role code." />
<definition value="The code value for the role of the supporting information in the diagnostic report." />
<min value="1" />
<max value="1" />
<strength value="example" />
<valueSet value="http://terminology.hl7.org/ValueSet/v2-0936" />
</binding>
</element>
<element id="Extension.extension:type.url">
<path value="Extension.extension.url" />
<fixedUri value="type" />
</element>
<element id="Extension.extension:type.value[x]">
<path value="Extension.extension.value[x]" />
<min value="1" />
<code value="CodeableConcept" />
</type>
</element>
<element id="Extension.extension:reference">
<path value="Extension.extension" />
<sliceName value="reference" />
<short value="Who or what participated in the activities related to the family member history." />
<definition value="The reference for the supporting information in the diagnostic report." />
<min value="1" />
<max value="1" />
</element>
<element id="Extension.extension:reference.url">
<path value="Extension.extension.url" />
<fixedUri value="reference" />
</element>
<element id="Extension.extension:reference.value[x]">
<path value="Extension.extension.value[x]" />
<min value="1" />
<max value="1" />
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Procedure" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport" />
</type>
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<max value="0" />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-DiagnosticReportSupportingInfo",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo",
"version": "1.0.1",
"name": "ExtensionUKCoreDiagnosticReportSupportingInfo",
"title": "Extension UK Core Diagnostic Report Supporting Info",
"status": "active",
"date": "2025-02-11",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "An extension to support adding additional info supporting the diagnostic report.",
"purpose": "This is a Pathology use case to support the backporting of R5 functionality to support adding additional supporting information that was used in the creation of the diagnostic report.",
"copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "DiagnosticReport"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Additional information supporting the diagnostic report.",
"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."
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"min": 1
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "Supporting information role code.",
"definition": "The code value for the role of the supporting information in the diagnostic report.",
"min": 1,
"max": "1",
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0936"
}
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"fixedUri": "type"
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Extension.extension:reference",
"path": "Extension.extension",
"sliceName": "reference",
"short": "Who or what participated in the activities related to the family member history.",
"definition": "The reference for the supporting information in the diagnostic report.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension:reference.url",
"path": "Extension.extension.url",
"fixedUri": "reference"
},
{
"id": "Extension.extension:reference.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
]
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"max": "0"
}
]
}
}

Examples

Feedback

Click here to:

Examples

TBC

Extension Specific Guidance

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles: