Australian Digital Health Agency FHIR Implementation Guide 1.0.0

Australian Digital Health Agency FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available versions.

StructureDefinition: ADHA Australian Immunisation Register Notice [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 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.

This profile is designed to set a Flag standard for:

  • Query for a flag (e.g. warning or notification) provided by the Australian Immunisation Register associated with a patient
  • Record or update a flag provided by the Australian Immunisation Register associated with a patient

Profile specific guidance

None.

Boundaries and relationships

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

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-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 individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on ADHAFlagCore.

This profile was published on 2023-04-14 04:02:01+0000 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..*ADHAFlagCoreAIR notice
... identifier 1..1IdentifierBusiness identifier
... status 1..1codeactive | inactive | entered-in-error
Fixed Value: active
... Slices for category 1..*CodeableConceptClinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
.... category:air 1..1CodeableConceptAustralian Immunisation Register notice
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1500551000168103
... subject 1..1Reference(ADHA Core Patient)Who/What is flag about?
... author 1..1Reference(ADHA Core Organization)Australian Immunisation Register

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*ADHAFlagCoreAIR notice
... 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Σ1..1IdentifierBusiness 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.


Fixed Value: active
... Slices for category SΣ1..*CodeableConceptClinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


.... category:air SΣ1..1CodeableConceptAustralian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.



Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1500551000168103
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... 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)Who/What is flag about?
... 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 Core Organization)Australian Immunisation Register

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*ADHAFlagCoreAIR notice
... identifier 1..1IdentifierBusiness identifier
... status 1..1codeactive | inactive | entered-in-error
Fixed Value: active
... Slices for category 1..*CodeableConceptClinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
.... category:air 1..1CodeableConceptAustralian Immunisation Register notice
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1500551000168103
... subject 1..1Reference(ADHA Core Patient)Who/What is flag about?
... author 1..1Reference(ADHA Core Organization)Australian Immunisation Register

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*ADHAFlagCoreAIR notice
... 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Σ1..1IdentifierBusiness 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.


Fixed Value: active
... Slices for category SΣ1..*CodeableConceptClinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.


.... category:air SΣ1..1CodeableConceptAustralian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.



Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1500551000168103
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... 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)Who/What is flag about?
... 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 Core Organization)Australian Immunisation Register

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet / Code
Flag.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFixed Value: active
Flag.categoryexampleFlagCategory
Flag.category:airexamplePattern: SNOMED CT code 1500551000168103
Flag.codeexampleFlagCode

Search Parameters

None defined.