AU Core Implementation Guide
0.4.1-preview - Preview
AU Core Implementation Guide
0.4.1-preview - Preview
This page is part of the AU Core (v0.4.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult | Version: 0.4.1-preview | |||
| Standards status: Draft | Maturity Level: 1 | 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.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
finalConformance 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.
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.Observation.code.text and/or Observation.code.coding.display so that the requester can at least display the observation even if the requester does not recognise the code supplied.Observation.value, or can represent a set of results using either Observation.component.value or Observation.hasMember.
Observation.value, Observation.component.value, Observation.hasMember)Observation.identifier may contain the same identifier as in the order or report connecting the resources that are related to a single request fulfilment workflowUsage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | Observation | Measurements 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 |
SO | 0..* | Identifier | Business Identifier for observation
| ||||||
| status |
SO | 1..1 | code | preliminary | final | amended +
| ||||||
| category |
SO | 1..* | CodeableConcept | Classification of type of observation
| ||||||
| code |
SO | 1..1 | CodeableConcept | Type of observation (code / type)
| ||||||
 subject |
SO | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| ||||||
| effective[x] |
SOC | 1..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation au-core-obs-01: Date shall be at least to day
| ||||||
| performer |
SO | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Base Related Person) | Who is responsible for the observation
| ||||||
| value[x] |
SOC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result
| ||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing
| ||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc.
| ||||||
| note |
SO | 0..* | Annotation | Comments about the observation
| ||||||
| bodySite |
SOC | 0..1 | CodeableConcept | Observed body part Binding: Body Site  (extensible)au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT
| ||||||
| method |
SO | 0..1 | CodeableConcept | How it was done
| ||||||
 referenceRange |
SO | 0..* | BackboneElement | Provides guide for interpretation
| ||||||
 low |
SO | 0..1 | SimpleQuantity | Low Range, if relevant
| ||||||
| high |
SO | 0..1 | SimpleQuantity | High Range, if relevant
| ||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier
| ||||||
 text |
SO | 0..1 | string | Text based reference range in an observation
| ||||||
| hasMember |
SO | 0..* | Reference(AU Core Diagnostic Result Observation | AU Core Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||
| reference |
O | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||
 component |
SOC | 0..* | BackboneElement | Component results au-core-obs-06: The component shall at least have a value or a data absent reason
| ||||||
 code |
SO | 1..1 | CodeableConcept | Type of component observation (code / type)
| ||||||
| value[x] |
SOC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result
| ||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 | |
| au-core-obs-04 | error | Observation.bodySite | If 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-05 | error | Observation | If 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-06 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |
Other representations of profile: CSV, Excel, Schematron
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 | SHALL | reference |
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder 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 requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder 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 requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
| 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. |
| 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. |
| 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 following search parameters and search parameter combinations SHALL be supported:
patient search parameter:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Observation?patient={Type/}[id] or optionally GET [base]/Observation?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient (how to search by reference and how to search by token)
patient and category search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Observation?patient={Type/}[id]&category={system|}[code]
Example:
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)
patient and code search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])code (e.g.code={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}
Example:
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)
patient and category and date search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])date comparators: gt,lt,ge,ledate (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:
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)
The following search parameters and search parameter combinations SHOULD be supported:
patient and category and status search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])status (e.g.status={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}
Example:
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)
patient and code and date search parameters:
patient.identifier (e.g. patient.identifier=[system|][code]code (e.g.code={system|}[code],{system|}[code],...)date comparators: gt,lt,ge,ledate (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:
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)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.4.1-preview based on FHIR 4.0.1. Generated 2024-07-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change