AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-diagnosticresult-path | Version: 1.0.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUPSPathologyResult | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an Observation resource that represents a pathology result associated with a patient in the context of a patient summary in an Australian context. It is based on the AU Core Pathology Result Observation profile, and applies the additional requirements from Observation Results - Laboratory/Pathology (IPS).
See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.
The additional obligation on Observation.effectiveDateTime for AU PS Producer is SHOULD:able-to-populate. This obligation is in addition to the obligation of SHALL:populate-if-known. There is no additional obligation for AU PS Consumer, the obligations of SHALL:handle and SHOULD:display apply. This additional obligation is present in the underlying structure but due to a tooling limitation is not currently rendered in the profile view. See Zulip discussion for more information.
There is a current tool limitation that prevents the Observation.specimen element referencing the intended target profile: Specimen (IPS).
Examples for this Profile: Bundle/aups-gpvisit-retrieval and Bundle/aups-referral-endoconsult-autogen
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context This profile also complies with the profile Observation Results - Laboratory/Pathology (IPS) 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 |
1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| |||||||||||||||||||
  Slices for category |
1..* | CodeableConceptIPS | 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
   category:lab |
1..1 | CodeableConceptIPS | 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..* | CodeableConceptIPS | Specific discipline of pathology Binding: Pathology Diagnostic Service Category  (extensible)
| |||||||||||||||||||
| code |
1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
 subject |
1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| |||||||||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
 effective[x] |
C | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| performer |
1..* | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who is responsible for the observation
| |||||||||||||||||||
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||||||||||||||
 valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConceptIPS | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| |||||||||||||||||||
| specimen |
0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| type |
0..1 | CodeableConceptIPS | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| |||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation
| |||||||||||||||||||
| hasMember |
C | 0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||||||||||||||
 component |
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 |
1..1 | CodeableConceptIPS | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| au-core-obs-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| 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()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from AUCorePathologyResult
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Results Status Codes - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.value[x]:valueCodeableConcept | Base | preferred | Results Coded Values Laboratory/Pathology - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context This profile also complies with the profile Observation Results - Laboratory/Pathology (IPS) 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 |
1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| |||||||||||||||||||
| Slices for category |
1..* | CodeableConceptIPS | 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| category:lab |
1..1 | CodeableConceptIPS | 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..* | CodeableConceptIPS | 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 |
1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||||||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||||||||
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||||||||||||||
| effective[x] |
C | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||||||||||||||||
| performer |
1..* | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who is responsible for the observation
| |||||||||||||||||||
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConceptIPS | 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 |
0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| type |
0..1 | CodeableConceptIPS | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| |||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation
| |||||||||||||||||||
| hasMember |
C | 0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||||||||||||||
| derivedFrom |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||||||||||||||||
| component |
C | 0..* | BackboneElement | 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 |
1..1 | CodeableConceptIPS | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | Results Status Codes - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:lab | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:specificDiscipline | Base | extensible |
Pathology Diagnostic Service Category
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.code | Base | extensible |
RCPA SPIA Pathology Reporting
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueCodeableConcept | Base | preferred | Results Coded Values Laboratory/Pathology - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible |
RCPA SPIA Pathology Reporting
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| au-core-obs-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| 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()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from AUCorePathologyResult
Summary
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context This profile also complies with the profile Observation Results - Laboratory/Pathology (IPS) 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 |
1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| |||||||||||||||||||
| Slices for category |
1..* | CodeableConceptIPS | 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| category:lab |
1..1 | CodeableConceptIPS | 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..* | CodeableConceptIPS | Specific discipline of pathology Binding: Pathology Diagnostic Service Category (extensible)
| |||||||||||||||||||
| code |
1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| |||||||||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| effective[x] |
C | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| performer |
1..* | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who is responsible for the observation
| |||||||||||||||||||
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConceptIPS | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| |||||||||||||||||||
| specimen |
0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| type |
0..1 | CodeableConceptIPS | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| |||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation
| |||||||||||||||||||
| hasMember |
C | 0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||||||||||||||
| component |
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 |
1..1 | CodeableConceptIPS | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Results Status Codes - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:lab | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:specificDiscipline | Base | extensible |
Pathology Diagnostic Service Category
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.code | Base | extensible |
RCPA SPIA Pathology Reporting
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.value[x]:valueCodeableConcept | Base | preferred | Results Coded Values Laboratory/Pathology - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible |
RCPA SPIA Pathology Reporting
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| au-core-obs-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| 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()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.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 This profile also complies with the profile Observation Results - Laboratory/Pathology (IPS) | |||||||||
 status |
1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| |||||||||
| category |
1..* | CodeableConceptIPS | Classification of the service requested as laboratory + more specific discipline where available
| |||||||||
| Slices for category |
Content/Rules for all slices | |||||||||||
| category:lab |
1..1 | CodeableConceptIPS | Observation generated by laboratories
| |||||||||
| category:specificDiscipline |
0..* | CodeableConceptIPS | Specific discipline of pathology
| |||||||||
| code |
1..1 | CodeableConceptIPS | Pathology test or test group
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| |||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| effective[x] |
1..1 | Time of specimen collection
| ||||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| performer |
1..* | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who is responsible for the observation
| |||||||||
| 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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| |||||||||
| dataAbsentReason |
0..1 | CodeableConceptIPS | Why the result is missing
| |||||||||
| interpretation |
0..* | CodeableConceptIPS | High, low, normal, etc.
| |||||||||
| specimen |
0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||
| referenceRange |
0..* | BackboneElement | Provides guide for interpretation
| |||||||||
| low |
0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant
| |||||||||
| high |
0..1 | SimpleQuantity(4.0.1) | High Range, if relevant
| |||||||||
| type |
0..1 | CodeableConceptIPS | Reference range qualifier
| |||||||||
| text |
0..1 | string | Text based reference range in an observation
| |||||||||
| hasMember |
0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| |||||||||
| component |
0..* | BackboneElement | Individual tests in a group or panel
| |||||||||
| code |
1..1 | CodeableConceptIPS | Individual pathology test
| |||||||||
| value[x] |
0..1 | Actual component result
| ||||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| dataAbsentReason |
0..1 | CodeableConceptIPS | Why the component result is missing
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Results Status Codes - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.value[x]:valueCodeableConcept | Base | preferred | Results Coded Values Laboratory/Pathology - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AUCorePathologyResult | A pathology test result in an Australian healthcare context This profile also complies with the profile Observation Results - Laboratory/Pathology (IPS) 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 |
1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| |||||||||||||||||||
| Slices for category |
1..* | CodeableConceptIPS | 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| category:lab |
1..1 | CodeableConceptIPS | 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..* | CodeableConceptIPS | 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 |
1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||||||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||||||||||||||||
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||||||||||||||
| effective[x] |
C | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||||||||||||||||
| performer |
1..* | Reference(AU PS Practitioner | AU PS PractitionerRole | AU PS Organization | AU PS Patient | AU PS RelatedPerson) | Who is responsible for the observation
| |||||||||||||||||||
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConceptIPS | 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 |
0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| |||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1
| ||||||||||||||||||
| type |
0..1 | CodeableConceptIPS | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| |||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation
| |||||||||||||||||||
| hasMember |
C | 0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||||||||||||||
| derivedFrom |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||||||||||||||||
| component |
C | 0..* | BackboneElement | 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 |
1..1 | CodeableConceptIPS | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| |||||||||||||||||||
| value[x] |
C | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConceptIPS | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | Results Status Codes - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:lab | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:specificDiscipline | Base | extensible |
Pathology Diagnostic Service Category
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.code | Base | extensible |
RCPA SPIA Pathology Reporting
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueCodeableConcept | Base | preferred | Results Coded Values Laboratory/Pathology - IPS | 📦2.0.1 | International Patient Summary Implementation Guide vnull |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible |
RCPA SPIA Pathology Reporting
|
⏿1.0.0 | tx.hl7.org.au |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present |
(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
|
| au-core-obs-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present |
(($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists()))
|
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason |
value.exists() or dataAbsentReason.exists()
|
| 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()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from AUCorePathologyResult
Summary
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#1.0.1-ci-build based on FHIR 4.0.1. Generated 2026-10-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change