| 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 Core Flag [Active]

The purpose of this profile is to provide a core representation of a flag (e.g. warning or notification) 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 Flag that are supported.

Where a more specific Flag profile is applicable, e.g. AIR notice, an implementation SHALL ensure the resource conforms to that specific profile.

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

- Query for a flag (alert or notice) associated with a patient
- Record or update a flag (alert or notice) associated with a patient

#### Profile specific guidance

None.

#### Boundaries and relationships

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

The following profiles build on the ADHA Core Flag profile to define specific flags:

- ADHA Australian Immunisation Register Notice.

#### Formal Views of Profile Content

The official URL for this profile is:

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

The purpose of this profile is to provide a core representation of a flag (e.g. warning or notification) for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on Flag.

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..* | Flag | Key information to flag to healthcare providers
identifier | S | 0..* | Identifier | Business identifier
status | S | 1..1 | code | active | inactive | entered-in-error
category | S | 1..* | CodeableConcept | Clinical, administrative, etc.
code | S | 1..1 | CodeableConcept | Coded or textual message to display to user
subject | S C | 1..1 | Reference(ADHA Core Patient | ADHA Core Location | ADHA Core Organization | ADHA Core Medication | PlanDefinition | ADHA Core Procedure) | 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 System Device | ADHA Core Organization | ADHA Core Patient | ADHA Authoring PractitionerRole) | Flag creator inv-dh-flg-02: At least reference or a valid identifier shall be present
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
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 Σ | 0..* | 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.
category | S Σ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
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 | ADHA Core Location | ADHA Core Organization | ADHA Core Medication | PlanDefinition | ADHA Core Procedure) | 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 System Device | ADHA Core Organization | ADHA Core Patient | ADHA Authoring PractitionerRole) | Flag creator inv-dh-flg-02: At least reference or a valid identifier shall be present
Documentation for this format

Differential View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
identifier | S | 0..* | Identifier | Business identifier
status | S | 1..1 | code | active | inactive | entered-in-error
category | S | 1..* | CodeableConcept | Clinical, administrative, etc.
code | S | 1..1 | CodeableConcept | Coded or textual message to display to user
subject | S C | 1..1 | Reference(ADHA Core Patient | ADHA Core Location | ADHA Core Organization | ADHA Core Medication | PlanDefinition | ADHA Core Procedure) | 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 System Device | ADHA Core Organization | ADHA Core Patient | ADHA Authoring PractitionerRole) | Flag creator inv-dh-flg-02: At least reference or a valid identifier shall be present
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
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 Σ | 0..* | 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.
category | S Σ | 1..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
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 | ADHA Core Location | ADHA Core Organization | ADHA Core Medication | PlanDefinition | ADHA Core Procedure) | 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 System Device | ADHA Core Organization | ADHA Core Patient | ADHA Authoring PractitionerRole) | Flag creator inv-dh-flg-02: At least reference or a valid identifier shall be present
Documentation for this format

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

#### Terminology Bindings

Path | Conformance | ValueSet
Flag.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Flag.status | required | FlagStatus
Flag.category | example | FlagCategory
Flag.code | example | FlagCode

#### Search Parameters

None defined.