- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
StructureDefinition Extension-UKCore-ObservationTriggeredBy
Context of Use | Observation |
Canonical_URL | Status | Current_Version | Last_Updated | Description | Profile_Purpose |
---|---|---|---|---|---|
http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy | active | 1.1.0 | 2023-12-12 | This extension supports the sharing of the observation(s) that triggered the performance of the main observation. | This is a Pathology use case to backport R5 functionality to identify the observation(s) that triggered the performance of this observation. |
Tree View
ExtensionUKCoreObservationTriggeredBy (Extension) | I | Extension | |
id | 0..1 | string | |
extension | I | 2..* | Extension |
observation | I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | ||
valueReference | Reference(Observation) | ||
type | I | 1..1 | ExtensionBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | ||
valueCode | code | ||
reason | I | 0..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | ||
valueString | string | ||
url | 1..1 | uriFixed Value | |
value[x] | 0..0 |
Detailed Descriptions
Extension | |
Definition | Identifies the observation(s) that triggered the performance of this observation. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 2...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.extension:observation | |
Definition | Reference to the triggering observation. |
Cardinality | 1...1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Extension.extension:observation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.extension:observation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.extension:observation.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | observation |
Mappings |
|
Extension.extension:observation.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Reference(Observation) |
Invariants |
|
Mappings |
|
Extension.extension:type | |
Definition | The type of trigger. Reflex | Repeat | Re-run. |
Cardinality | 1...1 |
Type | Extension |
Binding | http://hl7.org/fhir/ValueSet/observation-triggeredbytype (required) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Extension.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.extension:type.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | type |
Mappings |
|
Extension.extension:type.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Invariants |
|
Mappings |
|
Extension.extension:reason | |
Definition | Provides the reason why this observation was performed as a result of the observation(s) referenced. |
Cardinality | 0...1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Extension.extension:reason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.extension:reason.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.extension:reason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | reason |
Mappings |
|
Extension.extension:reason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy |
Mappings |
|
Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
Table View
Extension | .. | |
Extension.extension | 2.. | |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | Reference(Observation) | 1.. |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | code | 1.. |
Extension.extension | ..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | string | 1.. |
Extension.url | .. | |
Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ObservationTriggeredBy" /> <url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" /> <version value="1.1.0" /> <name value="ExtensionUKCoreObservationTriggeredBy" /> <title value="Extension UK Core Observation Triggered By" /> <status value="active" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This extension supports the sharing of the observation(s) that triggered the performance of the main observation." /> <purpose value="This is a Pathology use case to backport R5 functionality to identify the observation(s) that triggered the performance of this observation." /> <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" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Observation" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Triggering observation(s)" /> <definition value="Identifies the observation(s) that triggered the performance of this observation." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <min value="2" /> </element> <element id="Extension.extension:observation"> <path value="Extension.extension" /> <sliceName value="observation" /> <short value="Triggering observation" /> <definition value="Reference to the triggering observation." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:observation.url"> <path value="Extension.extension.url" /> <fixedUri value="observation" /> </element> <element id="Extension.extension:observation.value[x]"> <path value="Extension.extension.value[x]" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" /> </type> </element> <element id="Extension.extension:type"> <path value="Extension.extension" /> <sliceName value="type" /> <short value="reflex | repeat | re-run" /> <definition value="The type of trigger. Reflex | Repeat | Re-run." /> <min value="1" /> <max value="1" /> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/observation-triggeredbytype" /> </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" /> <type> <code value="code" /> </type> </element> <element id="Extension.extension:reason"> <path value="Extension.extension" /> <sliceName value="reason" /> <short value="Reason that the observation was triggered" /> <definition value="Provides the reason why this observation was performed as a result of the observation(s) referenced." /> <max value="1" /> </element> <element id="Extension.extension:reason.url"> <path value="Extension.extension.url" /> <fixedUri value="reason" /> </element> <element id="Extension.extension:reason.value[x]"> <path value="Extension.extension.value[x]" /> <min value="1" /> <type> <code value="string" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ObservationTriggeredBy", "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy", "version": "1.1.0", "name": "ExtensionUKCoreObservationTriggeredBy", "title": "Extension UK Core Observation Triggered By", "status": "active", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This extension supports the sharing of the observation(s) that triggered the performance of the main observation.", "purpose": "This is a Pathology use case to backport R5 functionality to identify the observation(s) that triggered the performance of this observation.", "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": "Observation" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Triggering observation(s)", "definition": "Identifies the observation(s) that triggered the performance of this observation." }, { "id": "Extension.extension", "path": "Extension.extension", "min": 2 }, { "id": "Extension.extension:observation", "path": "Extension.extension", "sliceName": "observation", "short": "Triggering observation", "definition": "Reference to the triggering observation.", "min": 1, "max": "1" }, { "id": "Extension.extension:observation.url", "path": "Extension.extension.url", "fixedUri": "observation" }, { "id": "Extension.extension:observation.value[x]", "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ] }, { "id": "Extension.extension:type", "path": "Extension.extension", "sliceName": "type", "short": "reflex | repeat | re-run", "definition": "The type of trigger. Reflex | Repeat | Re-run.", "min": 1, "max": "1", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-triggeredbytype" } }, { "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": "code" } ] }, { "id": "Extension.extension:reason", "path": "Extension.extension", "sliceName": "reason", "short": "Reason that the observation was triggered", "definition": "Provides the reason why this observation was performed as a result of the observation(s) referenced.", "max": "1" }, { "id": "Extension.extension:reason.url", "path": "Extension.extension.url", "fixedUri": "reason" }, { "id": "Extension.extension:reason.value[x]", "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "string" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Feedback
Click here to:Report issue for Extension-UKCore-ObservationTriggeredBy, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Examples
Triggered By Drug Use - An example to illustrate the pre-adopted R5 element via an extension, which is used to indicate a triggering observation.Example UKCore-Extension-TriggeredBy
Extension Specific Guidance
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Observation.