StructureDefinition-UKCore-Observation-TobaccoConsumption

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-TobaccoConsumption0.0.12023-09-12

Defines the additional constraints and extensions on the UK Core Observation profile


Profile_Purpose

To provide implementers with additional support when implementing gathering and recording the patient's tobacco consumption per day / week

url1..1System.StringFixed Value
valueReferenceReference(UK Core Observation)
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusΣ ?!1..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
codeΣ1..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
effectiveDateTimedateTime
effectivePeriodPeriod
effectiveTimingTiming
effectiveInstantinstant
issuedΣ0..1instant
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
valueQuantityQuantity
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
bodySite0..1CodeableConceptBinding
method0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
codeΣ1..1CodeableConceptBinding
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Table View

Observation..
Observation.category1..1
Observation.category.coding..
Observation.category.coding.system..
Observation.category.coding.code..
Observation.code..
Observation.subjectReference(UK Core Patient)1..
Observation.value[x]Quantity..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Observation-TobaccoConsumption" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-TobaccoConsumption" />
    <version value="0.0.1" />
    <name value="UKCoreObservationTobaccoConsumption" />
    <title value="UKCore Observation Tobacco Consumption" />
    <status value="draft" />
    <date value="2023-09-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="Defines the additional constraints and extensions on the UK Core Observation profile" />
    <purpose value="To provide implementers with additional support when implementing gathering and recording the patient&#39;s tobacco consumption per day / week" />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &amp;quot;License&amp;quot;); 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 &amp;quot;AS IS&amp;quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; 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" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Observation" />
    <baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
    <derivation value="constraint" />
    <differential>
        <element id="Observation.category">
            <path value="Observation.category" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Observation.category.coding.system">
            <path value="Observation.category.coding.system" />
            <fixedUri value="http://terminology.hl7.org/CodeSystem/observation-category" />
        </element>
        <element id="Observation.category.coding.code">
            <path value="Observation.category.coding.code" />
            <fixedCode value="social-history" />
        </element>
        <element id="Observation.code">
            <path value="Observation.code" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-TobaccoConsumption" />
            </binding>
        </element>
        <element id="Observation.subject">
            <path value="Observation.subject" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="Observation.value[x]">
            <path value="Observation.value[x]" />
            <type>
                <code value="Quantity" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Observation-TobaccoConsumption",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-TobaccoConsumption",
    "version": "0.0.1",
    "name": "UKCoreObservationTobaccoConsumption",
    "title": "UKCore Observation Tobacco Consumption",
    "status": "draft",
    "date": "2023-09-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Defines the additional constraints and extensions on the UK Core Observation profile",
    "purpose": "To provide implementers with additional support when implementing gathering and recording the patient's tobacco consumption per day / week",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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",
    "kind": "resource",
    "abstract": false,
    "type": "Observation",
    "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Observation.category",
                "path": "Observation.category",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Observation.category.coding.system",
                "path": "Observation.category.coding.system",
                "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category"
            },
            {
                "id": "Observation.category.coding.code",
                "path": "Observation.category.coding.code",
                "fixedCode": "social-history"
            },
            {
                "id": "Observation.code",
                "path": "Observation.code",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-TobaccoConsumption"
                }
            },
            {
                "id": "Observation.subject",
                "path": "Observation.subject",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "Observation.value[x]",
                "path": "Observation.value[x]",
                "type":  [
                    {
                        "code": "Quantity"
                    }
                ]
            }
        ]
    }
}

Examples

Pipe Smoker - An example to illustrate recording a patient who smokes a pipe.
Example UKCore-Observation-PipeSmoker

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:

Example Usage Scenarios

The following are example usage scenarios for the UK Core Observation Tobacco Consumption profile:

  • Query and retrieve a patient's tobacco usage, including type and amount
  • Record or update a patient's tobacco consumption

Profile Specific Implementation Guidance:

This is a derived profile of UKCore-Observation and this page only shows the differences between the two. Refer to the base Profile for more implementation guidance.

Minimum Viable Content

The minimum viable content that all provider and consumer systems SHALL support are the elements within the corresponding UKCore-Observation table, along with the following.

Element Reason
Observation.status A status of final SHALL be present.
Observation.category A category of social-history SHALL be present.
Observation.code A SNOMED CT concept SHALL be present.
Observation.subject A UKCore-Patient SHALL be present.
Observation.effective[x] An effective time or date SHALL be present.
Observation.value[x] A quantity SHALL be present.

Bindings (differential)

More information about the bindings to UK Core ValueSets, and other ValueSets different to UK Core Observation can be found below.

Context Strength Link
Observation.code Preferred ValueSet UKCore-TobaccoConsumption

status

The following value SHALL be used:

  • Observation.status = final

category

The following values SHALL be used:

  • Observation.category.coding.system = http://terminology.hl7.org/CodeSystem/observation-category
  • Observation.category.coding.code = social-history
  • Observation.category.coding.display = Social History.

subject

The cardinality of this element is 1..1, and the resource being referenced SHALL conform to the Profile UKCore-Patient.


effective[x]

The cardinality of this element is 1..1, and it SHALL be present.


value[x]

The cardinality of this element is 1..1, and SHALL be a valueQuantity.