My Health Record FHIR IG

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

• Content
• Detailed Descriptions
• Examples
• XML
• JSON
• TTL

Resource Profile: MHR Flag

The purpose of this profile is to provide a representation of a flag (e.g. warning or notification about risks or contraindications) for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. This profile is derived from the Flag resource and describes the data structures and obligations to be met when conforming to this profile.

Usages:

• Refer to this Profile: MHR Medical Conditions View Document Composition and MHR Provenance
• Examples for this Profile: Flag/mhr-01

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Flag		0..*	Flag	Key information to flag to healthcare providers
id	Σ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	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 Obligations Actor SHALL:handle MHR Gateway Requester
category	SOΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Obligations Actor SHALL:handle MHR Gateway Requester
code	SOΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. Obligations Actor SHALL:handle MHR Gateway Requester
subject	SOΣ	1..1	Reference(MHR Patient)	Who/What is flag about? Obligations Actor SHALL:handle MHR Gateway Requester
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 From the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category From the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	If 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-4	error	Flag	If 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-5	error	Flag	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Flag	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Flag

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Flag		0..*	Flag	Key information to flag to healthcare providers
id		1..1	id	Logical id of this artifact
status	SO	1..1	code	active | inactive | entered-in-error Fixed Value: active Obligations Actor SHALL:handle MHR Gateway Requester
category	SO	1..1	CodeableConcept	Clinical, administrative, etc. Obligations Actor SHALL:handle MHR Gateway Requester
code	SO	1..1	CodeableConcept	Coded or textual message to display to user Obligations Actor SHALL:handle MHR Gateway Requester
subject	SO	1..1	Reference(MHR Patient)	Who/What is flag about? Obligations Actor SHALL:handle MHR Gateway Requester
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Flag		0..*	Flag	Key information to flag to healthcare providers
id	Σ	1..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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	Σ	0..*	Identifier	Business identifier
status	?!SOΣ	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 Obligations Actor SHALL:handle MHR Gateway Requester
category	SOΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Obligations Actor SHALL:handle MHR Gateway Requester
code	SOΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. Obligations Actor SHALL:handle MHR Gateway Requester
subject	SOΣ	1..1	Reference(MHR Patient)	Who/What is flag about? Obligations Actor SHALL:handle MHR Gateway Requester
period	Σ	0..1	Period	Time period when flag is active
encounter	Σ	0..1	Reference(Encounter)	Alert relevant during encounter
author	Σ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 From the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category From the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	If 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-4	error	Flag	If 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-5	error	Flag	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Flag	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Flag

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• MHR Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-mhr-1)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Flag		0..*	Flag	Key information to flag to healthcare providers
id	Σ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SOΣ	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 Obligations Actor SHALL:handle MHR Gateway Requester
category	SOΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Obligations Actor SHALL:handle MHR Gateway Requester
code	SOΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. Obligations Actor SHALL:handle MHR Gateway Requester
subject	SOΣ	1..1	Reference(MHR Patient)	Who/What is flag about? Obligations Actor SHALL:handle MHR Gateway Requester
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 From the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category From the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	If 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-4	error	Flag	If 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-5	error	Flag	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Flag	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Flag

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Flag		0..*	Flag	Key information to flag to healthcare providers
id		1..1	id	Logical id of this artifact
status	SO	1..1	code	active | inactive | entered-in-error Fixed Value: active Obligations Actor SHALL:handle MHR Gateway Requester
category	SO	1..1	CodeableConcept	Clinical, administrative, etc. Obligations Actor SHALL:handle MHR Gateway Requester
code	SO	1..1	CodeableConcept	Coded or textual message to display to user Obligations Actor SHALL:handle MHR Gateway Requester
subject	SO	1..1	Reference(MHR Patient)	Who/What is flag about? Obligations Actor SHALL:handle MHR Gateway Requester
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Flag		0..*	Flag	Key information to flag to healthcare providers
id	Σ	1..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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	Σ	0..*	Identifier	Business identifier
status	?!SOΣ	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 Obligations Actor SHALL:handle MHR Gateway Requester
category	SOΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Obligations Actor SHALL:handle MHR Gateway Requester
code	SOΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. Obligations Actor SHALL:handle MHR Gateway Requester
subject	SOΣ	1..1	Reference(MHR Patient)	Who/What is flag about? Obligations Actor SHALL:handle MHR Gateway Requester
period	Σ	0..1	Period	Time period when flag is active
encounter	Σ	0..1	Reference(Encounter)	Alert relevant during encounter
author	Σ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Flag.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/flag-status|4.0.1 From the FHIR Standard
Flag.category	example	FlagCategory http://hl7.org/fhir/ValueSet/flag-category From the FHIR Standard
Flag.code	example	FlagCode http://hl7.org/fhir/ValueSet/flag-code From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	If 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-4	error	Flag	If 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-5	error	Flag	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Flag	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Flag

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• MHR Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-mhr-1)

Other representations of profile: CSV, Excel, Schematron