| Australian Digital Health Agency Medicare Records FHIR Implementation Guide 2.1.0

Australian Digital Health Agency Medicare Records FHIR Implementation Guide. The current version which supersedes this version is 2.2.0. It is based on FHIR® version 3.0.2. See the Directory of published versions for a list of available versions.

### StructureDefinition: ADHA Australian Immunisation Register Flag [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 Medicare repositories and the My Health Record system infrastructure in Australia.

##### Usage scenarios

The following are the usage scenarios expected:

- An individual’s Australian Immunisation Register record is uploaded to the My Health Record system from a Medicare repository

##### Each Flag SHALL have

1. a profile assertion to this profile
2. an identifier for this notice
3. a status of this notice set to active
4. a category to indicate this is an AIR notice
5. a code that includes the notice text
6. a patient

##### Must Support

In the context of this profile Must Support SHALL be interpreted as follows.

- The system SHALL be able to store and retrieve the following elements:
  - category
  - code
- The system SHALL be able to take the following elements into account when performing processing:
  - identifier
  - patient

##### Profile-specific implementation guidance

- The patient resource should be identified in the subject element with a logical reference, i.e. an Australian IHI
- The notice text is sent in the text portion of code

#### Formal Views of Profile Content

The official URL for this profile is:

    http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/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 Medicare repositories and the My Health Record system infrastructure in Australia.

This profile builds on Flag.

This profile was published on 2023-04-14 04:15:22+0000 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..* | Flag | AIR notice
meta | C | 1..1 | Meta | Metadata about the resource inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
profile |  | 1..* | uri | Profiles this resource claims to conform to
identifier | S | 1..1 | Identifier | Business identifier
status |  | 1..1 | code | active | inactive | entered-in-error Fixed Value: active
category | S | 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
code | S | 1..1 | CodeableConcept | Coded or textual message to display to user
subject | S | 1..1 | Reference(AU Base Patient) | Who/What is flag about?
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | AIR notice
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ C | 1..1 | Meta | Metadata about the resource inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
profile | Σ | 1..* | uri | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | 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 | ?!Σ | 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 entered in error. Fixed Value: active
category | S Σ | 1..1 | CodeableConcept | Australian Immunisation Register notice Binding: Flag Category (example): A general category for flags for filtering/display purposes. Required Pattern: At least the following
id |  | 0..1 | id | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | id | xml:id (or equivalent in JSON)
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: Flag Code (example): Detail codes identifying specific flagged issues.
subject | S Σ | 1..1 | Reference(AU Base Patient) | Who/What is flag about?
period | Σ | 0..1 | Period | Time period when flag is active
encounter | Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter
author | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner) | Flag creator
Documentation for this format

Differential View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | AIR notice
meta | C | 1..1 | Meta | Metadata about the resource inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
profile |  | 1..* | uri | Profiles this resource claims to conform to
identifier | S | 1..1 | Identifier | Business identifier
status |  | 1..1 | code | active | inactive | entered-in-error Fixed Value: active
category | S | 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
code | S | 1..1 | CodeableConcept | Coded or textual message to display to user
subject | S | 1..1 | Reference(AU Base Patient) | Who/What is flag about?
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | AIR notice
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ C | 1..1 | Meta | Metadata about the resource inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
profile | Σ | 1..* | uri | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | 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 | ?!Σ | 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 entered in error. Fixed Value: active
category | S Σ | 1..1 | CodeableConcept | Australian Immunisation Register notice Binding: Flag Category (example): A general category for flags for filtering/display purposes. Required Pattern: At least the following
id |  | 0..1 | id | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | id | xml:id (or equivalent in JSON)
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: Flag Code (example): Detail codes identifying specific flagged issues.
subject | S Σ | 1..1 | Reference(AU Base Patient) | Who/What is flag about?
period | Σ | 0..1 | Period | Time period when flag is active
encounter | Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter
author | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner) | Flag creator
Documentation for this format

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

#### 1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-flag-air-1

none defined