| Australian Digital Health Agency Medicare Records FHIR Implementation Guide 2.1.0

Australian Digital Health Agency Medicare Records FHIR Implementation Guide. The current version which supersedes this version is 2.2.0. 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 - Detailed Descriptions

Definitions for the profile.

1. Flag
Definition | Australian Immunisation Register notice such as an individual has an exemption record or has finished a National Immunisation Program schedule.
Control | 0..*
Alternate Names | Barriers to CareAlertWarning
2. Flag.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Flag.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Control | 1..1
Type | Meta
Invariants | Defined on this element inv-dh-fla-01: One profile shall be 'http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1' (: profile.where($this='http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/flag-air-1').exists())
4. Flag.meta.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
5. Flag.meta.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing | This element introduces a set of slices on Flag.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
6. Flag.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
Control | 0..1
Type | id
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
7. Flag.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Control | 0..1
Type | instant
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.
8. Flag.meta.profile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Control | 1..*
Type | uri
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
9. Flag.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Control | 0..*
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
Type | Coding
Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
10. Flag.meta.tag
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Control | 0..*
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
Type | Coding
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
11. Flag.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
12. Flag.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional Bindings | Purpose
All Languages | Max Binding
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
13. Flag.text
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrativehtmlxhtmldisplay
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
14. Flag.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resourcesanonymous resourcescontained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
15. Flag.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
16. Flag.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
17. Flag.identifier
Definition | Identifier assigned to the flag for external use (outside the FHIR environment).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Must Support | true
18. Flag.status
Definition | Supports basic workflow.
Control | 1..1
Binding | The codes SHALL be taken from FlagStatus 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
Type | code
Is Modifier | true
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Fixed Value | active
19. Flag.category
Definition | Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.
Control | 1..1
Binding | For example codes, see Flag Category A general category for flags for filtering/display purposes
Type | CodeableConcept
Must Support | true
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://snomed.info/sct"/> <code value="1500551000168103"/> </coding> </valueCodeableConcept>
20. Flag.code
Definition | The coded value or textual component of the flag to display to the user.
Control | 1..1
Binding | For example codes, see Flag Code Detail codes identifying specific flagged issues
Type | CodeableConcept
Must Support | true
Comments | If non coded, use CodeableConcept.text. This element should always be included in the narrative.
21. Flag.subject
Definition | The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
Control | 1..1
Type | Reference(AUBasePatient))
Must Support | true
22. Flag.period
Definition | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.
Control | 0..1
Type | Period
23. Flag.encounter
Definition | This alert is only relevant during the encounter.
Control | 0..1
Type | Reference(Encounter))
Comments | If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end.
24. Flag.author
Definition | The person, organization or device that created the flag.
Control | 0..1
Type | Reference(Device Organization Patient Practitioner))