Australian Digital Health Agency Medicare Records FHIR Implementation Guide 2.2.0

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

StructureDefinition: ADHA Australian Immunisation Register Flag [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 Medicare repositories and the My Health Record system infrastructure in Australia.

Usage scenarios

The following are the usage scenarios expected:

  • An individual’s Australian Immunisation Register record is uploaded to the My Health Record system from a Medicare repository
Each Flag SHALL have
  1. a profile assertion to this profile
  2. an identifier for this notice
  3. a status of this notice set to active
  4. a category to indicate this is an AIR notice
  5. a code that includes the notice text
  6. a patient
Must Support

In the context of this profile Must Support SHALL be interpreted as follows.

  • The system SHALL be able to store and retrieve the following elements:
    • category
    • code
  • The system SHALL be able to take the following elements into account when performing processing:
    • identifier
    • patient
Profile-specific implementation guidance
  • The patient resource should be identified in the subject element with a logical reference, i.e. an Australian IHI
  • The notice text is sent in the text portion of code

Formal Views of Profile Content

The official URL for this profile is:

http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/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 Medicare repositories and the My Health Record system infrastructure in Australia.

This profile builds on Flag.

This profile was published on 2023-04-14 04:08:50+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..*FlagAIR notice
... meta C1..1MetaMetadata about the resource
inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
.... profile 1..*uriProfiles this resource claims to conform to
... identifier S1..1IdentifierBusiness identifier
... status 1..1codeactive | inactive | entered-in-error
Fixed Value: active
... category S1..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
... code S1..1CodeableConceptCoded or textual message to display to user
... subject S1..1Reference(AU Base Patient)Who/What is flag about?

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagAIR notice
... id Σ0..1idLogical id of this artifact
... meta ΣC1..1MetaMetadata about the resource
inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax 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 ?!Σ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 entered in error.


Fixed Value: active
... category SΣ1..1CodeableConceptAustralian Immunisation Register notice
Binding: Flag Category (example): A general category for flags for filtering/display purposes.


Required Pattern: At least the following
.... id0..1idxml:id (or equivalent in JSON)
.... extension0..*ExtensionAdditional Content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idxml:id (or equivalent in JSON)
..... 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: Flag Code (example): Detail codes identifying specific flagged issues.

... subject SΣ1..1Reference(AU Base Patient)Who/What is flag about?
... period Σ0..1PeriodTime period when flag is active
... encounter Σ0..1Reference(Encounter)Alert relevant during encounter
... author Σ0..1Reference(Device | Organization | Patient | Practitioner)Flag creator

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagAIR notice
... meta C1..1MetaMetadata about the resource
inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
.... profile 1..*uriProfiles this resource claims to conform to
... identifier S1..1IdentifierBusiness identifier
... status 1..1codeactive | inactive | entered-in-error
Fixed Value: active
... category S1..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
... code S1..1CodeableConceptCoded or textual message to display to user
... subject S1..1Reference(AU Base Patient)Who/What is flag about?

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*FlagAIR notice
... id Σ0..1idLogical id of this artifact
... meta ΣC1..1MetaMetadata about the resource
inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ1..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax 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 ?!Σ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 entered in error.


Fixed Value: active
... category SΣ1..1CodeableConceptAustralian Immunisation Register notice
Binding: Flag Category (example): A general category for flags for filtering/display purposes.


Required Pattern: At least the following
.... id0..1idxml:id (or equivalent in JSON)
.... extension0..*ExtensionAdditional Content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idxml:id (or equivalent in JSON)
..... 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: Flag Code (example): Detail codes identifying specific flagged issues.

... subject SΣ1..1Reference(AU Base Patient)Who/What is flag about?
... period Σ0..1PeriodTime period when flag is active
... encounter Σ0..1Reference(Encounter)Alert relevant during encounter
... author Σ0..1Reference(Device | Organization | Patient | Practitioner)Flag creator

doco Documentation for this format

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

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-flag-air-1

none defined