US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101
US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101
US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.10.0 See the Directory of published versions
| Official URL: http://va.gov/fhir/StructureDefinition/SmokingStatusObservation | Version: 1.10.0 | |||
| Active as of 2025-11-04 | Computable Name: SmokingStatusObservation | |||
This StructureDefinition contains the maps for VistA file V HEALTH FACTORS (9000010.23) to us-core-smokingstatus.
See also the FHIR Shorthand.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Observation |
C | 0..* | USCoreSmokingStatusProfile(5.0.1) | Measurements and simple assertions This profile also complies with the profiles US Core Smoking Status Observation Profile (6.1.0) and US Core Smoking Status Observation Profile (7.0.0) Constraints: obs-6, obs-7 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
  identifier |
Σ | 0..* | Identifier | Business Identifier for observation |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/{sta3n}/9000010.23 |
 value |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: US Core Status for Smoking Status Observation (required) Required Pattern: final |
 Slices for category |
S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
  category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
  id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 text |
0..1 | string | Plain text representation of the concept | |
| code |
SΣC | 1..1 | CodeableConcept | Smoking Status Binding: US Core Smoking Status Observation Codes (extensible) Constraints: sso-24-1244, sso-24-1862 |
 subject |
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
| encounter |
SΣ | 0..1 | Reference(Encounter: Visit) | Healthcare event during which this observation is made |
| Slices for effective[x] |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
 effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation |
| performer |
SΣ | 0..* | Reference(Practitioner) | Who is responsible for the observation |
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this |
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: SmokingStatus FHIR (required): see mapping VF_SmokingStatus |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
 note |
0..* | Annotation | Comments about the observation | |
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | US Core Status for Smoking Status Observation | 📦7.0.0 | US Core v7.0 |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:SocialHistory | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | US Core Smoking Status Observation Codes | 📦6.1.0 | US Core v6.1 |
| Observation.value[x]:valueCodeableConcept | Base | required | SmokingStatus FHIR | 📦1.10.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| sso-24-1244 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is TOBACCO [C] then fixed value http://loinc.org#72166-2 |
true
|
| sso-24-1862 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is Not TOBACCO [C] then exclude record |
true
|
This structure is derived from USCoreSmokingStatusProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | USCoreSmokingStatusProfile(5.0.1) | Measurements and simple assertions This profile also complies with the profiles US Core Smoking Status Observation Profile (6.1.0) and US Core Smoking Status Observation Profile (7.0.0) | |
 identifier |
||||
| system |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/{sta3n}/9000010.23 |
| value |
S | 0..1 | string | The value that is unique |
| status |
1..1 | code | registered | preliminary | final | amended + Required Pattern: final | |
| Slices for category |
Content/Rules for all slices | |||
| category:SocialHistory |
1..1 | CodeableConcept | Classification of type of observation | |
| code |
C | 1..1 | CodeableConcept | Smoking Status Constraints: sso-24-1244, sso-24-1862 |
| subject |
1..1 | Reference(Patient) | Who and/or what the observation is about | |
| encounter |
S | 0..1 | Reference(Encounter: Visit) | Healthcare event during which this observation is made |
| Slices for effective[x] |
Content/Rules for all slices | |||
| effective[x]:effectiveDateTime |
1..1 | dateTime | Clinically relevant time/time-period for observation | |
| performer |
S | 0..* | Reference(Practitioner) | Who is responsible for the observation |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: SmokingStatus FHIR (required): see mapping VF_SmokingStatus | |
| text |
S | 0..1 | string | Plain text representation of the concept |
| note |
||||
| text |
S | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.value[x]:valueCodeableConcept | Base | required | SmokingStatus FHIR | 📦1.10.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| sso-24-1244 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is TOBACCO [C] then fixed value http://loinc.org#72166-2 |
true
|
| sso-24-1862 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is Not TOBACCO [C] then exclude record |
true
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | USCoreSmokingStatusProfile(5.0.1) | Measurements and simple assertions This profile also complies with the profiles US Core Smoking Status Observation Profile (6.1.0) and US Core Smoking Status Observation Profile (7.0.0) Constraints: obs-6, obs-7 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/{sta3n}/9000010.23 | ||||
| value |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: US Core Status for Smoking Status Observation (required) Required Pattern: final | ||||
| Slices for category |
S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| code |
SΣC | 1..1 | CodeableConcept | Smoking Status Binding: US Core Smoking Status Observation Codes (extensible) Constraints: sso-24-1244, sso-24-1862 | ||||
| subject |
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter: Visit) | Healthcare event during which this observation is made | ||||
| Slices for effective[x] |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation | ||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
SΣ | 0..* | Reference(Practitioner) | Who is responsible for the observation | ||||
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: SmokingStatus FHIR (required): see mapping VF_SmokingStatus | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low |
C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | US Core Status for Smoking Status Observation | 📦7.0.0 | US Core v7.0 |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:SocialHistory | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | US Core Smoking Status Observation Codes | 📦6.1.0 | US Core v6.1 |
| Observation.value[x]:valueCodeableConcept | Base | required | SmokingStatus FHIR | 📦1.10.0 | This IG |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📦4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📦4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📦4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📦4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| sso-24-1244 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is TOBACCO [C] then fixed value http://loinc.org#72166-2 |
true
|
| sso-24-1862 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is Not TOBACCO [C] then exclude record |
true
|
This structure is derived from USCoreSmokingStatusProfile
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | USCoreSmokingStatusProfile(5.0.1) | Measurements and simple assertions This profile also complies with the profiles US Core Smoking Status Observation Profile (6.1.0) and US Core Smoking Status Observation Profile (7.0.0) Constraints: obs-6, obs-7 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/{sta3n}/9000010.23 |
| value |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: US Core Status for Smoking Status Observation (required) Required Pattern: final |
| Slices for category |
S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| code |
SΣC | 1..1 | CodeableConcept | Smoking Status Binding: US Core Smoking Status Observation Codes (extensible) Constraints: sso-24-1244, sso-24-1862 |
| subject |
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
| encounter |
SΣ | 0..1 | Reference(Encounter: Visit) | Healthcare event during which this observation is made |
| Slices for effective[x] |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation |
| performer |
SΣ | 0..* | Reference(Practitioner) | Who is responsible for the observation |
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this |
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: SmokingStatus FHIR (required): see mapping VF_SmokingStatus |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| note |
0..* | Annotation | Comments about the observation | |
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | US Core Status for Smoking Status Observation | 📦7.0.0 | US Core v7.0 |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:SocialHistory | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | US Core Smoking Status Observation Codes | 📦6.1.0 | US Core v6.1 |
| Observation.value[x]:valueCodeableConcept | Base | required | SmokingStatus FHIR | 📦1.10.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| sso-24-1244 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is TOBACCO [C] then fixed value http://loinc.org#72166-2 |
true
|
| sso-24-1862 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is Not TOBACCO [C] then exclude record |
true
|
Differential View
This structure is derived from USCoreSmokingStatusProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | USCoreSmokingStatusProfile(5.0.1) | Measurements and simple assertions This profile also complies with the profiles US Core Smoking Status Observation Profile (6.1.0) and US Core Smoking Status Observation Profile (7.0.0) | |
| identifier |
||||
| system |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/{sta3n}/9000010.23 |
| value |
S | 0..1 | string | The value that is unique |
| status |
1..1 | code | registered | preliminary | final | amended + Required Pattern: final | |
| Slices for category |
Content/Rules for all slices | |||
| category:SocialHistory |
1..1 | CodeableConcept | Classification of type of observation | |
| code |
C | 1..1 | CodeableConcept | Smoking Status Constraints: sso-24-1244, sso-24-1862 |
| subject |
1..1 | Reference(Patient) | Who and/or what the observation is about | |
| encounter |
S | 0..1 | Reference(Encounter: Visit) | Healthcare event during which this observation is made |
| Slices for effective[x] |
Content/Rules for all slices | |||
| effective[x]:effectiveDateTime |
1..1 | dateTime | Clinically relevant time/time-period for observation | |
| performer |
S | 0..* | Reference(Practitioner) | Who is responsible for the observation |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: SmokingStatus FHIR (required): see mapping VF_SmokingStatus | |
| text |
S | 0..1 | string | Plain text representation of the concept |
| note |
||||
| text |
S | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.value[x]:valueCodeableConcept | Base | required | SmokingStatus FHIR | 📦1.10.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| sso-24-1244 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is TOBACCO [C] then fixed value http://loinc.org#72166-2 |
true
|
| sso-24-1862 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is Not TOBACCO [C] then exclude record |
true
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | USCoreSmokingStatusProfile(5.0.1) | Measurements and simple assertions This profile also complies with the profiles US Core Smoking Status Observation Profile (6.1.0) and US Core Smoking Status Observation Profile (7.0.0) Constraints: obs-6, obs-7 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/{sta3n}/9000010.23 | ||||
| value |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: US Core Status for Smoking Status Observation (required) Required Pattern: final | ||||
| Slices for category |
S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| code |
SΣC | 1..1 | CodeableConcept | Smoking Status Binding: US Core Smoking Status Observation Codes (extensible) Constraints: sso-24-1244, sso-24-1862 | ||||
| subject |
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter: Visit) | Healthcare event during which this observation is made | ||||
| Slices for effective[x] |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Clinically relevant time/time-period for observation | ||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
SΣ | 0..* | Reference(Practitioner) | Who is responsible for the observation | ||||
| Slices for value[x] |
ΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueCodeableConcept |
SΣC | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: SmokingStatus FHIR (required): see mapping VF_SmokingStatus | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low |
C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | US Core Status for Smoking Status Observation | 📦7.0.0 | US Core v7.0 |
| Observation.category | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.category:SocialHistory | Base | preferred | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | US Core Smoking Status Observation Codes | 📦6.1.0 | US Core v6.1 |
| Observation.value[x]:valueCodeableConcept | Base | required | SmokingStatus FHIR | 📦1.10.0 | This IG |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📦4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📦4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📦4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📦4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
| sso-24-1244 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is TOBACCO [C] then fixed value http://loinc.org#72166-2 |
true
|
| sso-24-1862 | best practice | Observation.code | If (9000010.23-.01 > 9999999.64-.03) is Not TOBACCO [C] then exclude record |
true
|
This structure is derived from USCoreSmokingStatusProfile
Other representations of profile: CSV, Excel, Schematron