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:

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... identifier S0..*IdentifierBusiness identifier
... status S1..1codeactive | inactive | entered-in-error
... category S1..*CodeableConceptClinical, administrative, etc.
... code S1..1CodeableConceptCoded or textual message to display to user
... subject SC1..1Reference(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 S0..1PeriodTime period when flag is active
... encounter S0..1Reference(ADHA Core Encounter)Alert relevant during encounter
... author SC1..1Reference(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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
... status ?!SΣ1..1codeactive | 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..*CodeableConceptClinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣC1..1Reference(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..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(ADHA Core Encounter)Alert relevant during encounter
... author SΣC1..1Reference(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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... identifier S0..*IdentifierBusiness identifier
... status S1..1codeactive | inactive | entered-in-error
... category S1..*CodeableConceptClinical, administrative, etc.
... code S1..1CodeableConceptCoded or textual message to display to user
... subject SC1..1Reference(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 S0..1PeriodTime period when flag is active
... encounter S0..1Reference(ADHA Core Encounter)Alert relevant during encounter
... author SC1..1Reference(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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagKey information to flag to healthcare providers
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
... status ?!SΣ1..1codeactive | 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..*CodeableConceptClinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: FlagCode (example): Detail codes identifying specific flagged issues.

... subject SΣC1..1Reference(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..1PeriodTime period when flag is active
... encounter SΣ0..1Reference(ADHA Core Encounter)Alert relevant during encounter
... author SΣC1..1Reference(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

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

 

Terminology Bindings

PathConformanceValueSet
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFlagStatus
Flag.categoryexampleFlagCategory
Flag.codeexampleFlagCode

Search Parameters

None defined.