AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.5.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: AU PS Smoking Status

This profile sets minimum expectations for an Observation resource that represents a patient’s smoking status in the context of a patient summary in an Australian context. It is based on the AU Core Smoking Status profile, and applies the additional requirements from Observation Social History - Tobacco Use (IPS).

Usages:

• Use this Profile: AU PS Bundle
• Refer to this Profile: AU PS Composition

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AUCoreSmokingStatus

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation		0..*	AUCoreSmokingStatus	Smoking status This profile also complies with the profile Observation Social History - Tobacco Use (IPS)
status	O	1..1	code	registered | preliminary | final | amended + Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category	O	1..*	CodeableConcept	Classification of type of observation Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Slices for category				Content/Rules for all slices
category:socialHistory	O	1..1	CodeableConcept	Classification of type of observation Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
code	O	1..1	CodeableConceptIPS	Type of observation (code / type) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
coding		2..*	Coding	Code defined by a terminology system
Slices for coding				Content/Rules for all slices
coding:loincSmokingStatus		1..1	Coding	LOINC Smoking Status
subject	O	1..1	Reference(AU PS Patient)	Who and/or what the observation is about Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SO	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
effective[x]	O	1..1	dateTime	Date, and optionally time, the observation was performed Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
value[x]	O	0..1	CodeableConcept	Actual result Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
dataAbsentReason	O	0..1	CodeableConcept	Why the result is missing Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
component		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	AUCoreSmokingStatus	Smoking status This profile also complies with the profile Observation Social History - Tobacco Use (IPS) Constraints: obs-6, obs-7, au-core-obs-01
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Slices for category	SO	1..*	CodeableConcept	Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category:socialHistory	SO	1..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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	SOΣ	1..1	CodeableConceptIPS	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 1747861000168109
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
Slices for coding	Σ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code, value:system
coding:loincSmokingStatus	Σ	1..1	Coding	LOINC Smoking Status
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 72166-2
subject	SOΣ	1..1	Reference(AU PS Patient)	Who and/or what the observation is about Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
effective[x]	SOΣC	1..1	dateTime	Date, and optionally time, the observation was performed Constraints: au-core-obs-02 Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
value[x]	SOΣC	0..1	CodeableConcept	Actual result Binding: Smoking Status (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
dataAbsentReason	SOC	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.category:socialHistory	preferred	Pattern Value: social-history http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.code	example	Pattern Value: SNOMED-CT Code 1747861000168109 http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard
Observation.value[x]	extensible	SmokingStatus https://healthterminologies.gov.au/fhir/ValueSet/smoking-status-1 From https://tx.ontoserver.csiro.au/fhir
Observation.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-obs-01	error	Observation	At least value or data absent reason shall be present : dataAbsentReason.exists() or value.exists()
au-core-obs-02	error	Observation.effective[x]	Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present : (($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	AUCoreSmokingStatus	Smoking status This profile also complies with the profile Observation Social History - Tobacco Use (IPS) Constraints: obs-6, obs-7, au-core-obs-01
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. Additional Bindings Purpose AllLanguages Max Binding
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
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	?!SOΣ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Slices for category	SO	1..*	CodeableConcept	Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category:socialHistory	SO	1..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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	SOΣ	1..1	CodeableConceptIPS	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 1747861000168109
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code, value:system
coding:loincSmokingStatus	Σ	1..1	Coding	LOINC Smoking Status
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 72166-2
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
subject	SOΣ	1..1	Reference(AU PS Patient)	Who and/or what the observation is about Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	SOΣC	1..1	dateTime	Date, and optionally time, the observation was performed Constraints: au-core-obs-02 Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)	Who is responsible for the observation
value[x]	SOΣC	0..1	CodeableConcept	Actual result Binding: Smoking Status (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
dataAbsentReason	SOC	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.category:socialHistory	preferred	Pattern Value: social-history http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.code	example	Pattern Value: SNOMED-CT Code 1747861000168109 http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard
Observation.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Observation.value[x]	extensible	SmokingStatus https://healthterminologies.gov.au/fhir/ValueSet/smoking-status-1 From https://tx.ontoserver.csiro.au/fhir
Observation.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard
Observation.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site From the FHIR Standard
Observation.method	example	ObservationMethods http://hl7.org/fhir/ValueSet/observation-methods From the FHIR Standard
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes http://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes http://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.component.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-obs-01	error	Observation	At least value or data absent reason shall be present : dataAbsentReason.exists() or value.exists()
au-core-obs-02	error	Observation.effective[x]	Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present : (($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
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()

This structure is derived from AUCoreSmokingStatus

Summary

Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 0

Differential View

This structure is derived from AUCoreSmokingStatus

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation		0..*	AUCoreSmokingStatus	Smoking status This profile also complies with the profile Observation Social History - Tobacco Use (IPS)
status	O	1..1	code	registered | preliminary | final | amended + Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category	O	1..*	CodeableConcept	Classification of type of observation Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Slices for category				Content/Rules for all slices
category:socialHistory	O	1..1	CodeableConcept	Classification of type of observation Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
code	O	1..1	CodeableConceptIPS	Type of observation (code / type) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
coding		2..*	Coding	Code defined by a terminology system
Slices for coding				Content/Rules for all slices
coding:loincSmokingStatus		1..1	Coding	LOINC Smoking Status
subject	O	1..1	Reference(AU PS Patient)	Who and/or what the observation is about Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SO	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
effective[x]	O	1..1	dateTime	Date, and optionally time, the observation was performed Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
value[x]	O	0..1	CodeableConcept	Actual result Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
dataAbsentReason	O	0..1	CodeableConcept	Why the result is missing Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
component		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	AUCoreSmokingStatus	Smoking status This profile also complies with the profile Observation Social History - Tobacco Use (IPS) Constraints: obs-6, obs-7, au-core-obs-01
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Slices for category	SO	1..*	CodeableConcept	Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category:socialHistory	SO	1..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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	SOΣ	1..1	CodeableConceptIPS	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 1747861000168109
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
Slices for coding	Σ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code, value:system
coding:loincSmokingStatus	Σ	1..1	Coding	LOINC Smoking Status
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 72166-2
subject	SOΣ	1..1	Reference(AU PS Patient)	Who and/or what the observation is about Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
effective[x]	SOΣC	1..1	dateTime	Date, and optionally time, the observation was performed Constraints: au-core-obs-02 Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
value[x]	SOΣC	0..1	CodeableConcept	Actual result Binding: Smoking Status (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
dataAbsentReason	SOC	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.category:socialHistory	preferred	Pattern Value: social-history http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.code	example	Pattern Value: SNOMED-CT Code 1747861000168109 http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard
Observation.value[x]	extensible	SmokingStatus https://healthterminologies.gov.au/fhir/ValueSet/smoking-status-1 From https://tx.ontoserver.csiro.au/fhir
Observation.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-obs-01	error	Observation	At least value or data absent reason shall be present : dataAbsentReason.exists() or value.exists()
au-core-obs-02	error	Observation.effective[x]	Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present : (($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	AUCoreSmokingStatus	Smoking status This profile also complies with the profile Observation Social History - Tobacco Use (IPS) Constraints: obs-6, obs-7, au-core-obs-01
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. Additional Bindings Purpose AllLanguages Max Binding
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
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	?!SOΣ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Slices for category	SO	1..*	CodeableConcept	Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category:socialHistory	SO	1..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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	SOΣ	1..1	CodeableConceptIPS	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 1747861000168109
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code, value:system
coding:loincSmokingStatus	Σ	1..1	Coding	LOINC Smoking Status
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 72166-2
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
subject	SOΣ	1..1	Reference(AU PS Patient)	Who and/or what the observation is about Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	SOΣC	1..1	dateTime	Date, and optionally time, the observation was performed Constraints: au-core-obs-02 Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)	Who is responsible for the observation
value[x]	SOΣC	0..1	CodeableConcept	Actual result Binding: Smoking Status (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
dataAbsentReason	SOC	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.category:socialHistory	preferred	Pattern Value: social-history http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.code	example	Pattern Value: SNOMED-CT Code 1747861000168109 http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard
Observation.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Observation.value[x]	extensible	SmokingStatus https://healthterminologies.gov.au/fhir/ValueSet/smoking-status-1 From https://tx.ontoserver.csiro.au/fhir
Observation.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard
Observation.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site From the FHIR Standard
Observation.method	example	ObservationMethods http://hl7.org/fhir/ValueSet/observation-methods From the FHIR Standard
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes http://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes http://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.component.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-obs-01	error	Observation	At least value or data absent reason shall be present : dataAbsentReason.exists() or value.exists()
au-core-obs-02	error	Observation.effective[x]	Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present : (($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
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()

This structure is derived from AUCoreSmokingStatus

Summary

Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 0

Other representations of profile: CSV, Excel, Schematron