AU Core Implementation Guide
0.3.0-ballot - R1 Australia flag

This page is part of the AU Core (v0.3.0-ballot: AU Core R1 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Pathology Result Observation

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult-path Version: 0.3.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: AUCorePathologyResult

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

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for pathology results for a patient
  • Query for category of pathology results (e.g. all chemistry)
  • Record or update pathology results belonging to a patient

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

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

Profile specific implementation guidance

  • Observation.category provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.
  • The observations MAY have additional codes that translate or map to the Observation code or category codes. For example:
    • providing a local code
    • providing a more specific code
  • The use of coding can vary significantly across systems, client applications need to understand that they may encounter codes they do not recognise and be prepared to handle those resources appropriately. Servers SHOULD populate Observation.code.text and/or Observation.code.coding.display so that client applications can at least display the observation even if the client application does not recognise the code supplied.
  • The Observation resource can represent a result using one or both of a single value with Observation.value, or set of results using either Observation.component.value or Observation.hasMember.
    • Although all are marked as must support, servers are not required to support all choices, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
  • Observation.identifier may contain the same identifier as in the order or report connecting the resources that are related to a single request fulfilment workflow
  • Unless the specimen is explicitly clear in Observation.code, specimen information SHOULD be made available in Observation.specimen.
  • Source system identifiers that identify the business process (order ids and reporting identifiers) MAY be included as AU Local Order Identifier and AU Local Report Identifier to support workflow and deduplication of Observation resources.
    • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBasePathologyResult

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUBasePathologyResultA pathology test result in an Australian healthcare context
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1codepreliminary | final | amended +
Binding: ObservationStatus Result Available . (required)
... category S1..*CodeableConceptClassification of the service requested as laboratory + more specific discipline where available
... subject S1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SC1..1dateTime, PeriodTime of specimen collection
au-core-obs-01: Date shall be at least to day
... performer S0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who is responsible for the observation
... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual result
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
... note S0..*AnnotationComments about the observation
... method S0..1CodeableConceptHow it was done
... specimen S0..1Reference(AU Base Specimen)Specimen used for this observation
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... referenceRange S0..*BackboneElementProvides guide for interpretation
.... low S0..1SimpleQuantityLow Range, if relevant
.... high S0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
.... text S0..1stringText based reference range in an observation
... hasMember S0..*Reference(AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... component SC0..*BackboneElementIndividual tests in a group or panel
au-core-obs-06: The component shall at least have a value or a data absent reason
.... code S1..1CodeableConceptIndividual pathology test
Binding: RCPA SPIA Pathology Reporting . (extensible)
.... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.statusrequiredObservationStatusResultAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.component.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUBasePathologyResultA pathology test result in an Australian healthcare context
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-obs-0: A pathology result shall at least have value or data absent reason or a child observation with a value or data absent reason
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... Slices for category S1..*CodeableConceptClassification 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..1CodeableConceptObservation generated by laboratories
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
.... category:specificDiscipline 0..*CodeableConceptSpecific discipline of pathology
Binding: Pathology Diagnostic Service Category . (extensible)
... code SΣ1..1CodeableConceptPathology test or test group
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SΣC1..1Time of specimen collection
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note S0..*AnnotationComments about the observation
... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen S0..1Reference(AU Base Specimen)Specimen used for this observation
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... referenceRange SC0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... text S0..1stringText based reference range in an observation
... hasMember SΣC0..*Reference(AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... component SΣC0..*BackboneElementIndividual tests in a group or panel
au-core-obs-06: The component shall at least have a value or a data absent reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptIndividual pathology test
Binding: RCPA SPIA Pathology Reporting . (extensible)
.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredObservationStatusResultAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:labpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:specificDisciplineextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
Observation.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.component.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-obs-0errorObservationA 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-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUBasePathologyResultA pathology test result in an Australian healthcare context
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-obs-0: A pathology result shall at least have value or data absent reason or a child observation with a value or data absent reason
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1codepreliminary | final | amended +
Binding: ObservationStatus Result Available . (required)
... Slices for category S1..*CodeableConceptClassification 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..1CodeableConceptObservation generated by laboratories
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:specificDiscipline 0..*CodeableConceptSpecific discipline of pathology
Binding: Pathology Diagnostic Service Category . (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptPathology test or test group
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣ1..1Reference(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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣC1..1Time of specimen collection
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note S0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen S0..1Reference(AU Base Specimen)Specimen used for this observation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SC0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


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

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣC0..*BackboneElementIndividual tests in a group or panel
au-core-obs-06: The component shall at least have a value or a data absent reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptIndividual pathology test
Binding: RCPA SPIA Pathology Reporting . (extensible)
.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatusResultAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:labpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:specificDisciplineextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
Observation.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.specimen.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.hasMember.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.component.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-obs-0errorObservationA 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-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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 AUBasePathologyResult

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUBasePathologyResultA pathology test result in an Australian healthcare context
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... identifier S0..*IdentifierBusiness Identifier for observation
... status S1..1codepreliminary | final | amended +
Binding: ObservationStatus Result Available . (required)
... category S1..*CodeableConceptClassification of the service requested as laboratory + more specific discipline where available
... subject S1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SC1..1dateTime, PeriodTime of specimen collection
au-core-obs-01: Date shall be at least to day
... performer S0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who is responsible for the observation
... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual result
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
... note S0..*AnnotationComments about the observation
... method S0..1CodeableConceptHow it was done
... specimen S0..1Reference(AU Base Specimen)Specimen used for this observation
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... referenceRange S0..*BackboneElementProvides guide for interpretation
.... low S0..1SimpleQuantityLow Range, if relevant
.... high S0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
.... text S0..1stringText based reference range in an observation
... hasMember S0..*Reference(AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... component SC0..*BackboneElementIndividual tests in a group or panel
au-core-obs-06: The component shall at least have a value or a data absent reason
.... code S1..1CodeableConceptIndividual pathology test
Binding: RCPA SPIA Pathology Reporting . (extensible)
.... value[x] SC0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.statusrequiredObservationStatusResultAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.component.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUBasePathologyResultA pathology test result in an Australian healthcare context
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-obs-0: A pathology result shall at least have value or data absent reason or a child observation with a value or data absent reason
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... Slices for category S1..*CodeableConceptClassification 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..1CodeableConceptObservation generated by laboratories
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
.... category:specificDiscipline 0..*CodeableConceptSpecific discipline of pathology
Binding: Pathology Diagnostic Service Category . (extensible)
... code SΣ1..1CodeableConceptPathology test or test group
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SΣC1..1Time of specimen collection
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note S0..*AnnotationComments about the observation
... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen S0..1Reference(AU Base Specimen)Specimen used for this observation
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... referenceRange SC0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... text S0..1stringText based reference range in an observation
... hasMember SΣC0..*Reference(AU Core Pathology Result Observation)Individual observations in a group, study, or panel
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... component SΣC0..*BackboneElementIndividual tests in a group or panel
au-core-obs-06: The component shall at least have a value or a data absent reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptIndividual pathology test
Binding: RCPA SPIA Pathology Reporting . (extensible)
.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredObservationStatusResultAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:labpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:specificDisciplineextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
Observation.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.component.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-obs-0errorObservationA 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-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUBasePathologyResultA pathology test result in an Australian healthcare context
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-obs-0: A pathology result shall at least have value or data absent reason or a child observation with a value or data absent reason
au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1codepreliminary | final | amended +
Binding: ObservationStatus Result Available . (required)
... Slices for category S1..*CodeableConceptClassification 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..1CodeableConceptObservation generated by laboratories
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... category:specificDiscipline 0..*CodeableConceptSpecific discipline of pathology
Binding: Pathology Diagnostic Service Category . (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptPathology test or test group
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣ1..1Reference(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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣC1..1Time of specimen collection
au-core-obs-01: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note S0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method S0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen S0..1Reference(AU Base Specimen)Specimen used for this observation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SC0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low SC0..1SimpleQuantityLow Range, if relevant
.... high SC0..1SimpleQuantityHigh Range, if relevant
.... type S0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


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

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣC0..*BackboneElementIndividual tests in a group or panel
au-core-obs-06: The component shall at least have a value or a data absent reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptIndividual pathology test
Binding: RCPA SPIA Pathology Reporting . (extensible)
.... value[x] SΣC0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatusResultAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:labpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:specificDisciplineextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
Observation.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.specimen.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.hasMember.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.component.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
au-core-obs-05errorObservationIf there is no component or hasMember element then at least value or data absent reason shall be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
au-core-obs-06errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-obs-0errorObservationA 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-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+category SHALL reference+token
patient+category+date SHALL reference+token+date
patient+code SHALL reference+token
patient+category+status SHOULD reference+token+token
patient+code+date SHOULD reference+token+date
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
date MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters:

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

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

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

    Example:

    1. GET [base]/Observation?patient=5678
    2. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

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

  2. SHALL support searching using the combination of the patient and category search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory

    Example:

    1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory

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

  3. SHALL support searching using the combination of the patient and code search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=5678&code=http://loinc.org|6690-2,http://loinc.org|789-8

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

  4. SHALL support searching using the combination of the patient and category and date search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&date=ge2020-01-01T00:00:00Z 1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&date=ge2020-01-01T00:00:00Z

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

Optional Search Parameters:

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

  1. SHOULD support searching using the combination of the patient and category and status search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&status=final

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

  2. SHOULD support searching using the combination of the patient and code and date search parameters:
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=5678&code=http://loinc.org|6690-2,http://loinc.org|789-8&date=ge2020-01-01T00:00:00Z
    2. GET [base]/Observation?patient.identifier=http://example.org/fhir/mrn|12345&code=http://loinc.org|6690-2,http://loinc.org|789-8&date=ge2020-01-01T00:00:00Z

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