AU Core Implementation Guide
3.0.0-ci-build - CI Build Australia flag

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

Resource Profile: AU Core Smoking Status

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-smokingstatus Version: 3.0.0-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUCoreSmokingStatus

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for an Observation resource to record, search, and fetch observations that represent a patient’s smoking status, i.e. current behaviour for all types of tobacco smoking, with standard coding. It is based on the FHIR Observation resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage Scenarios

The following are supported usage scenarios for this profile:

  • Query for observations of smoking status associated with a patient
  • Record or update an observation of smoking status associated with a patient

Profile Specific Implementation Guidance

  • Observation.category provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.
  • Additional codes that translate or map to the Observation code or category codes are allowed. For example, providing both a local code and the required code.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 2.0.0:

  • No changes

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Smoking status
    Constraints: obs-6, obs-7, au-core-obs-01
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.Slices for category This element has obligations and must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by pattern:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialHistory This element has obligations and must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "social-history"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "1747861000168109"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:code, value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.code.Slices for coding.coding:loincSmokingStatus This element is included in summaries. 0..1 Coding LOINC Smoking Status
    Observation.code.Slices for coding.coding:loincSmokingStatus.system This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://loinc.org (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: 72166-2 (no extensions allowed)
    Observation.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU Core Patient) Who and/or what the observation is about
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.effective[x] This element has obligations and must be supported. This element is included in summaries. C 1..1 dateTime Date, and optionally time, the observation was performed
    Constraints: au-core-obs-02
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.value[x] This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConcept Actual result
    Binding: Smoking Status (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.dataAbsentReason This element has obligations and must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    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 example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x] Base extensible Smoking Status ⏿1.0.0 tx.hl7.org.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Smoking status
    Constraints: au-core-obs-01
    Observation.status This element has obligations and must be supported. 1..1 code registered | preliminary | final | amended +
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.Slices for category This element has obligations and must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by pattern:$this
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialHistory This element has obligations and must be supported. 1..1 CodeableConcept Classification of type of observation
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "social-history"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code This element has obligations and must be supported. 1..1 CodeableConcept Type of observation (code / type)
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "1747861000168109"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code.Slices for coding 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:code, value:system
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.code.Slices for coding.coding:loincSmokingStatus 0..1 Coding LOINC Smoking Status
    Observation.code.Slices for coding.coding:loincSmokingStatus.system 1..1 uri Identity of the terminology system
    Fixed Value: http://loinc.org (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 72166-2 (no extensions allowed)
    Observation.effective[x] This element has obligations and must be supported. C 1..1 dateTime Date, and optionally time, the observation was performed
    Constraints: au-core-obs-02
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.value[x] This element has obligations and must be supported. C 0..1 CodeableConcept Actual result
    Binding: Smoking Status (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.dataAbsentReason This element has obligations and must be supported. C 0..1 CodeableConcept Why the result is missing
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.value[x] Base extensible Smoking Status ⏿1.0.0 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    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()))
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Smoking status
    Constraints: obs-6, obs-7, au-core-obs-01
    Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
    Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Observation.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
    Observation.contained 0..* Resource Contained, inline Resources
    Observation.extension 0..* Extension Additional content defined by implementations
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
    Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    Observation.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.Slices for category This element has obligations and must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by pattern:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialHistory This element has obligations and must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "social-history"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "1747861000168109"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code.id 0..1 string Unique id for inter-element referencing
    Observation.code.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.code.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:code, value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.code.Slices for coding.coding:loincSmokingStatus This element is included in summaries. 0..1 Coding LOINC Smoking Status
    Observation.code.Slices for coding.coding:loincSmokingStatus.id 0..1 string Unique id for inter-element referencing
    Observation.code.Slices for coding.coding:loincSmokingStatus.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.code.Slices for coding.coding:loincSmokingStatus.system This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://loinc.org (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.version This element is included in summaries. 0..1 string Version of the system - if relevant
    Observation.code.Slices for coding.coding:loincSmokingStatus.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: 72166-2 (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.display This element is included in summaries. 0..1 string Representation defined by the system
    Observation.code.Slices for coding.coding:loincSmokingStatus.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
    Observation.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
    Observation.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU Core Patient) Who and/or what the observation is about
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
    Observation.effective[x] This element has obligations and must be supported. This element is included in summaries. C 1..1 dateTime Date, and optionally time, the observation was performed
    Constraints: au-core-obs-02
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
    Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
    Observation.value[x] This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConcept Actual result
    Binding: Smoking Status (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.dataAbsentReason This element has obligations and must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.note 0..* Annotation Comments about the observation
    Observation.bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
    Observation.method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
    Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
    Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
    Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
    Observation.referenceRange.text 0..1 string Text based reference range in an observation
    Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
    Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    Observation.component This element is included in summaries. 0..* BackboneElement Component results
    Observation.component.id 0..1 string Unique id for inter-element referencing
    Observation.component.extension 0..* Extension Additional content defined by implementations
    Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.component.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Observation.component.value[x] This element is included in summaries. 0..1 Actual component result
    Observation.component.value[x].valueQuantity Quantity
    Observation.component.value[x].valueCodeableConcept CodeableConcept
    Observation.component.value[x].valueString string
    Observation.component.value[x].valueBoolean boolean
    Observation.component.value[x].valueInteger integer
    Observation.component.value[x].valueRange Range
    Observation.component.value[x].valueRatio Ratio
    Observation.component.value[x].valueSampledData SampledData
    Observation.component.value[x].valueTime time
    Observation.component.value[x].valueDateTime dateTime
    Observation.component.value[x].valuePeriod Period
    Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    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 example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x] Base extensible Smoking Status ⏿1.0.0 tx.hl7.org.au
    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.

    Constraints

    Id Grade Path(s) Description Expression
    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()
    sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from Observation

    Summary

    Mandatory: 4 elements(2 nested mandatory elements)
    Must-Support: 8 elements
    Fixed: 2 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Observation.category
    • The element 2 is sliced based on the values of Observation.code.coding

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Smoking status
    Constraints: obs-6, obs-7, au-core-obs-01
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.Slices for category This element has obligations and must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by pattern:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialHistory This element has obligations and must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "social-history"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "1747861000168109"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:code, value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.code.Slices for coding.coding:loincSmokingStatus This element is included in summaries. 0..1 Coding LOINC Smoking Status
    Observation.code.Slices for coding.coding:loincSmokingStatus.system This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://loinc.org (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: 72166-2 (no extensions allowed)
    Observation.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU Core Patient) Who and/or what the observation is about
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.effective[x] This element has obligations and must be supported. This element is included in summaries. C 1..1 dateTime Date, and optionally time, the observation was performed
    Constraints: au-core-obs-02
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.value[x] This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConcept Actual result
    Binding: Smoking Status (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.dataAbsentReason This element has obligations and must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    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 example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x] Base extensible Smoking Status ⏿1.0.0 tx.hl7.org.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()

    Differential View

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Smoking status
    Constraints: au-core-obs-01
    Observation.status This element has obligations and must be supported. 1..1 code registered | preliminary | final | amended +
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.Slices for category This element has obligations and must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by pattern:$this
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialHistory This element has obligations and must be supported. 1..1 CodeableConcept Classification of type of observation
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "social-history"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code This element has obligations and must be supported. 1..1 CodeableConcept Type of observation (code / type)
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "1747861000168109"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code.Slices for coding 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:code, value:system
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.code.Slices for coding.coding:loincSmokingStatus 0..1 Coding LOINC Smoking Status
    Observation.code.Slices for coding.coding:loincSmokingStatus.system 1..1 uri Identity of the terminology system
    Fixed Value: http://loinc.org (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 72166-2 (no extensions allowed)
    Observation.subject This element has obligations and must be supported. 1..1 Reference(AU Core Patient) Who and/or what the observation is about
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.effective[x] This element has obligations and must be supported. C 1..1 dateTime Date, and optionally time, the observation was performed
    Constraints: au-core-obs-02
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.value[x] This element has obligations and must be supported. C 0..1 CodeableConcept Actual result
    Binding: Smoking Status (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.dataAbsentReason This element has obligations and must be supported. C 0..1 CodeableConcept Why the result is missing
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.value[x] Base extensible Smoking Status ⏿1.0.0 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    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()))

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Smoking status
    Constraints: obs-6, obs-7, au-core-obs-01
    Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
    Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Observation.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
    Observation.contained 0..* Resource Contained, inline Resources
    Observation.extension 0..* Extension Additional content defined by implementations
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
    Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    Observation.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.Slices for category This element has obligations and must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by pattern:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialHistory This element has obligations and must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "social-history"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "1747861000168109"
    }
  ]
}
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.code.id 0..1 string Unique id for inter-element referencing
    Observation.code.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.code.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:code, value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.code.Slices for coding.coding:loincSmokingStatus This element is included in summaries. 0..1 Coding LOINC Smoking Status
    Observation.code.Slices for coding.coding:loincSmokingStatus.id 0..1 string Unique id for inter-element referencing
    Observation.code.Slices for coding.coding:loincSmokingStatus.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.code.Slices for coding.coding:loincSmokingStatus.system This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://loinc.org (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.version This element is included in summaries. 0..1 string Version of the system - if relevant
    Observation.code.Slices for coding.coding:loincSmokingStatus.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: 72166-2 (no extensions allowed)
    Observation.code.Slices for coding.coding:loincSmokingStatus.display This element is included in summaries. 0..1 string Representation defined by the system
    Observation.code.Slices for coding.coding:loincSmokingStatus.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
    Observation.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
    Observation.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU Core Patient) Who and/or what the observation is about
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
    Observation.effective[x] This element has obligations and must be supported. This element is included in summaries. C 1..1 dateTime Date, and optionally time, the observation was performed
    Constraints: au-core-obs-02
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
    Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
    Observation.value[x] This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConcept Actual result
    Binding: Smoking Status (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.dataAbsentReason This element has obligations and must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.note 0..* Annotation Comments about the observation
    Observation.bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
    Observation.method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
    Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
    Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
    Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
    Observation.referenceRange.text 0..1 string Text based reference range in an observation
    Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
    Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    Observation.component This element is included in summaries. 0..* BackboneElement Component results
    Observation.component.id 0..1 string Unique id for inter-element referencing
    Observation.component.extension 0..* Extension Additional content defined by implementations
    Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.component.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Observation.component.value[x] This element is included in summaries. 0..1 Actual component result
    Observation.component.value[x].valueQuantity Quantity
    Observation.component.value[x].valueCodeableConcept CodeableConcept
    Observation.component.value[x].valueString string
    Observation.component.value[x].valueBoolean boolean
    Observation.component.value[x].valueInteger integer
    Observation.component.value[x].valueRange Range
    Observation.component.value[x].valueRatio Ratio
    Observation.component.value[x].valueSampledData SampledData
    Observation.component.value[x].valueTime time
    Observation.component.value[x].valueDateTime dateTime
    Observation.component.value[x].valuePeriod Period
    Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    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 example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x] Base extensible Smoking Status ⏿1.0.0 tx.hl7.org.au
    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.

    Constraints

    Id Grade Path(s) Description Expression
    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()
    sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from Observation

    Summary

    Mandatory: 4 elements(2 nested mandatory elements)
    Must-Support: 8 elements
    Fixed: 2 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Observation.category
    • The element 2 is sliced based on the values of Observation.code.coding

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

    FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

    Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.

    Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
    patient+category SHALL reference+token
    patient+category+date SHALL reference+token+date
    patient+code SHALL reference+token
    patient+category+status SHOULD reference+token+token
    patient+code+date SHOULD reference+token+date
    patient MAY reference The requester SHALL provide at least an id value and MAY provide both the type and id values. The responder SHALL support both.

    The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
    category MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.

    The requester SHALL support search using the category code defined in this profile. The responder SHALL support search using the category code defined in this profile.
    code MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.

    The requester SHALL support search using the LOINC codes defined in this profile. The responder SHALL support search using the LOINC codes defined in this profile.

    The requester SHALL support multipleOr. The responder SHALL support multipleOr.
    date MAY date A requester SHALL provide a value precise to the second + time offset. A responder SHALL support a value precise to the second + time offset.

    The requester SHALL support these search comparators gt, lt, ge, le. The responder SHALL support these search comparators gt, lt, ge, le.

    The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le. The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.
    status MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.

    The requester SHALL support multipleOr. The responder SHALL support multipleOr.

    Mandatory Search Parameters

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching using the combination of the patient and category search parameters:
      • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

      GET [base]/Observation?patient={type/}[id]&category={system|}[code]

      Example:

      1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history
      2. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category (how to search by reference and how to search by token)

    2. SHALL support searching using the combination of the patient and category and date search parameters:
      • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
      • SHALL support these date comparators: gt,lt,ge,le
      • SHOULD support multipleAnd search on date (e.g. date=[date]&date=[date]&...), and if multipleAnd is supported, SHALL support the search comparators gt,lt,ge,le

      GET [base]/Observation?patient={type/}[id]&category={system|}[code]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

      Example:

      1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history&date=ge2020-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and category (how to search by reference and how to search by token and how to search by date)

    3. SHALL support searching using the combination of the patient and code search parameters:
      • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
      • SHOULD support multipleOr search on code (e.g. code={system|}[code],{system|}[code],...)

      GET [base]/Observation?patient={type/}[id]&code={system|}[code]{,{system|}[code],...}

      Example:

      1. GET [base]/Observation?patient=5678&code=http://snomed.info/sct|1747861000168109

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s) (how to search by reference and how to search by token)

    Optional Search Parameters:

    The following search parameters and search parameter combinations SHOULD be supported:

    1. SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

      GET [base]/Observation?patient.identifier=[system|][code]

      Example:

      1. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
      2. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient (how to search by reference and how to search by token)

    2. SHOULD support searching using the combination of the patient and category and status search parameters:
      • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
      • SHALL support multipleOr search on status (e.g. status={system|}[code],{system|}[code],...)

      GET [base]/Observation?patient={type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}

      Example:

      1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history&status=final

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category and status (how to search by reference and how to search by token)

    3. SHOULD support searching using the combination of the patient and code and date search parameters:
      • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
      • SHOULD support multipleOr search on code (e.g. code={system|}[code],{system|}[code],...)
      • SHALL support these date comparators: gt,lt,ge,le
      • SHOULD support multipleAnd search on date (e.g. date=[date]&date=[date]&...), and if multipleAnd is supported, SHALL support the search comparators gt,lt,ge,le

      GET [base]/Observation?patient={type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

      Example:

      1. GET [base]/Observation?patient=5678&code=http://snomed.info/sct|1747861000168109&date=ge2020-01-01T00:00:00Z
      2. GET [base]/Observation?patient.identifier=http://example.org/fhir/mrn|12345&code=http://snomed.info/sct|1747861000168109&date=ge2020-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and observation code(s) (how to search by reference and how to search by token and how to search by date)