My Health Record FHIR IG
1.2.0 - active

My Health Record FHIR IG - Local Development build (v1.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: ADHA Core Flag

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-flag-core-1 | Version: 1.2.0
Active as of 2024-09-19 | Computable Name: ADHAFlagCore
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 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.

Usage:

- Derived from this Resource Profile: ADHA Australian Immunisation Register Notice

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Flag

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

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-flg-01 | error | Flag.subject | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
inv-dh-flg-02 | error | Flag.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Flag.status | required | FlagStatus `http://hl7.org/fhir/ValueSet/flag-status|4.0.1` from the FHIR Standard
Flag.category | example | FlagCategory `http://hl7.org/fhir/ValueSet/flag-category` from the FHIR Standard
Flag.code | example | FlagCode `http://hl7.org/fhir/ValueSet/flag-code` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-flg-01 | error | Flag.subject | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
inv-dh-flg-02 | error | Flag.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |

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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Flag.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Flag.status | required | FlagStatus `http://hl7.org/fhir/ValueSet/flag-status|4.0.1` from the FHIR Standard
Flag.category | example | FlagCategory `http://hl7.org/fhir/ValueSet/flag-category` from the FHIR Standard
Flag.code | example | FlagCode `http://hl7.org/fhir/ValueSet/flag-code` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-flg-01 | error | Flag.subject | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
inv-dh-flg-02 | error | Flag.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |

This structure is derived from Flag

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- ADHA Core Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1)
- ADHA Core Location (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-location-core-1)
- ADHA Core Organization (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-core-1)
- ADHA Core Medication (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medication-core-1)
- ADHA Core Procedure (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-procedure-core-1)
- ADHA Core Encounter (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1)
- ADHA System Device (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-device-system-1)
- ADHA Authoring PractitionerRole (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1)

Differential View

This structure is derived from Flag

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

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-flg-01 | error | Flag.subject | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
inv-dh-flg-02 | error | Flag.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Flag |  | 0..* | Flag | Key information to flag to healthcare providers
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Flag.status | required | FlagStatus `http://hl7.org/fhir/ValueSet/flag-status|4.0.1` from the FHIR Standard
Flag.category | example | FlagCategory `http://hl7.org/fhir/ValueSet/flag-category` from the FHIR Standard
Flag.code | example | FlagCode `http://hl7.org/fhir/ValueSet/flag-code` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-flg-01 | error | Flag.subject | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
inv-dh-flg-02 | error | Flag.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |

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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Flag.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Flag.status | required | FlagStatus `http://hl7.org/fhir/ValueSet/flag-status|4.0.1` from the FHIR Standard
Flag.category | example | FlagCategory `http://hl7.org/fhir/ValueSet/flag-category` from the FHIR Standard
Flag.code | example | FlagCode `http://hl7.org/fhir/ValueSet/flag-code` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-flg-01 | error | Flag.subject | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
inv-dh-flg-02 | error | Flag.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |

This structure is derived from Flag

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- ADHA Core Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1)
- ADHA Core Location (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-location-core-1)
- ADHA Core Organization (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-core-1)
- ADHA Core Medication (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medication-core-1)
- ADHA Core Procedure (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-procedure-core-1)
- ADHA Core Encounter (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1)
- ADHA System Device (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-device-system-1)
- ADHA Authoring PractitionerRole (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1)

Other representations of profile: CSV, Excel, Schematron