AU Core Implementation Guide
3.0.0-ci-build - CI Build
AU Core Implementation Guide
3.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult | Version: 3.0.0-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | 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 specialist or other diagnostic (non-imaging or non-pathology) results for 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.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
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 workflow.Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 2.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | AUBaseDiagnosticResult | A diagnostic result observation in an Australian healthcare context Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1, au-core-obs-01 | ||||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||
  Slices for extension |
Content/Rules for all slices | |||||||||
   extension:bodyStructure |
C | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | ||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||
 category |
1..* | CodeableConcept | Diagnostic service section Binding: DiagnosticServiceSectionCodes (preferred)
| |||||||
| code |
1..1 | CodeableConcept | Diagnostic procedure Binding: Evaluation Procedure  (example)
| |||||||
 subject |
1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||
 effective[x] |
C | 1..1 | Clinically relevant time/time-period for observation Constraints: au-core-obs-02
| |||||||
| effectiveDateTime |
dateTime | |||||||||
| effectivePeriod |
Period | |||||||||
| effectiveTiming |
Timing | |||||||||
 effectiveInstant |
instant | |||||||||
| performer |
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] |
C | 0..1 | Actual result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (extensible)Constraints: au-core-obs-04
| ||||||
| hasMember |
C | 0..* | Reference(AU Core Diagnostic Result Observation | AU Base Diagnostic Imaging Result | AU Core Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||
 component |
C | 0..* | BackboneElement | Component results Constraints: au-core-obs-03
| ||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| |||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| Documentation for this format | ||||||||||
| 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. |
| Observation.bodySite | Base | extensible |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | 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-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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 AUBaseDiagnosticResult
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.bodySite | Base | extensible |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | 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-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUBaseDiagnosticResult | A diagnostic result observation in an Australian healthcare context Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1, au-core-obs-01 | ||||||
| id |
0..1 | id | Logical id of this artifact | |||||||
| meta |
0..1 | Meta | Metadata about the resource | |||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:bodyStructure |
C | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | ||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||
| identifier |
0..* | Identifier | Business Identifier for observation | |||||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||
| partOf |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||
| category |
1..* | CodeableConcept | Diagnostic service section Binding: DiagnosticServiceSectionCodes (preferred)
| |||||||
| code |
1..1 | CodeableConcept | Diagnostic procedure Binding: Evaluation Procedure (example)
| |||||||
| subject |
1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||
| effective[x] |
C | 1..1 | Clinically relevant time/time-period for observation Constraints: au-core-obs-02
| |||||||
| effectiveDateTime |
dateTime | |||||||||
| effectivePeriod |
Period | |||||||||
| effectiveTiming |
Timing | |||||||||
| effectiveInstant |
instant | |||||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||||
| performer |
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] |
C | 0..1 | Actual result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||
| note |
0..* | Annotation | Comments about the observation | |||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (extensible)Constraints: au-core-obs-04
| ||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||
| text |
0..1 | string | Text based reference range in an observation | |||||||
| hasMember |
C | 0..* | Reference(AU Core Diagnostic Result Observation | AU Base Diagnostic Imaging Result | AU Core Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||
| derivedFrom |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||||
| component |
C | 0..* | BackboneElement | Component results Constraints: au-core-obs-03
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| |||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||
 referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||
| Documentation for this format | ||||||||||
| 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 | extensible |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | 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-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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()
|
This structure is derived from AUBaseDiagnosticResult
Summary
Mandatory: 3 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUBaseDiagnosticResult | A diagnostic result observation in an Australian healthcare context Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1, au-core-obs-01 | ||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:bodyStructure |
C | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | ||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||
| category |
1..* | CodeableConcept | Diagnostic service section Binding: DiagnosticServiceSectionCodes (preferred)
| |||||||
| code |
1..1 | CodeableConcept | Diagnostic procedure Binding: Evaluation Procedure (example)
| |||||||
| subject |
1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||
| effective[x] |
C | 1..1 | Clinically relevant time/time-period for observation Constraints: au-core-obs-02
| |||||||
| effectiveDateTime |
dateTime | |||||||||
| effectivePeriod |
Period | |||||||||
| effectiveTiming |
Timing | |||||||||
| effectiveInstant |
instant | |||||||||
| performer |
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] |
C | 0..1 | Actual result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (extensible)Constraints: au-core-obs-04
| ||||||
| hasMember |
C | 0..* | Reference(AU Core Diagnostic Result Observation | AU Base Diagnostic Imaging Result | AU Core Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||
| component |
C | 0..* | BackboneElement | Component results Constraints: au-core-obs-03
| ||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| |||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| Documentation for this format | ||||||||||
| 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. |
| Observation.bodySite | Base | extensible |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | 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-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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 AUBaseDiagnosticResult
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUBaseDiagnosticResult | A diagnostic result observation in an Australian healthcare context Constraints: au-core-obs-01 | ||||||
| status |
1..1 | code | registered | preliminary | final | amended +
| |||||||
| category |
1..* | CodeableConcept | Diagnostic service section
| |||||||
| code |
1..1 | CodeableConcept | Diagnostic procedure
| |||||||
| subject |
1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||
| effective[x] |
C | 1..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation Constraints: au-core-obs-02
| ||||||
| performer |
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] |
C | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result
| ||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing
| ||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (extensible)Constraints: au-core-obs-04
| ||||||
| hasMember |
0..* | Reference(AU Core Diagnostic Result Observation | AU Base Diagnostic Imaging Result | AU Core Pathology Result Observation) | Individual observations in a group, study, or panel
| |||||||
| component |
C | 0..* | BackboneElement | Component results Constraints: au-core-obs-03
| ||||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type)
| |||||||
| value[x] |
C | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result
| ||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing
| ||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.bodySite | Base | extensible |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | 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-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUBaseDiagnosticResult | A diagnostic result observation in an Australian healthcare context Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1, au-core-obs-01 | ||||||
| id |
0..1 | id | Logical id of this artifact | |||||||
| meta |
0..1 | Meta | Metadata about the resource | |||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:bodyStructure |
C | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | ||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||
| identifier |
0..* | Identifier | Business Identifier for observation | |||||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||||
| partOf |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||
| category |
1..* | CodeableConcept | Diagnostic service section Binding: DiagnosticServiceSectionCodes (preferred)
| |||||||
| code |
1..1 | CodeableConcept | Diagnostic procedure Binding: Evaluation Procedure (example)
| |||||||
| subject |
1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||
| effective[x] |
C | 1..1 | Clinically relevant time/time-period for observation Constraints: au-core-obs-02
| |||||||
| effectiveDateTime |
dateTime | |||||||||
| effectivePeriod |
Period | |||||||||
| effectiveTiming |
Timing | |||||||||
| effectiveInstant |
instant | |||||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||||
| performer |
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] |
C | 0..1 | Actual result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||
| note |
0..* | Annotation | Comments about the observation | |||||||
| bodySite |
C | 0..1 | CodeableConcept | Observed body part Binding: Body Site (extensible)Constraints: au-core-obs-04
| ||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||
| text |
0..1 | string | Text based reference range in an observation | |||||||
| hasMember |
C | 0..* | Reference(AU Core Diagnostic Result Observation | AU Base Diagnostic Imaging Result | AU Core Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||
| derivedFrom |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||||
| component |
C | 0..* | BackboneElement | Component results Constraints: au-core-obs-03
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
| |||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||
| valueQuantity |
Quantity | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| valueString |
string | |||||||||
| valueBoolean |
boolean | |||||||||
| valueInteger |
integer | |||||||||
| valueRange |
Range | |||||||||
| valueRatio |
Ratio | |||||||||
| valueSampledData |
SampledData | |||||||||
| valueTime |
time | |||||||||
| valueDateTime |
dateTime | |||||||||
| valuePeriod |
Period | |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||
| Documentation for this format | ||||||||||
| 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 | extensible |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | 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-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one coding shall be from SNOMED CT |
coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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()
|
This structure is derived from AUBaseDiagnosticResult
Summary
Mandatory: 3 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Maturity: 2
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+category | SHALL | reference+token |
|
| patient+category+date | SHALL | reference+token+date |
|
| patient+code | SHALL | reference+token |
|
| patient+category+status | SHOULD | reference+token+token |
|
| patient+code+date | SHOULD | reference+token+date |
|
| patient | MAY | reference |
The requester SHALL provide at least an id value and MAY provide both the type and id values. The responder SHALL support both. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
| category | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support search using the category code defined in this profile. The responder SHALL support search using the category code defined in this profile. |
| code | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support search using the LOINC codes defined in this profile. The responder SHALL support search using the LOINC codes defined in this profile. The requester SHALL support multipleOr. The responder SHALL support multipleOr. |
| date | MAY | date |
A requester SHALL provide a value precise to the second + time offset. A responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators gt, lt, ge, le. The responder SHALL support these search comparators gt, lt, ge, le.The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le. The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le. |
| status | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support multipleOr. The responder SHALL support multipleOr. |
The following search parameters and search parameter combinations SHALL be supported:
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 category (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) (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]&...), and if multipleAnd is supported, SHALL support the search comparators gt,lt,ge,leGET [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:
SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
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 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]&...), and if multipleAnd is supported, SHALL support the search comparators gt,lt,ge,leGET [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) (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#3.0.0-ci-build based on FHIR 4.0.1. Generated 2026-10-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change