This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
This profile sets minimum expectations for the Observation resource to record, search and fetch smoking status data associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the Argonaut SmokingStatus profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Observation must have:
Profile specific implementation guidance:
The official URL for this profile is:
http://fhir.org/guides/argonaut/StructureDefinition/argo-smokingstatus
This profile builds on Observation.
This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Observation.status
which has an required binding to:
Observation.code
Observation.code.coding.system
= http://loinc.orgObservation.code.coding.code
=72166-2Observation.subject
Observation.issued
Observation.valueCodeableConcept
which has an extensible + max valueset binding to the Smoking Status value set.Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Argonaut Smoking Status Observation Profile | ||
status | S | 1..1 | code | Binding: ObservationStatus (required) |
code | S | 1..1 | CodeableConcept | Smoking Status: LOINC 72166-2 = Tobacco smoking status NHIS Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]} |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | |
issued | S | 1..1 | instant | |
valueCodeableConcept | S | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: Smoking Status (extensible) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Argonaut Smoking Status Observation Profile obs-6: SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code | |
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: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
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 | Unique Id for this particular observation | |
status | ?!S | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | S | 1..1 | CodeableConcept | Smoking Status: LOINC 72166-2 = Tobacco smoking status NHIS Binding: LOINC Codes (example) Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]} |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
issued | S | 1..1 | instant | Date/Time this was made available |
performer | Σ | 0..* | Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(RelatedPerson) | Who is responsible for the observation |
valueCodeableConcept | S | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: Smoking Status (extensible) |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
comments | 0..1 | string | Comments about result | |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMED CT Body Structures (example) | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device), Reference(DeviceMetric) | (Measurement) Device | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
related | Σ | 0..* | BackboneElement | Resource related to this observation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
type | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) | |
target | 1..1 | Reference(Observation), Reference(QuestionnaireResponse) | Resource that is related to this one | |
component | Σ | 0..* | BackboneElement | Component results |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ΣI | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | Unknown reference to #Observation:argoprofile.referenceRange Provides guide for interpretation of component result | ||
Documentation for this format |
Observation.status
which has an required binding to:
Observation.code
Observation.code.coding.system
= http://loinc.orgObservation.code.coding.code
=72166-2Observation.subject
Observation.issued
Observation.valueCodeableConcept
which has an extensible + max valueset binding to the Smoking Status value set.Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Argonaut Smoking Status Observation Profile | ||
status | S | 1..1 | code | Binding: ObservationStatus (required) |
code | S | 1..1 | CodeableConcept | Smoking Status: LOINC 72166-2 = Tobacco smoking status NHIS Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]} |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | |
issued | S | 1..1 | instant | |
valueCodeableConcept | S | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: Smoking Status (extensible) |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Argonaut Smoking Status Observation Profile obs-6: SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code | |
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: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
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 | Unique Id for this particular observation | |
status | ?!S | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | S | 1..1 | CodeableConcept | Smoking Status: LOINC 72166-2 = Tobacco smoking status NHIS Binding: LOINC Codes (example) Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]} |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
issued | S | 1..1 | instant | Date/Time this was made available |
performer | Σ | 0..* | Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(RelatedPerson) | Who is responsible for the observation |
valueCodeableConcept | S | 1..1 | CodeableConcept | Coded Responses from Smoking Status Value Set Binding: Smoking Status (extensible) |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
comments | 0..1 | string | Comments about result | |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMED CT Body Structures (example) | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device), Reference(DeviceMetric) | (Measurement) Device | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
related | Σ | 0..* | BackboneElement | Resource related to this observation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
type | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) | |
target | 1..1 | Reference(Observation), Reference(QuestionnaireResponse) | Resource that is related to this one | |
component | Σ | 0..* | BackboneElement | Component results |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ΣI | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | Unknown reference to #Observation:argoprofile.referenceRange Provides guide for interpretation of component result | ||
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.
GET [base]/Observation?patient=[id]&code=72166-2
Example:
GET https://fhir-open-api-dstu2.smarthealthit.org/Observation?patient=1032702&code=72166-2
Support: Mandatory to support search by patient and LOINC = ‘72166-2’.
Implementation Notes: Search based on smoking status LOINC code. Fetches a bundle of all Observation resources with Observation.code of Tobacco Smoking Status for the specified patient (how to search by reference) and (how to search by token).
Response Class: