ICP Service Bundle Change - Definitions - New Zealand ICP Implementation Guide v1.0.0

New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions

Extension: IcpServiceBundleChange - Detailed Descriptions

Active as of 2022-11-20

Definitions for the acc-icp-service-bundle-change extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An extension to capture the reason for a change in the ICP Service Bundle.
Short	ICP Service Bundle Change
Invariants	other-rationale-invariant: if 'rationale' is 'other', supporting-details is required. (`(extension.where(url='rationale').where(value = 'other').exists() implies extension.where(url='supporting-details').value.exists())`) not-other-rationale-invariant: if 'rationale' is not 'other', supporting-details must not be populated. (`(extension.where(url='rationale').where(value = 'other').empty() implies extension.where(url='supporting-details').value.empty())`)
2. Extension.extension
Control	2..?
4. Extension.extension:service-bundle
Slice Name	service-bundle
Control	1..1
Type	Extension(Service Bundle MSK) (Extension Type: code)
6. Extension.extension:rationale
Slice Name	rationale
Definition	A categorisation of the rationale for service bundle change.
Short	(other \| comorbidity-factors \| social-support \| active-participation \| patient-resilience \| medication-use \| equitable-access \| health-literacy \| cultural-support \| housing-accommodation \| finances \| travel \| return-to-daily-life \| return-to-sport \| number-of-disciplines \| employment \| workplace-support \| return-to-work-support)
Control	1..*
8. Extension.extension:rationale.extension
Control	0..0
10. Extension.extension:rationale.url
Fixed Value	`rationale`
12. Extension.extension:rationale.value[x]
Control	1..?
Binding	The codes SHALL be taken from Service Bundle Change Rationale (required to `http://hl7.org.nz/fhir/ValueSet/acc-icp-service-bundle-change-rationale`)
Type	code
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. Extension.extension:supporting-details
Slice Name	supporting-details
Definition	A reason/rationale category identifier of a modification to the ICP case's service bundle.
Short	Used to identify the category not defined in the complexity tool for a service bundle change, required when the rationale is 'other'.
Control	0..1
16. Extension.extension:supporting-details.extension
Control	0..0
18. Extension.extension:supporting-details.url
Fixed Value	`supporting-details`
20. Extension.extension:supporting-details.value[x]
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Invariants	supporting-details-max50-length-invariant: 'supporting-details' must be no more than 50 characters. (`value.length() <= 50`)
22. Extension.url
Fixed Value	`http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change`
24. Extension.value[x]
Control	0..0

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An extension to capture the reason for a change in the ICP Service Bundle. Optional Extension Element - found in all resources.
Short	ICP Service Bundle ChangeOptional Extensions Element
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) other-rationale-invariant: if 'rationale' is 'other', supporting-details is required. (`(extension.where(url='rationale').where(value = 'other').exists() implies extension.where(url='supporting-details').value.exists())`) not-other-rationale-invariant: if 'rationale' is not 'other', supporting-details must not be populated. (`(extension.where(url='rationale').where(value = 'other').empty() implies extension.where(url='supporting-details').value.empty())`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	20..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:service-bundle
Slice Name	service-bundle
Definition	Indicates the ICP service bundle MSK selected for the treatment.
Short	Service Bundle MSK
Control	1..1
Type	Extension(Service Bundle MSK) (Extension Type: code)
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Extension.extension:rationale
Slice Name	rationale
Definition	A categorisation of the rationale for service bundle change.
Short	(other \| comorbidity-factors \| social-support \| active-participation \| patient-resilience \| medication-use \| equitable-access \| health-literacy \| cultural-support \| housing-accommodation \| finances \| travel \| return-to-daily-life \| return-to-sport \| number-of-disciplines \| employment \| workplace-support \| return-to-work-support)Additional content defined by implementations
Control	10..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Extension.extension:rationale.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. Extension.extension:rationale.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`rationale`
12. Extension.extension:rationale.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	10..1
Binding	The codes SHALL be taken from For codes, see Service Bundle Change Rationale (required to `http://hl7.org.nz/fhir/ValueSet/acc-icp-service-bundle-change-rationale`)
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Extension.extension:supporting-details
Slice Name	supporting-details
Definition	A reason/rationale category identifier of a modification to the ICP case's service bundle.
Short	Used to identify the category not defined in the complexity tool for a service bundle change, required when the rationale is 'other'.Additional content defined by implementations
Control	0..1*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Extension.extension:supporting-details.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. Extension.extension:supporting-details.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`supporting-details`
20. Extension.extension:supporting-details.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) supporting-details-max50-length-invariant: 'supporting-details' must be no more than 50 characters. (`value.length() <= 50`)
22. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change`
24. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..01
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An extension to capture the reason for a change in the ICP Service Bundle.
Short	ICP Service Bundle Change
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) other-rationale-invariant: if 'rationale' is 'other', supporting-details is required. (`(extension.where(url='rationale').where(value = 'other').exists() implies extension.where(url='supporting-details').value.exists())`) not-other-rationale-invariant: if 'rationale' is not 'other', supporting-details must not be populated. (`(extension.where(url='rationale').where(value = 'other').empty() implies extension.where(url='supporting-details').value.empty())`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	2..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.extension:service-bundle
Slice Name	service-bundle
Definition	Indicates the ICP service bundle MSK selected for the treatment.
Short	Service Bundle MSK
Control	1..1
Type	Extension(Service Bundle MSK) (Extension Type: code)
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Extension.extension:rationale
Slice Name	rationale
Definition	A categorisation of the rationale for service bundle change.
Short	(other \| comorbidity-factors \| social-support \| active-participation \| patient-resilience \| medication-use \| equitable-access \| health-literacy \| cultural-support \| housing-accommodation \| finances \| travel \| return-to-daily-life \| return-to-sport \| number-of-disciplines \| employment \| workplace-support \| return-to-work-support)
Control	1..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
10. Extension.extension:rationale.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
12. Extension.extension:rationale.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
14. Extension.extension:rationale.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`rationale`
16. Extension.extension:rationale.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	1..1
Binding	The codes SHALL be taken from Service Bundle Change Rationale (required to `http://hl7.org.nz/fhir/ValueSet/acc-icp-service-bundle-change-rationale`)
Type	code
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Extension.extension:supporting-details
Slice Name	supporting-details
Definition	A reason/rationale category identifier of a modification to the ICP case's service bundle.
Short	Used to identify the category not defined in the complexity tool for a service bundle change, required when the rationale is 'other'.
Control	0..1
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. Extension.extension:supporting-details.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
22. Extension.extension:supporting-details.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
24. Extension.extension:supporting-details.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`supporting-details`
26. Extension.extension:supporting-details.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) supporting-details-max50-length-invariant: 'supporting-details' must be no more than 50 characters. (`value.length() <= 50`)
28. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change`
30. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..0
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)