AU Core Implementation Guide
0.2.1-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Diagnostic Result Observation

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult Version: 0.2.1-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreDiagnosticResult

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 diagnostic results associated with a patient. It is based on the AU Base Diagnostic Result profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for diagnostic results for a patient
  • Query for category of diagnostic results (e.g. all cardiology results)
  • Record or update a diagnostic result for a patient

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

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.
  • The observations MAY have additional codes that translate or map to the Observation code or category codes. For example:
    • providing a local code
    • providing a more specific code
  • The use of coding can vary significantly across systems, client applications need to understand that they may encounter codes they do not recognise and be prepared to handle those resources appropriately. Servers SHOULD populate Observation.code.text and/or Observation.code.coding.display so that client applications can at least display the observation even if the client application does not recognise the code supplied.
  • The Observation resource can represent a result using one or both of a single value with Observation.value, or set of results using either Observation.component.value or Observation.hasMember.
    • Although all are marked as must support, servers are not required to support all choices, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
  • Observation.identifier may contain the same identifier as in the order or report connecting the resources that are related to a single request fulfilment workflow
  • Source system identifiers that identify the business process (order ids and reporting identifiers) MAY be included as AU Local Order Identifier and AU Local Report Identifier to support workflow and deduplication of Observation resources.
    • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1codepreliminary | final | amended +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required)
... category S1..*CodeableConceptClassification of type of observation
... subject S1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SC1..1dateTime, Period, Timing, instantClinically relevant time/time-period for observation
au-core-obs-01: Date shall be at least to day
... performer S0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual result
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
... note S0..*AnnotationComments about the observation
... bodySite SC0..1CodeableConceptObserved body part
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... method S0..1CodeableConceptHow it was done
... referenceRange S0..*BackboneElementProvides guide for interpretation
.... low S0..1SimpleQuantityLow Range, if relevant
.... high S0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
.... text S0..1stringText based reference range in an observation
... hasMember S0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... component SC0..*BackboneElementComponent results
au-core-obs-06: The component shall at least have a value or a data absent reason
.... code S1..1CodeableConceptType of component observation (code / type)
.... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf a coded body site is provided, at least one code shall be from SNOMED CT
: coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... category S1..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SΣC1..1Clinically relevant time/time-period for observation
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note S0..*AnnotationComments about the observation
... bodySite SC0..1CodeableConceptObserved body part
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... referenceRange SC0..*BackboneElementProvides guide for interpretation
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... text S0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... component SΣC0..*BackboneElementComponent results
au-core-obs-06: The component shall at least have a value or a data absent reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf a coded body site is provided, at least one code shall be from SNOMED CT
: coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1codepreliminary | final | amended +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required)
... category S1..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... focus ΣTU0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣC1..1Clinically relevant time/time-period for observation
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note S0..*AnnotationComments about the observation
... bodySite SC0..1CodeableConceptObserved body part
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SC0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣC0..*BackboneElementComponent results
au-core-obs-06: The component shall at least have a value or a data absent reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.hasMember.typeextensibleResourceType
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf a coded body site is provided, at least one code shall be from SNOMED CT
: coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1codepreliminary | final | amended +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required)
... category S1..*CodeableConceptClassification of type of observation
... subject S1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SC1..1dateTime, Period, Timing, instantClinically relevant time/time-period for observation
au-core-obs-01: Date shall be at least to day
... performer S0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual result
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
... note S0..*AnnotationComments about the observation
... bodySite SC0..1CodeableConceptObserved body part
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... method S0..1CodeableConceptHow it was done
... referenceRange S0..*BackboneElementProvides guide for interpretation
.... low S0..1SimpleQuantityLow Range, if relevant
.... high S0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
.... text S0..1stringText based reference range in an observation
... hasMember S0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... component SC0..*BackboneElementComponent results
au-core-obs-06: The component shall at least have a value or a data absent reason
.... code S1..1CodeableConceptType of component observation (code / type)
.... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf a coded body site is provided, at least one code shall be from SNOMED CT
: coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... category S1..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SΣC1..1Clinically relevant time/time-period for observation
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note S0..*AnnotationComments about the observation
... bodySite SC0..1CodeableConceptObserved body part
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... referenceRange SC0..*BackboneElementProvides guide for interpretation
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... text S0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... component SΣC0..*BackboneElementComponent results
au-core-obs-06: The component shall at least have a value or a data absent reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf a coded body site is provided, at least one code shall be from SNOMED CT
: coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1codepreliminary | final | amended +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required)
... category S1..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... focus ΣTU0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣC1..1Clinically relevant time/time-period for observation
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note S0..*AnnotationComments about the observation
... bodySite SC0..1CodeableConceptObserved body part
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SC0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣC0..*BackboneElementComponent results
au-core-obs-06: The component shall at least have a value or a data absent reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.hasMember.typeextensibleResourceType
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-04errorObservation.bodySiteIf a coded body site is provided, at least one code shall be from SNOMED CT
: coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described 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 SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
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.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
date MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters:

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

  1. SHALL support searching using the patient search parameter:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Observation?patient={Type/}[id] or optionally GET [base]/Observation?patient.identifier=[system|][code]

    Example:

    1. GET [base]/Observation?patient=5678
    2. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952&_revinclude=Provenance:target
    4. 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. SHALL support searching using the combination of the patient and category search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • 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|survey

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

  3. SHALL support searching using the combination of the patient and code search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • 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|89240007,http://loinc.org|14683-7,http://loinc.org|85354-9

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

  4. SHALL support searching using the combination of the patient and category and date search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • 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]]&...)

    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|survey&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)

Optional Search Parameters:

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

  1. SHOULD support searching using the combination of the patient and category and status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • 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|survey&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)

  2. SHOULD support searching using the combination of the patient and code and date search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • 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]]&...)

    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|89240007,http://loinc.org|14683-7,http://loinc.org|85354-9&date=ge2020-01-01T00:00:00Z
    2. GET [base]/Observation?patient.identifier=http://example.org/fhir/mrn|12345&code=http://snomed.info/sct|89240007,http://loinc.org|14683-7,http://loinc.org|85354-9&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). SHOULD support search by multiple codes. (how to search by reference and how to search by token and how to search by date)