AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.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-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Diagnostic Result

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-diagnosticresult Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 1 Computable Name: AUBaseDiagnosticResult

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines an observation structure to represent a diagnostic investigation result issued by a diagnostic service provider in an Australian context. This profile may be used to represent a specialist or other diagnostic (not imaging or pathology) observation including results of audiology studies, sleep studies or speech pathology. The observation may represent the result of a simple investigation or it may group the set of results of a multi-modality procedure or multi-test study / panel.

Usage Notes

Profile specific implementation guidance:

  • The BodyStructure Reference extension may be suitable for use where
    • body site is not implicit in the code found in Observation.code and
    • body site information is to be handled as a separate resource (e.g. to identify and track separately) instead of an inline coded element in Observation.bodySite.
  • See the AU Base Pathology Result profile for guidance on representing the result of a pathology test.
  • See the AU Base Diagnostic Imaging Result profile for guidance on representing the result of a radiology examination or an imaging intensive diagnostic investigation.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • The data elements list has changed
  • Formal Views of Profile Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation A diagnostic result observation in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    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.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Observation.Slices for extension.extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    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 is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.category 1..* CodeableConcept Diagnostic service section
    Binding: DiagnosticServiceSectionCodes (preferred)
    Observation.code This element is included in summaries. 1..1 CodeableConcept Diagnostic procedure
    Binding: Evaluation Procedure (example)
    Observation.subject This element is included in summaries. 1..1 Reference(Patient) Who and/or what the observation is about
    Observation.effective[x] This element is included in summaries. 1..1 Clinically relevant time/time-period for observation
    Observation.effective[x].effectiveDateTime dateTime
    Observation.effective[x].effectivePeriod Period
    Observation.effective[x].effectiveTiming Timing
    Observation.effective[x].effectiveInstant instant
    Observation.value[x] This element is included in summaries. C 0..1 Actual result
    Observation.value[x].valueQuantity Quantity
    Observation.value[x].valueCodeableConcept CodeableConcept
    Observation.value[x].valueString string
    Observation.value[x].valueBoolean boolean
    Observation.value[x].valueInteger integer
    Observation.value[x].valueRange Range
    Observation.value[x].valueRatio Ratio
    Observation.value[x].valueSampledData SampledData
    Observation.value[x].valueTime time
    Observation.value[x].valueDateTime dateTime
    Observation.value[x].valuePeriod Period
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.hasMember This element is included in summaries. C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result | AU Base Pathology Result) Individual examinations in a group or study series

    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 Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
    Observation.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-obs-0 error Observation A diagnostic result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    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 A diagnostic result observation in an Australian healthcare context
    Constraints: inv-obs-0, inv-obs-1
    Observation.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Observation.Slices for extension.extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    Observation.category 1..* CodeableConcept Diagnostic service section
    Binding: DiagnosticServiceSectionCodes (preferred)
    Observation.code 1..1 CodeableConcept Diagnostic procedure
    Binding: Evaluation Procedure (example)
    Observation.effective[x] 1..1 dateTime, Period, Timing, instant Clinically relevant time/time-period for observation
    Observation.value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Observation.hasMember C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result | AU Base Pathology Result) Individual examinations in a group or study series
    Observation.component
    Observation.component.value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual component result
    Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
    Observation.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    inv-obs-0 error Observation A diagnostic result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation A diagnostic result observation in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    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.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Observation.Slices for extension.extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    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 is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.category 1..* CodeableConcept Diagnostic service section
    Binding: DiagnosticServiceSectionCodes (preferred)
    Observation.code This element is included in summaries. 1..1 CodeableConcept Diagnostic procedure
    Binding: Evaluation Procedure (example)
    Observation.subject This element is included in summaries. 1..1 Reference(Patient) Who and/or what the observation is about
    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 is included in summaries. 1..1 Clinically relevant time/time-period for observation
    Observation.effective[x].effectiveDateTime dateTime
    Observation.effective[x].effectivePeriod Period
    Observation.effective[x].effectiveTiming Timing
    Observation.effective[x].effectiveInstant instant
    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 is included in summaries. C 0..1 Actual result
    Observation.value[x].valueQuantity Quantity
    Observation.value[x].valueCodeableConcept CodeableConcept
    Observation.value[x].valueString string
    Observation.value[x].valueBoolean boolean
    Observation.value[x].valueInteger integer
    Observation.value[x].valueRange Range
    Observation.value[x].valueRatio Ratio
    Observation.value[x].valueSampledData SampledData
    Observation.value[x].valueTime time
    Observation.value[x].valueDateTime dateTime
    Observation.value[x].valuePeriod Period
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    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. C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result | AU Base Pathology Result) Individual examinations in a group or study series
    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. C 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 Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
    Observation.code Base example Evaluation Procedure ⏿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
    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()
    inv-obs-0 error Observation A diagnostic result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    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()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation A diagnostic result observation in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    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.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Observation.Slices for extension.extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    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 is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.category 1..* CodeableConcept Diagnostic service section
    Binding: DiagnosticServiceSectionCodes (preferred)
    Observation.code This element is included in summaries. 1..1 CodeableConcept Diagnostic procedure
    Binding: Evaluation Procedure (example)
    Observation.subject This element is included in summaries. 1..1 Reference(Patient) Who and/or what the observation is about
    Observation.effective[x] This element is included in summaries. 1..1 Clinically relevant time/time-period for observation
    Observation.effective[x].effectiveDateTime dateTime
    Observation.effective[x].effectivePeriod Period
    Observation.effective[x].effectiveTiming Timing
    Observation.effective[x].effectiveInstant instant
    Observation.value[x] This element is included in summaries. C 0..1 Actual result
    Observation.value[x].valueQuantity Quantity
    Observation.value[x].valueCodeableConcept CodeableConcept
    Observation.value[x].valueString string
    Observation.value[x].valueBoolean boolean
    Observation.value[x].valueInteger integer
    Observation.value[x].valueRange Range
    Observation.value[x].valueRatio Ratio
    Observation.value[x].valueSampledData SampledData
    Observation.value[x].valueTime time
    Observation.value[x].valueDateTime dateTime
    Observation.value[x].valuePeriod Period
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.hasMember This element is included in summaries. C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result | AU Base Pathology Result) Individual examinations in a group or study series

    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 Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
    Observation.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-obs-0 error Observation A diagnostic result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    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 A diagnostic result observation in an Australian healthcare context
    Constraints: inv-obs-0, inv-obs-1
    Observation.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Observation.Slices for extension.extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    Observation.category 1..* CodeableConcept Diagnostic service section
    Binding: DiagnosticServiceSectionCodes (preferred)
    Observation.code 1..1 CodeableConcept Diagnostic procedure
    Binding: Evaluation Procedure (example)
    Observation.subject 1..1 Reference(Patient) Who and/or what the observation is about
    Observation.effective[x] 1..1 dateTime, Period, Timing, instant Clinically relevant time/time-period for observation
    Observation.value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Observation.hasMember C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result | AU Base Pathology Result) Individual examinations in a group or study series
    Observation.component
    Observation.component.value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual component result
    Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
    Observation.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    inv-obs-0 error Observation A diagnostic result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()

    Snapshot ViewView

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation A diagnostic result observation in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    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.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Observation.Slices for extension.extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    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 is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.category 1..* CodeableConcept Diagnostic service section
    Binding: DiagnosticServiceSectionCodes (preferred)
    Observation.code This element is included in summaries. 1..1 CodeableConcept Diagnostic procedure
    Binding: Evaluation Procedure (example)
    Observation.subject This element is included in summaries. 1..1 Reference(Patient) Who and/or what the observation is about
    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 is included in summaries. 1..1 Clinically relevant time/time-period for observation
    Observation.effective[x].effectiveDateTime dateTime
    Observation.effective[x].effectivePeriod Period
    Observation.effective[x].effectiveTiming Timing
    Observation.effective[x].effectiveInstant instant
    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 is included in summaries. C 0..1 Actual result
    Observation.value[x].valueQuantity Quantity
    Observation.value[x].valueCodeableConcept CodeableConcept
    Observation.value[x].valueString string
    Observation.value[x].valueBoolean boolean
    Observation.value[x].valueInteger integer
    Observation.value[x].valueRange Range
    Observation.value[x].valueRatio Ratio
    Observation.value[x].valueSampledData SampledData
    Observation.value[x].valueTime time
    Observation.value[x].valueDateTime dateTime
    Observation.value[x].valuePeriod Period
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    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. C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result | AU Base Pathology Result) Individual examinations in a group or study series
    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. C 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 Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
    Observation.code Base example Evaluation Procedure ⏿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
    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()
    inv-obs-0 error Observation A diagnostic result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    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()

     

    Other representations of profile: CSV, Excel, Schematron