| Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

### StructureDefinition: ADHA Australian Immunisation Register Notice [Active]

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 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

#### Profile specific guidance

None.

#### Boundaries and relationships

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

#### Formal Views of Profile Content

The official URL for this profile is:

    http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-flag-air-1

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 builds on ADHAFlagCore.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

- Differential Table
- Snapshot Table
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
subject |  | 1..1 | Reference(ADHA Core Patient) | Who/What is flag about?
author |  | 1..1 | Reference(ADHA Core Organization) | Australian Immunisation Register
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | id | 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 | id | 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?
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
Documentation for this format

Differential View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
subject |  | 1..1 | Reference(ADHA Core Patient) | Who/What is flag about?
author |  | 1..1 | Reference(ADHA Core Organization) | Australian Immunisation Register
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | id | 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 | id | 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?
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
Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Flag.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Flag.status | required | Fixed Value: active
Flag.category | example | FlagCategory
Flag.category:air | example | Pattern: SNOMED CT code 1500551000168103
Flag.code | example | FlagCode

#### Search Parameters

None defined.