Smart Health Checks
0.3.0 - ci-build
Smart Health Checks
0.3.0 - ci-build
Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCPathologyResult | Version: 0.3.0 | |||
| Draft as of 2025-09-05 | Computable Name: SmartHealthChecksPathologyResult | |||
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/. |
||||
This profile sets the minimum expectations for an Observation resource to search and retrieve pathology result information when used within Smart Health Checks.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory  https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | |
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | |
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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], Observation.effective[x]:effectiveDateTime | 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() | |
| 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 pathology 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() | |
| 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() |
This structure is derived from AUCorePathologyResult
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context | |||||||||||
  status |
O | 1..1 | code | registered | preliminary | final | amended +
| ||||||||||
 code |
||||||||||||||
  coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||||
| subject |
O | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| ||||||||||
 Slices for effective[x] |
1..1 | dateTime, Period | Time of specimen collection Slice: Unordered, Open by type:$this | |||||||||||
  effective[x]:effectiveDateTime |
SO | 0..1 | dateTime | Time of specimen collection
| ||||||||||
 Slices for value[x] |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | |||||||||||
  value[x]:valueQuantity |
SO | 0..1 | Quantity | Actual result
| ||||||||||
 value |
SO | 0..1 | decimal | Numerical value (with implicit precision)
| ||||||||||
| system |
SO | 0..1 | uri | System that defines coded unit form
| ||||||||||
 code |
SO | 0..1 | code | Coded form of the unit
| ||||||||||
| Documentation for this format | ||||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context Constraints: obs-6, obs-7, inv-obs-0, 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 | ||||||||||||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
 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 |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||||||||||||||||
| Slices for category |
SO | 1..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available Slice: Unordered, Open by value:coding.system, value:coding.code Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
 category:lab |
1..1 | CodeableConcept | Observation generated by laboratories Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
 coding |
Σ | 1..* | Coding | Code defined by a terminology system | |||||||||||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| category:specificDiscipline |
0..* | CodeableConcept | Specific discipline of pathology Binding: Pathology Diagnostic Service Category (extensible) | ||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | |||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| subject |
SOΣ | 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 | |||||||||||||||||||||
| Slices for effective[x] |
SOΣC | 1..1 | Time of specimen collection Slice: Unordered, Open by type:$this Constraints: au-core-obs-02
| ||||||||||||||||||||||
 effectiveDateTime |
dateTime | ||||||||||||||||||||||||
| effectivePeriod |
Period | ||||||||||||||||||||||||
| effective[x]:effectiveDateTime |
SOΣC | 0..1 | dateTime | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||||||||||||
| performer |
SOΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation
| |||||||||||||||||||||
| Slices for value[x] |
SOΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this
| ||||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||
| valueString |
string | ||||||||||||||||||||||||
| valueBoolean |
boolean | ||||||||||||||||||||||||
| valueInteger |
integer | ||||||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||||||
| valueTime |
time | ||||||||||||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| value |
SOΣ | 0..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||||||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||||||||||||||||||
| unit |
Σ | 0..1 | string | Unit representation | |||||||||||||||||||||
| system |
SOΣC | 0..1 | uri | System that defines coded unit form
| |||||||||||||||||||||
| code |
SOΣ | 0..1 | code | Coded form of the unit
| |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| |||||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | ||||||||||||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||||||||||||
| specimen |
SO | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | ||||||||||||||||||||||
| referenceRange |
SOC | 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 |
SOC | 0..1 | SimpleQuantity | Low Range, if relevant
| |||||||||||||||||||||
| high |
SOC | 0..1 | SimpleQuantity | High Range, if relevant
| |||||||||||||||||||||
| type |
SO | 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 |
SO | 0..1 | string | Text based reference range in an observation
| |||||||||||||||||||||
| hasMember |
SOΣC | 0..* | Reference(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 |
SOΣC | 0..* | BackboneElement | Individual tests in a group or panel 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 |
SOΣ | 1..1 | CodeableConcept | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||||
 value[x] |
SOΣ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 |
SOC | 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 | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | ||||
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsFrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | ||||
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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], Observation.effective[x]:effectiveDateTime | 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() | |
| 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 pathology 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() | |
| 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() |
This structure is derived from AUCorePathologyResult
Summary
Must-Support: 6 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context Constraints: obs-6, obs-7, inv-obs-0, au-core-obs-01 | |||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| status |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||||||||||||||||
| Slices for category |
SO | 1..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available Slice: Unordered, Open by value:coding.system, value:coding.code Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| category:lab |
1..1 | CodeableConcept | Observation generated by laboratories Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||||||||||||
 coding |
Σ | 1..* | Coding | Code defined by a terminology system | |||||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||||||||||||||
| category:specificDiscipline |
0..* | CodeableConcept | Specific discipline of pathology Binding: Pathology Diagnostic Service Category (extensible) | ||||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| |||||||||||||||||||||
| Slices for effective[x] |
SOΣC | 1..1 | Time of specimen collection Slice: Unordered, Open by type:$this Constraints: au-core-obs-02
| ||||||||||||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||||||||||||
| effectivePeriod |
Period | ||||||||||||||||||||||||
| effective[x]:effectiveDateTime |
SOΣC | 0..1 | dateTime | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||||
| performer |
SOΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation
| |||||||||||||||||||||
| Slices for value[x] |
SOΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this
| ||||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||
| valueString |
string | ||||||||||||||||||||||||
| valueBoolean |
boolean | ||||||||||||||||||||||||
| valueInteger |
integer | ||||||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||||||
| valueTime |
time | ||||||||||||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| |||||||||||||||||||||
| value |
SOΣ | 0..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||||||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||||||||||||||||||
| system |
SOΣC | 0..1 | uri | System that defines coded unit form
| |||||||||||||||||||||
| code |
SOΣ | 0..1 | code | Coded form of the unit
| |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| |||||||||||||||||||||
| specimen |
SO | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||||||||||||||
| referenceRange |
SOC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| |||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| low |
SOC | 0..1 | SimpleQuantity | Low Range, if relevant
| |||||||||||||||||||||
| high |
SOC | 0..1 | SimpleQuantity | High Range, if relevant
| |||||||||||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| |||||||||||||||||||||
| text |
SO | 0..1 | string | Text based reference range in an observation
| |||||||||||||||||||||
| hasMember |
SOΣC | 0..* | Reference(AU Core Pathology Result Observation) | Individual observations in a group, study, or panel
| |||||||||||||||||||||
| component |
SOΣC | 0..* | BackboneElement | Individual tests in a group or panel Constraints: au-core-obs-03
| |||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||||
| value[x] |
SOΣ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 |
SOC | 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 | Conformance | ValueSet | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | |
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | |
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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], Observation.effective[x]:effectiveDateTime | 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() | |
| 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 pathology 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() | |
| 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() |
Differential View
This structure is derived from AUCorePathologyResult
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context | |||||||||||
| status |
O | 1..1 | code | registered | preliminary | final | amended +
| ||||||||||
| code |
||||||||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||||
| subject |
O | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about
| ||||||||||
| Slices for effective[x] |
1..1 | dateTime, Period | Time of specimen collection Slice: Unordered, Open by type:$this | |||||||||||
| effective[x]:effectiveDateTime |
SO | 0..1 | dateTime | Time of specimen collection
| ||||||||||
| Slices for value[x] |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | |||||||||||
| value[x]:valueQuantity |
SO | 0..1 | Quantity | Actual result
| ||||||||||
| value |
SO | 0..1 | decimal | Numerical value (with implicit precision)
| ||||||||||
| system |
SO | 0..1 | uri | System that defines coded unit form
| ||||||||||
| code |
SO | 0..1 | code | Coded form of the unit
| ||||||||||
| Documentation for this format | ||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context Constraints: obs-6, obs-7, inv-obs-0, 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 | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||
| 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 |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
| |||||||||||||||||||||
| Slices for category |
SO | 1..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available Slice: Unordered, Open by value:coding.system, value:coding.code Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| |||||||||||||||||||||
| category:lab |
1..1 | CodeableConcept | Observation generated by laboratories Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| coding |
Σ | 1..* | Coding | Code defined by a terminology system | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| category:specificDiscipline |
0..* | CodeableConcept | Specific discipline of pathology Binding: Pathology Diagnostic Service Category (extensible) | ||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | |||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| subject |
SOΣ | 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 | |||||||||||||||||||||
| Slices for effective[x] |
SOΣC | 1..1 | Time of specimen collection Slice: Unordered, Open by type:$this Constraints: au-core-obs-02
| ||||||||||||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||||||||||||
| effectivePeriod |
Period | ||||||||||||||||||||||||
| effective[x]:effectiveDateTime |
SOΣC | 0..1 | dateTime | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||||||||||||
| performer |
SOΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation
| |||||||||||||||||||||
| Slices for value[x] |
SOΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this
| ||||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||
| valueString |
string | ||||||||||||||||||||||||
| valueBoolean |
boolean | ||||||||||||||||||||||||
| valueInteger |
integer | ||||||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||||||
| valueTime |
time | ||||||||||||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| value |
SOΣ | 0..1 | decimal | Numerical value (with implicit precision)
| |||||||||||||||||||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||||||||||||||||||
| unit |
Σ | 0..1 | string | Unit representation | |||||||||||||||||||||
| system |
SOΣC | 0..1 | uri | System that defines coded unit form
| |||||||||||||||||||||
| code |
SOΣ | 0..1 | code | Coded form of the unit
| |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| |||||||||||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| |||||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | ||||||||||||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||||||||||||
| specimen |
SO | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | ||||||||||||||||||||||
| referenceRange |
SOC | 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 |
SOC | 0..1 | SimpleQuantity | Low Range, if relevant
| |||||||||||||||||||||
| high |
SOC | 0..1 | SimpleQuantity | High Range, if relevant
| |||||||||||||||||||||
| type |
SO | 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 |
SO | 0..1 | string | Text based reference range in an observation
| |||||||||||||||||||||
| hasMember |
SOΣC | 0..* | Reference(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 |
SOΣC | 0..* | BackboneElement | Individual tests in a group or panel 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 |
SOΣ | 1..1 | CodeableConcept | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||||
| value[x] |
SOΣ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 |
SOC | 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 | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1From the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | ||||
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsFrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | ||||
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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], Observation.effective[x]:effectiveDateTime | 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() | |
| 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 pathology 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() | |
| 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() |
This structure is derived from AUCorePathologyResult
Summary
Must-Support: 6 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron