AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build
AU Patient Summary Implementation Guide
0.5.0-cibuild - 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 0.5.0-cibuild 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: 0.5.0-cibuild | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSPathologyResult | ||
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 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).
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCorePathologyResult
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ips | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ips |
| 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 |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| ||||||||||||||||||
  Slices for category |
SO | 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.
| ||||||||||||||||||
   category:lab |
SO | 1..1 | CodeableConcept | Observation generated by laboratories Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||||||||||||
   coding |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||||||||||||||
 system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||||||||
 code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||||||||
 category:specificDiscipline |
SO | 0..* | CodeableConcept | Specific discipline of pathology Binding: Pathology Diagnostic Service Category  (extensible)
| ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
 subject |
SOΣ | 1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| ||||||||||||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
 effective[x] |
SOΣC | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime S | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| performer |
SOΣ | 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] |
SOΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this
| |||||||||||||||||||
 valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||||||||
| specimen |
SO | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| ||||||||||||||||||
| referenceRange |
SOC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| low |
SOC | 0..1 | SimpleQuantity | Low Range, if relevant
| ||||||||||||||||||
| high |
SOC | 0..1 | SimpleQuantity | High Range, if relevant
| ||||||||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| ||||||||||||||||||
| text |
SO | 0..1 | string | Text based reference range in an observation
| ||||||||||||||||||
| hasMember |
SOΣC | 0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||||||||||||||
 component |
SOΣC | 0..* | BackboneElement | Individual tests in a group or panel Constraints: au-core-obs-03
| ||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
| value[x] |
SOΣC | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ips | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | |
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ips | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | |
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-02 | error | Observation.effective[x] | 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() |
| 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 |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| ||||||||||||||||||
| Slices for category |
SO | 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.
| ||||||||||||||||||
| category:lab |
SO | 1..1 | CodeableConcept | Observation generated by laboratories Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
 coding |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
 text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||||||||||
 category:specificDiscipline |
SO | 0..* | CodeableConcept | Specific discipline of pathology Binding: Pathology Diagnostic Service Category (extensible)
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | ||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
| subject |
SOΣ | 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 |
SOΣ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] |
SOΣC | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime S | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||||||||||||||||
| performer |
SOΣ | 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] |
SOΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||||||||||||||
| specimen |
SO | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| ||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||||||||
| referenceRange |
SOC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| low |
SOC | 0..1 | SimpleQuantity | Low Range, if relevant
| ||||||||||||||||||
| high |
SOC | 0..1 | SimpleQuantity | High Range, if relevant
| ||||||||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| ||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||||||||
| text |
SO | 0..1 | string | Text based reference range in an observation
| ||||||||||||||||||
| hasMember |
SOΣC | 0..* | Reference(AU 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 |
SOΣC | 0..* | BackboneElement | Individual tests in a group or panel Constraints: au-core-obs-03
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
| value[x] |
SOΣC | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ips | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | ||||
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ips | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsFrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | ||||
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present : (($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists())) | |
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() | |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-obs-0 | error | Observation | A pathology result shall at least have value or data absent reason or a child observation with a value or data absent reason : value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from AUCorePathologyResult
Summary
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
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 |
O | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| ||||||||
| category |
O | 1..* | CodeableConceptIPS | Classification of the service requested as laboratory + more specific discipline where available
| ||||||||
| Slices for category |
Content/Rules for all slices | |||||||||||
| category:lab |
O | 1..1 | CodeableConcept | Observation generated by laboratories
| ||||||||
| category:specificDiscipline |
O | 0..* | CodeableConcept | Specific discipline of pathology
| ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Pathology test or test group
| ||||||||
| subject |
O | 1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| ||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| effective[x] |
O | 1..1 | Time of specimen collection
| |||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| performer |
O | 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] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this
| ||||||||
| value[x]:valueCodeableConcept |
O | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||
| dataAbsentReason |
O | 0..1 | CodeableConcept | Why the result is missing
| ||||||||
| interpretation |
O | 0..* | CodeableConcept | High, low, normal, etc.
| ||||||||
| specimen |
O | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| ||||||||
| referenceRange |
O | 0..* | BackboneElement | Provides guide for interpretation
| ||||||||
| low |
O | 0..1 | SimpleQuantity | Low Range, if relevant
| ||||||||
| high |
O | 0..1 | SimpleQuantity | High Range, if relevant
| ||||||||
| type |
O | 0..1 | CodeableConcept | Reference range qualifier
| ||||||||
| text |
O | 0..1 | string | Text based reference range in an observation
| ||||||||
| hasMember |
O | 0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||||
| component |
O | 0..* | BackboneElement | Individual tests in a group or panel
| ||||||||
| code |
O | 1..1 | CodeableConcept | Individual pathology test
| ||||||||
| value[x] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result
| ||||||||
| dataAbsentReason |
O | 0..1 | CodeableConcept | Why the component result is missing
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ips | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ips |
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 |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| ||||||||||||||||||
| Slices for category |
SO | 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.
| ||||||||||||||||||
| category:lab |
SO | 1..1 | CodeableConcept | Observation generated by laboratories Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||||||||||||
| coding |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||||||||
| category:specificDiscipline |
SO | 0..* | CodeableConcept | Specific discipline of pathology Binding: Pathology Diagnostic Service Category (extensible)
| ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU PS Patient) | Who and/or what the observation is about
| ||||||||||||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| effective[x] |
SOΣC | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime S | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| performer |
SOΣ | 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] |
SOΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||||||||
| specimen |
SO | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| ||||||||||||||||||
| referenceRange |
SOC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| low |
SOC | 0..1 | SimpleQuantity | Low Range, if relevant
| ||||||||||||||||||
| high |
SOC | 0..1 | SimpleQuantity | High Range, if relevant
| ||||||||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| ||||||||||||||||||
| text |
SO | 0..1 | string | Text based reference range in an observation
| ||||||||||||||||||
| hasMember |
SOΣC | 0..* | Reference(AU PS Pathology Result Observation) | Individual observations in a group, study, or panel
| ||||||||||||||||||
| component |
SOΣC | 0..* | BackboneElement | Individual tests in a group or panel Constraints: au-core-obs-03
| ||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
| value[x] |
SOΣC | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ips | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | |
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ips | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | |
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-02 | error | Observation.effective[x] | 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() |
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 |
?!SOΣ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required)
| ||||||||||||||||||
| Slices for category |
SO | 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.
| ||||||||||||||||||
| category:lab |
SO | 1..1 | CodeableConcept | Observation generated by laboratories Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| coding |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||||||||||
| category:specificDiscipline |
SO | 0..* | CodeableConcept | Specific discipline of pathology Binding: Pathology Diagnostic Service Category (extensible)
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | ||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Pathology test or test group Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
| subject |
SOΣ | 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 |
SOΣ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] |
SOΣC | 1..1 | Time of specimen collection Constraints: au-core-obs-02
| |||||||||||||||||||
| effectiveDateTime |
dateTime S | |||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||||||||||||||||
| performer |
SOΣ | 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] |
SOΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
SO | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||||||||||||||
| specimen |
SO | 0..1 | Reference(AU Base Specimen) | Specimen used for this observation
| ||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||||||||
| referenceRange |
SOC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| low |
SOC | 0..1 | SimpleQuantity | Low Range, if relevant
| ||||||||||||||||||
| high |
SOC | 0..1 | SimpleQuantity | High Range, if relevant
| ||||||||||||||||||
| type |
SO | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
| ||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||||||||
| text |
SO | 0..1 | string | Text based reference range in an observation
| ||||||||||||||||||
| hasMember |
SOΣC | 0..* | Reference(AU 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 |
SOΣC | 0..* | BackboneElement | Individual tests in a group or panel Constraints: au-core-obs-03
| ||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Individual pathology test Binding: RCPA SPIA Pathology Reporting (extensible)
| ||||||||||||||||||
| value[x] |
SOΣC | 0..1 | Actual component result
| |||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| dataAbsentReason |
SOC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
| ||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ips | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:specificDiscipline | extensible | PathologyDiagnosticServiceCategory https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | ||||
| Observation.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ips | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsFrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | ||||
| Observation.component.code | extensible | RCPASPIAPathologyReporting https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-02 | error | Observation.effective[x] | Date shall be at least to day or, if not available, the Data Absent Reason extension shall be present : (($this is dateTime implies $this.toString().length() >= 10) and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists().not()) xor ($this is dateTime implies ($this.hasValue().not() and extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').value.exists())) | |
| au-core-obs-03 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() | |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-obs-0 | error | Observation | A pathology result shall at least have value or data absent reason or a child observation with a value or data absent reason : value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists() | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from AUCorePathologyResult
Summary
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#0.5.0-cibuild based on FHIR 4.0.1. Generated 2025-09-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change