Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

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 Australian Immunisation Register Notice

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-flag-air-1 Version: 1.0.0
Active as of 2024-09-12 Computable Name: ADHAFlagAIRNotice

Copyright/Legal: Copyright © 2023 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/.

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 define a notice, such as an exemption record or notification of completion of an immunisation schedule, from the Australian Immunisation Register for the electronic exchange of digital 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 Flag that are supported.

This profile is designed to set a core Flag standard for:

  • Query for a flag (e.g. warning or notification) provided by the Australian Immunisation Register associated with a patient
  • Record or update a flag provided by the Australian Immunisation Register associated with a patient

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

Profile specific guidance

None.

Usage:

Formal Views of Profile Content

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

This structure is derived from ADHAFlagCore

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* ADHAFlagCore AIR notice
... identifier 1..1 Identifier Business identifier
... status 1..1 code active | inactive | entered-in-error
Fixed Value: active
... Slices for category 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
.... category:air 1..1 CodeableConcept Australian Immunisation Register notice
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: 1500551000168103
... author 1..1 Reference(ADHA Core Organization) Australian Immunisation Register

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* ADHAFlagCore AIR notice
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Business identifier
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.



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: 1500551000168103
... code SΣ 1..1 CodeableConcept Coded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣC 1..1 Reference(ADHA Core Patient) Who/What is flag about?
inv-dh-flg-01: At least reference or display or a valid identifier shall be present
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(ADHA Core Encounter) Alert relevant during encounter
... author SΣC 1..1 Reference(ADHA Core Organization) Australian Immunisation Register
inv-dh-flg-02: At least reference or a valid identifier shall be present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.category:airexamplePattern: SNOMED-CT Code 1500551000168103
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* ADHAFlagCore AIR notice
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Business identifier
... status ?!SΣ 1..1 code active | inactive | entered-in-error
Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.


Fixed Value: active
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
...... 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 SΣ 1..1 CodeableConcept Coded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣC 1..1 Reference(ADHA Core Patient) Who/What is flag about?
inv-dh-flg-01: At least reference or display or a valid identifier shall be present
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(ADHA Core Encounter) Alert relevant during encounter
... author SΣC 1..1 Reference(ADHA Core Organization) Australian Immunisation Register
inv-dh-flg-02: At least reference or a valid identifier shall be present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.category:airexamplePattern: SNOMED-CT Code 1500551000168103
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

This structure is derived from ADHAFlagCore

Summary

Mandatory: 2 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Flag.category

Differential View

This structure is derived from ADHAFlagCore

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* ADHAFlagCore AIR notice
... identifier 1..1 Identifier Business identifier
... status 1..1 code active | inactive | entered-in-error
Fixed Value: active
... Slices for category 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
.... category:air 1..1 CodeableConcept Australian Immunisation Register notice
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: 1500551000168103
... author 1..1 Reference(ADHA Core Organization) Australian Immunisation Register

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* ADHAFlagCore AIR notice
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Business identifier
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.



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: 1500551000168103
... code SΣ 1..1 CodeableConcept Coded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣC 1..1 Reference(ADHA Core Patient) Who/What is flag about?
inv-dh-flg-01: At least reference or display or a valid identifier shall be present
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(ADHA Core Encounter) Alert relevant during encounter
... author SΣC 1..1 Reference(ADHA Core Organization) Australian Immunisation Register
inv-dh-flg-02: At least reference or a valid identifier shall be present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.category:airexamplePattern: SNOMED-CT Code 1500551000168103
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* ADHAFlagCore AIR notice
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Business identifier
... status ?!SΣ 1..1 code active | inactive | entered-in-error
Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.


Fixed Value: active
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
...... 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 SΣ 1..1 CodeableConcept Coded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣC 1..1 Reference(ADHA Core Patient) Who/What is flag about?
inv-dh-flg-01: At least reference or display or a valid identifier shall be present
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(ADHA Core Encounter) Alert relevant during encounter
... author SΣC 1..1 Reference(ADHA Core Organization) Australian Immunisation Register
inv-dh-flg-02: At least reference or a valid identifier shall be present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/flag-status|4.0.1
from the FHIR Standard
Flag.categoryexampleFlagCategory
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.category:airexamplePattern: SNOMED-CT Code 1500551000168103
http://hl7.org/fhir/ValueSet/flag-category
from the FHIR Standard
Flag.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

This structure is derived from ADHAFlagCore

Summary

Mandatory: 2 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Flag.category

 

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.