Closed dtr-agency closed 3 years ago
This ValueSet when developed will be bound as required in Observation.status as part of:
Analysis of possible usage of codes in ObservationStatus | Code | Applicable context | In / Out for diagnostic reports | Rationale |
---|---|---|---|---|
registered | Vital Signs / Pathology / Diagnostic Imaging / Other Diag | Out | Does not serve the use case of reporting of results. Unclear of the applicability of this status for social history observations. | |
preliminary | Vital Signs / Pathology / Diagnostic Imaging / Other Diag | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
final | ALL | In | Supports use case of reporting of results | |
amended | ALL | In | Supports use case of reporting of results | |
corrected | ALL | In | Supports use case of reporting of results | |
cancelled | ALL | Out | Does not serve the use case of reporting of results | |
entered-in-error | ALL | Out | Does not serve the use case of reporting of results | |
unknown | ALL | Out | Does not serve the use case of reporting of results |
ALL - including social history, clinical findings, vital signs, pathology, diagnostic imaging, other diagnostics
The shallow analysis suggests
Analysis of possible usage of codes in HL7 Version 2 Table 0123 | Code | Display | Applicable context | In / Out for diagnostic reports | Rationale |
---|---|---|---|---|---|
A | Some, but not all, results available | ALL | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
C | Corrected, final | ALL | In | Supports use case of reporting of results | |
F | Final results | ALL | In | Supports use case of reporting of results | |
I | No results available; specimen received, procedure incomplete | Pathology / Other | Out | Does not serve the use case of reporting of results | |
M | Corrected, not final | ALL | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
N | Procedure completed, results pending | Pathology / Diagnostic Imaging / Other | Out | Does not serve the use case of reporting of results | |
O | Order received; specimen not yet received | Pathology / Other | Out | Does not serve the use case of reporting of results | |
P | Preliminary | Vital / Pathology / Diagnostic Imaging / Other | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
R | Results stored; not yet verified | ALL | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
S | No results available; procedure scheduled, but not done | Vital / Pathology / Diagnostic Imaging / Other | Out | Does not serve the use case of reporting of results | |
X | No results available; Order canceled | Pathology / Diagnostic Imaging / Other | Out | Does not serve the use case of reporting of results | |
Y | No order on record for this test | Pathology / Diagnostic Imaging / Other | Out | Does not serve the use case of reporting of results | |
Z | No record of this patient | Pathology / Diagnostic Imaging / Other | Out | Does not serve the use case of reporting of results |
ALL - including social history, clinical findings, vital signs, pathology, diagnostic imaging, other diagnostics
The shallow analysis suggests
Analysis of possible usage of codes in v3 Code System ActStatus | Code | Applicable context | In / Out for diagnostic reports | Rationale |
---|---|---|---|---|
normal | ALL | Out | Too wide; subsumes some codes that are Out. | |
aborted | ALL | Out | Does not serve the use case of reporting of results | |
active | ALL | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
cancelled | ALL | Out | Does not serve the use case of reporting of results | |
completed | ALL | In | Supports use case of reporting of results | |
held | ALL | Out | Does not serve the use case of reporting of results | |
new | ALL | Out | Does not serve the use case of reporting of results | |
suspended | ALL | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
nullified | ALL | Out | Does not serve the use case of reporting of results | |
obsolete | ALL | Out | Does not serve the use case of reporting of results |
ALL - including social history, clinical findings, vital signs, pathology, diagnostic imaging, other diagnostics
The shallow analysis suggests that the set of codes relevant in a diagnostic reporting context are relevant across all domains. There is also a clear set of codes applicable to the reporting usage scenarios.
Analysis of possible usage of codes in CodeSystem NCTIS Result Status Values | Code | Display | Applicable context | In / Out for diagnostic reports | Rationale |
---|---|---|---|---|---|
1 | Registered | Vital Signs / Pathology / Diagnostic Imaging / Other Diag | Out | Does not serve the use case of reporting of results. Unclear of the applicability of this status for social history observations. | |
2 | Interim | Vital Signs / Pathology / Diagnostic Imaging / Other Diag | In | Supports use case of reporting of results. It is common and meaningful to send a diagnostic report with initial results with a final to follow. | |
3 | Final | ALL | In | Supports use case of reporting of results | |
4 | Amended | ALL | In | Supports use case of reporting of results | |
5 | Cancelled / Aborted | ALL | Out | Does not serve the use case of reporting of results |
ALL - including social history, clinical findings, vital signs, pathology, diagnostic imaging, other diagnostics
The shallow analysis suggests
@davidmckillop, can you please review the above analysis of codes against the three diagnostic domains?
@dtr-agency - I agree with your analysis of in/out codes listed above for the 3 diagnostic domains (pathology, diagnostic imaging and other diagnotics).
This issue is scoped specifically to support exchange of diagnostic reports so only the diagnostic context work will be progressed. Suggested outcomes:
ValueSet element | Suggested value |
---|---|
title | ObservationStatus Result Available |
canonical url | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
version | 1.0.0 |
description | The ObservationStatus Result Available value set includes values that may be used to represent the status of an observation that indicates a result is available for electronic exchange of health information between healthcare providers, and between healthcare providers and the My Health Record system in Australia. |
compose | system: "http://hl7.org/fhir/observation-status"; concept: [code: "preliminary"; code: "final"; code: "amended"; code: "corrected"] |
Associated FHIR Terminology Request: FTR-938
NOTE: Design amended to fix system value in compose from internal review comments
ValueSet element | Suggested value |
---|---|
title | v2 RESULT STATUS – OBR Result Available |
canonical url | https://healthterminologies.gov.au/fhir/ValueSet/v2-result-status-obr-result-available-1 |
version | 1.0.0 |
description | The v2 RESULT STATUS – OBR Result Available value set includes values that may be used to represent the status of an observation that indicates a result is available for electronic exchange of health information between healthcare providers, and between healthcare providers and the My Health Record system in Australia. |
compose | "system": "http://terminology.hl7.org/CodeSystem/v2-0123"; concept: [code: "A"; code: "C"; code: "F"; code: "M"; code: "P"; code: "R"] |
Associated FHIR Terminology Request: FTR-1023
@davidmckillop - ready for product owner walkthrough of proposed value set design. Product owner okayed, moving to internal review with @LB-Agency .
Review of ObservationStatus Result Available value set.
I agree with the analysis of codes for this use case. Only comment is to update the design table so compose includes, "system": "http://hl7.org/fhir/observation-status".
RESPONSE
REVIEWER (@LB-Agency) RESPONSE Confirmed change and accepted
v3 ActStatus is not recommended. The FHIR element Observation.status captures different semantics to observation/statusCode. Observation.status is about the status of the result value whereas the statuscode element in CDA is defined possible states of an Act, as defined by the Act class state. It reflects the state of the activity. In the case of an Observation, this is the status of the activity of observing. Similar but not the same.
When mapping the element Observation.status into CDA, codes from v3 Code System ActStatus should not be used.
v2 OBSERVATION RESULT STATUS is not recommended. This terminology cannot be used in FHIR, and has not been included in Agency CDA implementation guides to date.
There is significant equivalence between the FHIR element Observation.status and the codes in v2 OBSERVATION RESULT STATUS at an individual level for results of an observation resulting from a procedure - this terminology is not suitable for all observations and contains some workflow codes.
However this is less equivalent at the study or panel Observation where HL7 Version 2 Table 0123 is more applicable (and has been included in some Agency CDA implementation guides).
When mapping the element Observation.status into CDA, codes from v2 OBSERVATION RESULT STATUS are not suitable to be used unless a profile specifically for an 'individual test observation' / 'v2 message segment' is requested.
@davidmckillop - please comment on the above notes.
HL7 Version 2 Table 0123 vs NCTIS Result Status Values vs ObservationStatus.
The semantics of what we are looking to capture here is status of the result of an observation (Observation.status), as distinct from the status of the results inside the report (similar to status of results of a panel or study), or the status of the report itself (DiagnosticReport.status or DocumentReference.docStatus) or the or status of the activity (workflow). HL7 Version 2 Table 0123 is predominately populated by codes that describe the status of a result of an observation from a procedure (e.g. F) with some workflow codes (e.g. R).
HL7 Version 2 Table 0123 contains codes that are suitable to support the concept of Observation status in FHIR-based CDA for those results that are the outcomes of an observation resulting from a procedure - this terminology is not suitable for all observations and contains some workflow codes.
The semantics of what we are looking to capture here is status of the result of an observation (Observation.status), as distinct from the status of the results inside the report (similar to status of results of a panel or study), or the status of the report itself (DiagnosticReport.status or DocumentReference.docStatus) or the or status of the activity (workflow). ObservationStatus is populated by codes that describe the status of a result of an observation. These codes have been intended for this exact purpose.
ObservationStatus is suitable to support the concept of Observation status in FHIR-based CDA.
The semantics of what we are looking to capture here is status of the result of an observation (Observation.status), as distinct from the status of the results inside the report (similar to status of results of a panel or study), or the status of the report itself (DiagnosticReport.status or DocumentReference.docStatus) or the or status of the activity (workflow). NCTIS Result Status Values does not predefine the context and some codes can be used to indicate the status of result (i.e. Observation.status) or the status of a report (i.e. DiagnosticReport.status) with a workflow code (e.g. Cancelled/Aborted). The codes rely on their use in a particular structure to resolve to either 'final report' or 'final observation result'.
There are extant known issues on the use of NCTIS Result Status Values in current CDA implementation guides - it is noted that these codes are created by the Agency and are less precise and rich than other available terminologies, and it is not a domain accepted terminology.
There is significant equivalence between NCTIS Result Status Values and ObservationStatus .
NCTIS Result Status Values is not recommended (though it is suitable) to support the concept of Observation status in FHIR-based CDA.
Allowing multiple terminologies at authoring time only makes it easy for authoring systems. However the burden on consuming systems is too high. If we move to supporting a single terminology for this concept then with ConceptMaps authoring systems can internally maintain their preferred terminology and convert when sending either FHIR/CDA. And Consuming systems only need to be capable of transforming that one terminology in either FHIR/CDA into their preferred terminology.
NOTE1: The first recommendation reflect an interest in preserving a strong relationship between the CDA and FHIR in FHIR-driven CDA. NOTE2: The second recommendation reflects an interest in preserving a strong relationship between the V2 and CDA in FHIR-driven CDA - the use of HL7 Version 2 Table 0123 would only be a candicate for diagnostic observations. Other observations in CDA would make use of ObservationStatus. NOTE3: There is little value in preparing a constrained equivalent representation using NCTIS Result Status Values of the proposed ObservationStatus Result Available ValueSet to have available in the circumstance that these recommendations are not accepted. NCTIS Result Status Values has much less richness, and of the available codes only the workflow code for 'Cancelled/Aborted' would be constrained out.
Based on SME comments on original point 4. An additional point 5 has been included to introduce ConceptMaps for HL7 Table 0085.
@LB-Agency, please review the above discussion of applicability of candidate terminology in CDA. @davidmckillop, please look at this from Pathology SME perspective.
@dtr-agency - I agree with the above conclusion and recommendations, including:
Additionally, suggest that point 4 be expanded from just Table 0123 (HL7 V2 OBR-25 Results status) to also include HL7 Table 0085 (HL7 V2 OBX-11 Observation result status):
@dtr-agency - In general I agree with the proposal, but some additional clarity on Recommendation 5 would be great.
It is understood the rationale for the 2 value sets and 2 sets of concept maps supporting translations both ways between CDA and FHIR (HL7 V2 Table 0123-ObservationStatus and NCTIS Result Status Values-ObservationStatus).
What is the purpose of the concept maps between HL7 V2 Table 0085-ObservationStatus? Is this for implementers that require transform from V2 to FHIR rather than supporting a legacy Agency CDA spec? Also, is there a proposal for a HL7 V2 Table 0085 value set?
@LB-Agency, there is no recommendation for a ValueSet of Table 0085-ObservationStatus from this piece of work. @davidmckillop, can you provide more information for @LB-Agency on the value of the concept maps between HL7 V2 Table 0085-ObservationStatus.
@LB-Agency , @dtr-agency , Regarding requirement 5 above:
"ConceptMaps describing relationships between the yet to be designed value set of HL7 Version 2 Table 0085 and the proposed ObservationStatus Result Available are published to provide clarity on code equivalence and provide a path forwards for the transition of affected legacy materials."
Background:
All current and past pathology messaging is done using HL7 V2.x which has observations in OBX segments where the Observation-status is captured in OBX-11 (Observation result status) which uses HL7 Table 0085. All the current CDA and Agency specifications do not refer to table 0085, which was probably an oversight but the use of only table 0123 was a directive from the requirements at the time in eHealth Pathology Report that was strictly enforced.
Given the prevalence of Table 0085 in current HL7 V2.x messaging and the likely way forward for pathology is to map the current V2 message to FHIR content, then it would be useful to have a concept map from HL7 table 0085 to the FHIR content. If nothing else to make the path easier for pathology systems to navigate it would be useful to have a table 0085 concept map to the FHIR valueset.
Thanks @davidmckillop. So the use case describes one concept map going from V2(table 0085) to FHIR(ObservationStatus) so systems can author and send FHIR content. There's nothing suggesting systems will need to generate V2 messages from FHIR. Is that correct?
Hi @LB-Agency , yes the use case is to assist the V2 messages to be translated into FHIR content. I do not envisage a reverse map of FHIR to V2.
Ok that's cleared things up. Thanks. I'm happy to accept this now.
NOTE: These will be progressed via internal terminology tasks as per the BAU publication schedule; this GitHub issue will not be kept up to date. This content has been included here as an indication of the initial direction of this content.
ConceptMap element | Suggested value |
---|---|
title | ObservationStatus Result Available to v2 RESULT STATUS – OBR Result Available |
canonical url | https://healthterminologies.gov.au/fhir/ConceptMap/observstatus-result-avail-to-v2-result-status-obr-result-avail-1 |
version | 1.0.0 |
description | The ObservationStatus Result Available to v2 RESULT STATUS – OBR Result Available concept map defines relationships from the concepts in the ObservationStatus Result Available value set to the concepts in the v2 RESULT STATUS – OBR Result Available value set. |
sourceCanonical | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
targetCanonical | https://healthterminologies.gov.au/fhir/ValueSet/v2-result-status-obr-result-available-1 |
group | [code: "preliminary"; target code: "P"; equivalence: "equivalent"] [code: "final"; target code: "F"; equivalence: "equivalent"] [code: "amended"; target code: "C"; equivalence: "narrower"; comment: "amended subsumes but is not limited to the concept of correction"] [code: "amended"; target code: "F"; equivalence: "inexact"; comment: "TBD"] [code: "corrected"; target code: "C"; equivalence: "equivalent"] |
The content in group is a suggested starting point; review and analysis by a terminology analyst when authoring is necessary.
Associated FHIR Terminology Request: FTR-1068
And | ConceptMap element | Suggested value |
---|---|---|
title | v2 RESULT STATUS – OBR Result Available to ObservationStatus Result Available | |
canonical url | https://healthterminologies.gov.au/fhir/ConceptMap/v2-result-status-obr-result-avail-to-observstatus-result-avail-1 | |
version | 1.0.0 | |
description | The v2 RESULT STATUS – OBR Result Available to ObservationStatus Result Available concept map defines relationships from the concepts in the v2 RESULT STATUS – OBR Result Available value set to the concepts in the ObservationStatus Result Available value set. | |
sourceCanonical | https://healthterminologies.gov.au/fhir/ValueSet/v2-result-status-obr-result-available-1 | |
targetCanonical | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 | |
group | [code: "A"; target code: "preliminary"; equivalence: "?"] [code: "C"; target code: " corrected"; equivalence: "equivalent"] [code: "F"; target code: "final"; equivalence: "?"] [code: "M"; target code: "preliminary"; equivalence: "wider"] [code: "P"; target code: "preliminary"; equivalence: "?"] [code: "R"; target code: "preliminary"; equivalence: "wider"] |
The content in group is a suggested starting point; review and analysis by a terminology analyst when authoring is necessary.
Associated FHIR Terminology Request: FTR-1073
ConceptMap element | Suggested value |
---|---|
title | v2 OBSERVATION RESULT STATUS to ObservationStatus Result Available |
canonical url | https://healthterminologies.gov.au/fhir/ConceptMap/v2-obs-result-status-to- observstatus-result-avail-1 |
version | 1.0.0 |
description | The v2 OBSERVATION RESULT STATUS to ObservationStatus Result Available concept map defines relationships from the concepts in the v2 OBSERVATION RESULT STATUS value set to the concepts in the ObservationStatus Result Available value set. |
sourceCanonical | http://terminology.hl7.org/ValueSet/v2-0085 |
targetCanonical | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
group | [code: "A"; target code: "amended "; equivalence: "wider"] [code: "B"; target code: "amended"; equivalence: "wider"] [code: "C"; target code: "corrected"; equivalence: "equivalent"] [code: "D"; equivalence: "unmatched"] [code: "F"; target code: "final"; equivalence: "equivalent"][code: "I"; target code: " registered"; equivalence: "inexact"; comment: "TBD"] [code: "N"; target code: " cancelled "; equivalence: "inexact"; comment: "TBD"] [code: "O"; equivalence: "unmatched"] [code: "P"; target code: "preliminary"; equivalence: "equivalent "] [code: "R"; target code: "preliminary"; equivalence: "wider"] [code: "S"; target code: " preliminary"; equivalence: "wider"] [code: "U"; target code: "final"; equivalence: "TBD"] [code: "V"; target code: "final"; equivalence: "equivalent"] [code: "W"; target code: "entered-in-error"; equivalence: "inexact"] [code: "X"; target code: "cancelled"; equivalence: "inexact"; comment: "TBD"] |
The content in group is a suggested starting point; review and analysis by a terminology analyst when authoring is necessary.
Associated FHIR Terminology Request: FTR-1033
ConceptMap element | Suggested value |
---|---|
title | ObservationStatus Result Available to NCTIS Result Status Values |
canonical url | https://healthterminologies.gov.au/fhir/ConceptMap/observstatus-result-avail-to-nctis-result-status-values-1 |
version | 1.0.0 |
description | The ObservationStatus Result Available to NCTIS Result Status Values concept map defines relationships from the concepts in the ObservationStatus Result Available value set to the concepts in the NCTIS Result Status Values value set. |
sourceCanonical | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
targetCanonical | https://healthterminologies.gov.au/fhir/ValueSet/nctis-result-status-values-1 |
group | [code: "preliminary"; target code: "2"; equivalence: "equivalent"] [code: "final"; target code: "3"; equivalence: "equivalent"] [code: "amended"; target code: "4"; equivalence: " equivalent"] [code: "corrected"; target code: "4"; equivalence: "wider"] |
The content in group is a suggested starting point; review and analysis by a terminology analyst when authoring is necessary.
Associated FHIR Terminology Request: FTR-1038
And | ConceptMap element | Suggested value |
---|---|---|
title | NCTIS Result Status Values to ObservationStatus Result Available | |
canonical url | https://healthterminologies.gov.au/fhir/ConceptMap/nctis-result-status-values-to-observstatus-result-avail-1 | |
version | 1.0.0 | |
description | The NCTIS Result Status Values to ObservationStatus Result Available concept map defines relationships from the concepts in the NCTIS Result Status Values value set to the concepts in the ObservationStatus Result Available value set. | |
sourceCanonical | https://healthterminologies.gov.au/fhir/ValueSet/nctis-result-status-values-1 | |
targetCanonical | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 | |
group | [code: "1"; equivalence: "unmatched"] [code: "2"; target code: "preliminary"; equivalence: "equivalent"] [code: "3"; target code: "final"; equivalence: " equivalent "] [code: "4"; target code: "amended"; equivalence: "equivalent"] [code: "5"; equivalence: "unmatched"] |
The content in group is a suggested starting point; review and analysis by a terminology analyst when authoring is necessary.
Associated FHIR Terminology Request: FTR-1043
This issue has been shifted to 'complete'; publication of the content in NCTS is pending release of NTS 2.0.
To remain open until publication is confirmed.
NCTS 2.0 is now live with ObservationStatus Result Available.
The other value set is still to be published; this issue will remain open till https://jira.aws.tooling/browse/FTR-1023 is complete.
Publication now complete.
Prerequisites
The feature
Description
We need to create a more constrained value set for the status element of Observation profiles to support exchange of diagnostic reports issued by diagnostic service providers for the electronic exchange of diagnostic reports (e.g. pathology, imaging, specialist and other) between healthcare providers, and between healthcare providers and the My Health Record system infrastructure in Australia.
The usage scenarios expects a meaningful patient-centric snapshot, i.e. one or more investigations have been performed and there is some reported information that is meaningful to share between healthcare providers, and between healthcare providers and the My Health Record system to support provision of healthcare.
The values must be drawn from the required ObservationStatus ValueSet. Possibly the new ValueSet may contain the codes of "preliminary", "final", "amended", "corrected" excluding "registered", cancelled", entered-in-error" & "unknown".
This ValueSet would be bound to Observation profiles in the forthcoming Diagnostics Report FHIR implementation Guide, and in Continuity of Care including Discharge Summary, Event Summary, Specialist Letter.
What it actually enables people to do
Clarifies to implementers requirements for the state of an observation in the electronic exchange of diagnostic reports between healthcare providers, and between healthcare providers and the My Health Record system infrastructure in Australia. Provision of management of the set of values in a governed manner that is reusable across multiple profiles.
How awesome would it be?
Pretty awesome - clarity of requirements is always desired, and management by terminology binding is the preferred means in CI Agency profiles of specifying more than one allowed values for an element. This contributes to minimising the risk of inappropriate, invalid or obsolete clinical content.
Workarounds
There are other means of specifying controls on the membership of values including invariants, or alternatively only implementation guidance could be provided instead of a machine processable format.
Additional context