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 View ( Experimental )

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-composition-ncspv-1 Version: 0.0.4
Draft as of 2024-12-19 Computable Name: DHCompositionNCSPV

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to define a representation of a National Cancer Screening Program Participation View that describes an individual's participation in one or more national cancer screening programs at a point in time for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

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

This profile supports the equivalent of a HL7 CDA instance conformance Level 3A or 3B clinical document as defined in the Agency's Common Conformance Profile for Clinical Documents.

This profile is designed to set a Composition standard for:

  • Query for a National Cancer Program Participation View for a patient
  • Record or update a National Cancer Program Participation View for a patient

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

Profile specific guidance

  • This profile supports a view of the information held about an individual's participation in one or more national cancer screening program at a point in time.
    • It is generated in response to a request if a system holds information about a program for an individual.
    • Information about each program is a separate Observation in Composition.section.entry.

Boundaries and relationships

This profile is not referenced by another profile in this implementation guide.

Usage:

Formal Views of Profile Content

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

This structure is derived from ADHACompositionDocument

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* ADHACompositionDocument National Cancer Screening Program Participation View
... status 1..1 code preliminary | final | amended | entered-in-error
Required Pattern: final
... type 1..1 CodeableConcept Document sub 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: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 100.32040
... Slices for category 1..* CodeableConcept Categorization of Composition
Slice: Unordered, Open by pattern:$this
.... category:dspr 1..1 CodeableConcept Disease Screening Program Participation Record
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: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 100.32039
... section 1..* BackboneElement Health Program Information
.... title 1..1 string Label for section (e.g. for ToC)
.... code 1..1 CodeableConcept Classification of section (recommended)
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: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 101.32046
.... entry 1..* Reference(ADHA National Cancer Screening Program Participation Observation) National cancer screening program participation observation
.... emptyReason 0..0

doco Documentation for this format

 

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
identifier token SHALL An identifier for the report Composition.identifier
category token SHALL Categorization of Composition Composition.category
subject:identifier token SHALL Who and/or what the composition is about Composition.subject.identifier
type token SHALL Kind of composition (LOINC if possible) Composition.code
date date SHALL Composition editing time Composition.effective
status token SHOULD preliminary | final | amended | entered-in-error Composition.status

Mandatory Search Parameters

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

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

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

    Example:

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

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

  2. SHALL support searching using the identifier search parameter:

    GET [base]/Composition?identifier={system|}[code]

    Example:

     GET [base]/Composition?identifier=urn:ietf:rfc:3986|urn:uuid:b487469d-810c-40ae-b5a9-c0beb9001c9f

    Implementation Notes: Fetches a bundle containing any Composition resources matching the identifier (how to search by token)

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

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

    Example:

     GET [base]/Composition?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&category=https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1|100.32039

    Implementation Notes: Fetches a bundle of all Composition resources with the category of "Disease Screening Program Participation Record" for the specified patient (how to search by :identifier and how to search by token)

  4. SHALL support searching using the combination subject:identifier and type search parameter:

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

    Example:

     GET [base]/Composition?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&type=https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1|100.32040

    Implementation Notes: Fetches a bundle of all Composition resources with the type of an 100.32040 (National Cancer Screening Program Participation View) for the specified patient (how to search by :identifier and how to search by token)

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

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

    Example:

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

    Implementation Notes: Fetches a bundle of all Composition resources for the specified patient that have a date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)