Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA National Cancer Screening Program Participation Observation

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-ncspp-1 Version: 0.2.3
Draft as of 2024-12-19 Computable Name: ADHAObservationNCSPP

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. Except for the material identified below, this content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO.

The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted.

All copies of this resource must include this copyright statement and all information contained in this statement.

The purpose of this profile is to provide a summary of an individual's participation in a national cancer screening program, e.g. national bowel cancer screening program, for the electronic exchange of health information between individuals, healthcare providers, the National Cancer Screening Register, and the My Health Record system infrastructure in Australia. Participation information may include information on an individual's eligibility for a program, suspension of participation in a program, or status of participation in a program.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Observation that are supported.

This profile is designed to set an Observation standard for:

  • Query for a national bowel cancer screening program participation observation for a patient
  • Query for a national cervical cancer screening program participation observation for a patient
  • Record or update a national bowel cancer screening program participation observation for a patient
  • Record or update a national cervical cancer screening program participation observation for a patient

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

  • Observation.code identifies the health program and nature of the observation (e.g. 1602081000168109 |National bowel cancer screening program participation| or 1602101000168102 |National cervical cancer screening program participation |).
  • Participant status is represented as a SNOMED CT-AU coded value in Observation.component.valueCodeableConcept with Observation.component.code= "1603781000168102"
    • Guidance on mapping participant status value domain to SNOMED CT-AU is in the table below.
  • Next screening action is represented as:
    • text in Observation.component.valueCodeableConcept.text with Observation.component.code= "1604041000168107".
    • date in Observation.component.valueDateTime with Observation.component.code= "1604051000168109".

Mapping from the participant status value domain to the concepts in the Health Program Participation Status value set is provided below.

Participant Status Value Domain SNOMED CT Concept ID Preferred term
Actively Screening 1602001000168101 Active participation
Age Exited 1602051000168102 Participation complete
Excluded 1602031000168108 Excluded from participation
Never Responder 1602021000168105 Inactive participation
New to Screening 1601971000168104 New participation
Not Eligible 1601961000168105 Not eligible for participation
Overdue for Screening 1602011000168103 Participation overdue

Usage:

Formal Views of Profile Content

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

This structure is derived from AUHealthProgramParticipationSummary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* AUHealthProgramParticipationSummary National cancer screening program participation record
... identifier S 1..* Identifier Identifier for this record (external references)
... status S 1..1 code registered | preliminary | final | amended +
Fixed Value: final
... category S 1..* CodeableConcept Classification of type of observation
... subject SC 1..1 Reference(ADHA Core Patient) Who and/or what the observation is about
inv-dh-obs-01: At least reference or a valid identifier shall be present
... effective[x] S 1..1 dateTime Date, and optionally time, this information is asserted as 'true'
... performer SC 1..1 Reference(ADHA Core Organization) Who is responsible for the observation
inv-dh-obs-02: At least reference or a valid identifier shall be present
... Slices for component S 1..* BackboneElement Component results
Slice: Unordered, Closed by pattern:code
.... component:participationStatus S 1..1 BackboneElement Participant status
..... code S 1..1 CodeableConcept Type of component observation (code / type)
..... value[x] S 0..1 CodeableConcept Actual component result
.... component:participationStatusPeriod S 1..1 BackboneElement Participant status period
..... code S 1..1 CodeableConcept Type of component observation (code / type)
..... value[x] S 0..1 dateTime, Period Actual component result
.... component:forecastStatus S 0..1 BackboneElement Next screening action
..... code S 1..1 CodeableConcept Type of component observation (code / type)
...... text 1..1 string Plain text representation of the concept
Fixed Value: Next screening action
..... value[x] S 0..1 CodeableConcept Actual component result
.... component:forecastStatusPeriod S 0..1 BackboneElement Next screening action period
..... code S 1..1 CodeableConcept Type of component observation (code / type)
..... value[x] S 0..1 dateTime, Period Actual component result
.... component:suspensionFlag S 1..1 BackboneElement Defer flag
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1603871000168108
...... text 1..1 string Plain text representation of the concept
Fixed Value: Defer flag
..... value[x] S 0..1 boolean Actual component result

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredParticipationinHealthProgram .
https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-obs-01errorObservation.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-obs-02errorObservation.performerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

Name Type Conformance Description Path
category token SHALL The classification of the type of observation Observation.category
subject:identifier token SHALL The subject that the observation is about Observation.subject.identifier
code token SHALL The code of the observation type Observation.code
date date SHALL Obtained date/time. If the obtained element is a period, a date that falls in the period Observation.effective
status date SHOULD The status of the observation Observation.status

Mandatory Search Parameters

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

  1. SHALL support searching for all observations for a patient using the subject:identifier search parameter:

    GET [base]/Observation?subject:identifier={system|}[code]

    Example:

     GET [base]/Observation?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437

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

  2. SHALL support searching using the combination subject:identifier and category search parameter:

    GET [base]/Observation?subject:identifier={system|}[code]&category[code]

    Example:

     GET [base]/Observation?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&category=http://terminology.hl7.org.au/CodeSystem/observation-category|program

    Implementation Notes: Fetches a bundle of all Observation resources with the category of "program" for the specified patient (how to search by :identifier and how to search by token)

  3. SHALL support searching using the combination subject:identifier and code search parameter:

    GET [base]/Observation?subject:identifier={system|}[code]&code={system|}[code]

    Example:

     GET [base]/Observation?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&code=http://snomed.info/sct|1602081000168109

    Implementation Notes: Fetches a bundle of all Observation resources with the code of an 1602081000168109 (National bowel cancer screening program participation) for the specified patient (how to search by :identifier and how to search by token)

  4. SHALL support searching using the combination of the subject:identifier and date search parameters:

    GET [base]/Observation?subject:identifier={system|}[code]&date=[date]

    Example:

     GET [base]/Observation?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&date=ge2022-03-14

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient that have a date greater than or equal to 14 March 2022. (how to search by :identifier and how to search by date)