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

Resource Profile: ADHA Australian Immunisation Register Notice

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-flag-air-mhr-1 Version: 1.4.0
Computable Name: MHRFlagAIRNotice

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/.

This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted. All copies of this resource must include this copyright statement and all information contained in this statement.

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.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag AIR notice
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Business identifier
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 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(AU Core Patient) Who/What is flag about?
Constraints: inv-dh-flg-01
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(MHR Encounter) Alert relevant during encounter
... author SΣC 0..1 Reference(AU Core Organization) Australian Immunisation Register
Constraints: inv-dh-flg-02

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.statusrequiredFixed Value: active
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.category:airexamplePattern Value: SNOMED-CT Code 1500551000168103
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
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFlagIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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()

This structure is derived from Flag

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag AIR notice
... identifier S 1..1 Identifier Business identifier
... status S 1..1 code active | inactive | entered-in-error
Fixed Value: active
... Slices for category S 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
.... category:air S 1..1 CodeableConcept Australian Immunisation Register notice
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
... period S 0..1 Period Time period when flag is active
... encounter S 0..1 Reference(MHR Encounter) Alert relevant during encounter
... author SC 0..1 Reference(AU Core Organization) Australian Immunisation Register
Constraints: inv-dh-flg-02

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 & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag AIR notice
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 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.
Fixed Value: active
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 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(AU Core Patient) Who/What is flag about?
Constraints: inv-dh-flg-01
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(MHR Encounter) Alert relevant during encounter
... author SΣC 0..1 Reference(AU Core Organization) Australian Immunisation Register
Constraints: inv-dh-flg-02

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFixed Value: active
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.category:airexamplePattern Value: SNOMED-CT Code 1500551000168103
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
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFlagIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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()

This structure is derived from Flag

Summary

Mandatory: 3 elements
Must-Support: 8 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Flag.category

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag AIR notice
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Business identifier
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 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(AU Core Patient) Who/What is flag about?
Constraints: inv-dh-flg-01
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(MHR Encounter) Alert relevant during encounter
... author SΣC 0..1 Reference(AU Core Organization) Australian Immunisation Register
Constraints: inv-dh-flg-02

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.statusrequiredFixed Value: active
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.category:airexamplePattern Value: SNOMED-CT Code 1500551000168103
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
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFlagIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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 & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag AIR notice
... identifier S 1..1 Identifier Business identifier
... status S 1..1 code active | inactive | entered-in-error
Fixed Value: active
... Slices for category S 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
.... category:air S 1..1 CodeableConcept Australian Immunisation Register notice
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
... period S 0..1 Period Time period when flag is active
... encounter S 0..1 Reference(MHR Encounter) Alert relevant during encounter
... author SC 0..1 Reference(AU Core Organization) Australian Immunisation Register
Constraints: inv-dh-flg-02

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()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag AIR notice
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 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.
Fixed Value: active
... Slices for category SΣ 1..* CodeableConcept Clinical, administrative, etc.
Slice: Unordered, Open by pattern:$this
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... category:air SΣ 1..1 CodeableConcept Australian Immunisation Register notice
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1500551000168103
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 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(AU Core Patient) Who/What is flag about?
Constraints: inv-dh-flg-01
... period SΣ 0..1 Period Time period when flag is active
... encounter SΣ 0..1 Reference(MHR Encounter) Alert relevant during encounter
... author SΣC 0..1 Reference(AU Core Organization) Australian Immunisation Register
Constraints: inv-dh-flg-02

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Flag.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Flag.statusrequiredFixed Value: active
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.category:airexamplePattern Value: SNOMED-CT Code 1500551000168103
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
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFlagIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFlagIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFlagA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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()

This structure is derived from Flag

Summary

Mandatory: 3 elements
Must-Support: 8 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Flag.category

 

Other representations of profile: CSV, Excel, Schematron