Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: NZCentralRegionFlag

Flag resource for Te Whatu Ora, Central Region

Usage:

• Examples for this Resource Profile: Flag/PalliativeCare

Formal Views of Profile Content

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

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

This structure is derived from Flag

Name	Flags	Card.	Type	Description & Constraints
Flag	C	0..*	Flag	Key information to flag to healthcare providers nzcr-uncoded-flags: Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field nzcr-coded-flags: Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC
meta
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
flag-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:webPASCategory		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Flag Alert Category Value Set (required)
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
extension:severityLevel		0..1	Extension	Severity Level - 'W' for Alert/Flag
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	string	Value of extension
extension:allergyReaction		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	CodeableConcept	Value of extension
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
extension:inactiveDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
extension:reviewDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
text		0..1	string	Describe received code values that are unable to be validated
extension:comments		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	string	Value of extension
url		1..1	uri	identifies the meaning of the extension
identifier	S	1..1	Identifier	Business identifier
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
status	S	1..1	code	active | inactive | entered-in-error
category	S	1..1	CodeableConcept	Clinical, administrative, etc.
id		0..0
extension		0..0
Slices for coding	S	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
coding:fhirOrig		1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
version		0..0
code		0..1	code	Symbol in syntax defined by the system Binding: FlagCategory (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
coding:rawSource		1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/alert-category
version		0..0
code		0..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Flag Alert Category Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text	S	0..0
code	S	1..1	CodeableConcept	Coded or textual message to display to user Binding: NZ Central Region - Flag Alert Code Value Set (required)
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	0..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text	S	0..1	string	Plain text representation of the concept
subject	S	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
period	S	0..1	Period	Time period when flag is active
id		0..0
extension		0..0
start	S	1..1	dateTime	Starting time with inclusive boundary
end	S	0..1	dateTime	End time with inclusive boundary, if not ongoing
encounter		0..0
author	S	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	S	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value		0..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Flag.extension:flag-alert.extension:webPASCategory.value[x]	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.category.coding:fhirOrig.code	required	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.category.coding:rawSource.code	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.code	required	NZCentralRegionFlagAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-flag-alert-code from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
nzcr-coded-flags	error	Flag	Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC : code.text.exists().not() and code.coding.where(code = 'NP').exists().not() implies category.coding.where(code != 'NHIMWS' and code != 'MA' and code != 'MC').exists()
nzcr-uncoded-flags	error	Flag	Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field : category.coding.where(code = 'NHIMWS' or code = 'MA' or code='MC').exists() implies code.text.exists() and code.coding.where(code = 'NP').exists()

Name	Flags	Card.	Type	Description & Constraints
Flag	C	0..*	Flag	Key information to flag to healthcare providers nzcr-uncoded-flags: Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field nzcr-coded-flags: Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
flag-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Flag Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity Level - 'W' for Alert/Flag
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
extension:comments	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"comments"
value[x]		1..1	string	Value of extension
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	Business identifier
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
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.
category	SΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
extension		0..0
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
coding:fhirOrig	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: FlagCategory (required)
display	SΣ	1..1	string	Representation defined by the system
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/alert-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Flag Alert Category Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
code	SΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: NZ Central Region - Flag Alert Code Value Set (required)
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
period	SΣ	0..1	Period	Time period when flag is active
extension		0..0
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
author	SΣ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.extension:flag-alert.extension:webPASCategory.value[x]	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.extension:flag-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
Flag.extension:flag-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
Flag.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.status	required	FlagStatus 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.category.coding:fhirOrig.code	required	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.category.coding:rawSource.code	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.code	required	NZCentralRegionFlagAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-flag-alert-code from this IG
Flag.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.subject.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Flag.author.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.author.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.author.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type 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()
nzcr-coded-flags	error	Flag	Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC : code.text.exists().not() and code.coding.where(code = 'NP').exists().not() implies category.coding.where(code != 'NHIMWS' and code != 'MA' and code != 'MC').exists()
nzcr-uncoded-flags	error	Flag	Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field : category.coding.where(code = 'NHIMWS' or code = 'MA' or code='MC').exists() implies code.text.exists() and code.coding.where(code = 'NP').exists()

Name	Flags	Card.	Type	Description & Constraints
Flag	C	0..*	Flag	Key information to flag to healthcare providers nzcr-uncoded-flags: Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field nzcr-coded-flags: Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
flag-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Flag Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity Level - 'W' for Alert/Flag
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
extension:comments	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"comments"
value[x]		1..1	string	Value of extension
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	Business identifier
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
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.
category	SΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
extension		0..0
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
coding:fhirOrig	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: FlagCategory (required)
display	SΣ	1..1	string	Representation defined by the system
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/alert-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Flag Alert Category Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
code	SΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: NZ Central Region - Flag Alert Code Value Set (required)
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
period	SΣ	0..1	Period	Time period when flag is active
extension		0..0
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
author	SΣ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Flag.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Flag.extension:flag-alert.extension:webPASCategory.value[x]	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.extension:flag-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
Flag.extension:flag-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
Flag.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.status	required	FlagStatus 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.category.coding:fhirOrig.code	required	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.category.coding:rawSource.code	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.code	required	NZCentralRegionFlagAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-flag-alert-code from this IG
Flag.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.subject.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Flag.author.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.author.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.author.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type 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()
nzcr-coded-flags	error	Flag	Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC : code.text.exists().not() and code.coding.where(code = 'NP').exists().not() implies category.coding.where(code != 'NHIMWS' and code != 'MA' and code != 'MC').exists()
nzcr-uncoded-flags	error	Flag	Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field : category.coding.where(code = 'NHIMWS' or code = 'MA' or code='MC').exists() implies code.text.exists() and code.coding.where(code = 'NP').exists()

This structure is derived from Flag

Summary

Mandatory: 22 elements(14 nested mandatory elements)
Must-Support: 56 elements
Fixed: 2 elements
Prohibited: 58 elements

Extensions

This structure refers to these extensions:

• http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
• http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-type
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
• http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
• http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
• https://standards.digital.health.nz/ns/central-region/l4h-template-version
• https://standards.digital.health.nz/ns/central-region/alert

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Flag

Name	Flags	Card.	Type	Description & Constraints
Flag	C	0..*	Flag	Key information to flag to healthcare providers nzcr-uncoded-flags: Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field nzcr-coded-flags: Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC
meta
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
flag-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:webPASCategory		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Flag Alert Category Value Set (required)
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
extension:severityLevel		0..1	Extension	Severity Level - 'W' for Alert/Flag
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	string	Value of extension
extension:allergyReaction		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	CodeableConcept	Value of extension
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
extension:inactiveDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
extension:reviewDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
text		0..1	string	Describe received code values that are unable to be validated
extension:comments		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	string	Value of extension
url		1..1	uri	identifies the meaning of the extension
identifier	S	1..1	Identifier	Business identifier
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
status	S	1..1	code	active | inactive | entered-in-error
category	S	1..1	CodeableConcept	Clinical, administrative, etc.
id		0..0
extension		0..0
Slices for coding	S	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code		0..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
coding:fhirOrig		1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
version		0..0
code		0..1	code	Symbol in syntax defined by the system Binding: FlagCategory (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
coding:rawSource		1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/alert-category
version		0..0
code		0..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Flag Alert Category Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text	S	0..0
code	S	1..1	CodeableConcept	Coded or textual message to display to user Binding: NZ Central Region - Flag Alert Code Value Set (required)
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	0..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text	S	0..1	string	Plain text representation of the concept
subject	S	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
period	S	0..1	Period	Time period when flag is active
id		0..0
extension		0..0
start	S	1..1	dateTime	Starting time with inclusive boundary
end	S	0..1	dateTime	End time with inclusive boundary, if not ongoing
encounter		0..0
author	S	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	S	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value		0..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Flag.extension:flag-alert.extension:webPASCategory.value[x]	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.category.coding:fhirOrig.code	required	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.category.coding:rawSource.code	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.code	required	NZCentralRegionFlagAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-flag-alert-code from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
nzcr-coded-flags	error	Flag	Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC : code.text.exists().not() and code.coding.where(code = 'NP').exists().not() implies category.coding.where(code != 'NHIMWS' and code != 'MA' and code != 'MC').exists()
nzcr-uncoded-flags	error	Flag	Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field : category.coding.where(code = 'NHIMWS' or code = 'MA' or code='MC').exists() implies code.text.exists() and code.coding.where(code = 'NP').exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Flag	C	0..*	Flag	Key information to flag to healthcare providers nzcr-uncoded-flags: Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field nzcr-coded-flags: Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
flag-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Flag Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity Level - 'W' for Alert/Flag
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
extension:comments	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"comments"
value[x]		1..1	string	Value of extension
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	Business identifier
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
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.
category	SΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
extension		0..0
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
coding:fhirOrig	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: FlagCategory (required)
display	SΣ	1..1	string	Representation defined by the system
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/alert-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Flag Alert Category Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
code	SΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: NZ Central Region - Flag Alert Code Value Set (required)
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
period	SΣ	0..1	Period	Time period when flag is active
extension		0..0
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
author	SΣ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.extension:flag-alert.extension:webPASCategory.value[x]	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.extension:flag-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
Flag.extension:flag-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
Flag.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.status	required	FlagStatus 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.category.coding:fhirOrig.code	required	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.category.coding:rawSource.code	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.code	required	NZCentralRegionFlagAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-flag-alert-code from this IG
Flag.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.subject.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Flag.author.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.author.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.author.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type 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()
nzcr-coded-flags	error	Flag	Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC : code.text.exists().not() and code.coding.where(code = 'NP').exists().not() implies category.coding.where(code != 'NHIMWS' and code != 'MA' and code != 'MC').exists()
nzcr-uncoded-flags	error	Flag	Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field : category.coding.where(code = 'NHIMWS' or code = 'MA' or code='MC').exists() implies code.text.exists() and code.coding.where(code = 'NP').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Flag	C	0..*	Flag	Key information to flag to healthcare providers nzcr-uncoded-flags: Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field nzcr-coded-flags: Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
flag-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Flag Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity Level - 'W' for Alert/Flag
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
extension:comments	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"comments"
value[x]		1..1	string	Value of extension
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	Business identifier
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
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.
category	SΣ	1..1	CodeableConcept	Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
extension		0..0
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
coding:fhirOrig	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: FlagCategory (required)
display	SΣ	1..1	string	Representation defined by the system
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/alert-category
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Flag Alert Category Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
code	SΣ	1..1	CodeableConcept	Coded or textual message to display to user Binding: NZ Central Region - Flag Alert Code Value Set (required)
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣ	1..1	Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure)	Who/What is flag about?
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
period	SΣ	0..1	Period	Time period when flag is active
extension		0..0
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	SΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
author	SΣ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole)	Flag creator
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Flag.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Flag.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Flag.extension:flag-alert.extension:webPASCategory.value[x]	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.extension:flag-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
Flag.extension:flag-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
Flag.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.status	required	FlagStatus 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.category.coding:fhirOrig.code	required	FlagCategory http://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard
Flag.category.coding:rawSource.code	required	NZCentralRegionFlagAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag from this IG
Flag.code	required	NZCentralRegionFlagAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-flag-alert-code from this IG
Flag.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.subject.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Flag.author.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Flag.author.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Flag.author.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type 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()
nzcr-coded-flags	error	Flag	Flag without code.text field and without NullFlavor#NP means there is Flag category is other than NHIMWS, MA & MC : code.text.exists().not() and code.coding.where(code = 'NP').exists().not() implies category.coding.where(code != 'NHIMWS' and code != 'MA' and code != 'MC').exists()
nzcr-uncoded-flags	error	Flag	Flag categories NHIMWS, MA & MC are free-text uncoded Categories, and must have NullFlavor#NP code and must have code.text field : category.coding.where(code = 'NHIMWS' or code = 'MA' or code='MC').exists() implies code.text.exists() and code.coding.where(code = 'NP').exists()

This structure is derived from Flag

Summary

Mandatory: 22 elements(14 nested mandatory elements)
Must-Support: 56 elements
Fixed: 2 elements
Prohibited: 58 elements

Extensions

This structure refers to these extensions:

• http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
• http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-type
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
• http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
• http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
• https://standards.digital.health.nz/ns/central-region/l4h-template-version
• https://standards.digital.health.nz/ns/central-region/alert

Slices

This structure defines the following Slices:

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