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

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

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

Profile specific guidance

None.

Boundaries and relationships

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

Usage:

Formal Views of Profile Content

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

This structure is derived from Flag

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.
... subject SC 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 SC 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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-flg-01errorFlag.subjectAt 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-02errorFlag.authorAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.statusrequiredFlagStatus
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.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-flg-01errorFlag.subjectAt 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-02errorFlag.authorAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFlagStatus
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.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-flg-01errorFlag.subjectAt 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-02errorFlag.authorAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()

Differential View

This structure is derived from Flag

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.
... subject SC 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 SC 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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-flg-01errorFlag.subjectAt 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-02errorFlag.authorAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.statusrequiredFlagStatus
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.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-flg-01errorFlag.subjectAt 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-02errorFlag.authorAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFlagStatus
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.codeexampleFlagCode
http://hl7.org/fhir/ValueSet/flag-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-flg-01errorFlag.subjectAt 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-02errorFlag.authorAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()

 

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.