International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.34--20170620000000 | Version: 1.1.0-ballot | |||
Draft as of 2017-06-20 | Computable Name: IPSSocialHistoryObsTobaccoUse | |||
Other Identifiers: OID:2.16.840.1.113883.10.22.4.34 (use: official, ) |
This template is a specialization of the Social History Observation that may be used to represent smoking or tobacco habits.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.34 | |
@classCode | 1..1 | code | Fixed Value: OBS | |
@moodCode | 1..1 | code | Fixed Value: EVN | |
id | 0..* | II | ||
code | S | 1..1 | CD | |
@code | 0..1 | cs | Fixed Value: 72166-2 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
translation | S | 0..* | CD | |
statusCode | S | 1..1 | CS | |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
value | S | 1..1 | ANY, BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | Binding: IPS Current Smoking Status (required): IPS Current Smoking Status |
@type | 1..1 | code | XML Namespace: http://www.w3.org/2001/XMLSchema-instance XML: xsi (http://www.w3.org/2001/XMLSchema-instance) Fixed Value: CD | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.value | required | IPSCurrentSmokingStatushttp://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips from this IG |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.value | required | IPSCurrentSmokingStatushttp://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips from this IG |
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Observation.value | required | IPSCurrentSmokingStatushttp://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips from this IG | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from Observation
Summary
Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 7 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.34 | |
@classCode | 1..1 | code | Fixed Value: OBS | |
@moodCode | 1..1 | code | Fixed Value: EVN | |
id | 0..* | II | ||
code | S | 1..1 | CD | |
@code | 0..1 | cs | Fixed Value: 72166-2 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
translation | S | 0..* | CD | |
statusCode | S | 1..1 | CS | |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
value | S | 1..1 | ANY, BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | Binding: IPS Current Smoking Status (required): IPS Current Smoking Status |
@type | 1..1 | code | XML Namespace: http://www.w3.org/2001/XMLSchema-instance XML: xsi (http://www.w3.org/2001/XMLSchema-instance) Fixed Value: CD | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.value | required | IPSCurrentSmokingStatushttp://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips from this IG |
Key Elements View
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.value | required | IPSCurrentSmokingStatushttp://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips from this IG |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Observation.value | required | IPSCurrentSmokingStatushttp://hl7.org/fhir/uv/ips/ValueSet/current-smoking-status-uv-ips from this IG | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from Observation
Summary
Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 7 elements
Slices
This structure defines the following Slices: