New Zealand ICP Implementation Guide
1.1.0 - draft

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.1.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: Exit Reason

Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason Version: 1.1.0
Active as of 2022-11-20 Computable Name: Icp_ExitReason

Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved.

Integrated Care Pathways Exit Reason

Context of Use

This extension may be used on the following element(s):

  • Element ID EpisodeOfCare
  • Element ID EpisodeOfCare.extension

Usage info

Usages:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: Integrated Care Pathways Exit Reason

  • reason: code: An Extension
  • other-reason: string: An Extension
  • additional-acc-support-needed: boolean: An Extension
  • supporting-details: string: A paragraph outlining the reason/rationale for the client exit. Required when the exit reason is not 'Recovery goal achieved' or additional ACC support required.
  • outcome-summary: string: A summary of the client's recovery outcome. Required when the exit reason is not 'Recovery goal achieved' or additional ACC support required.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Exit Reason
Constraints: recovery-goal-not-achieved-or-acc-support-invariant, not-recovery-goal-achieved-and-acc-support-invariant, other-reason-invariant, not-other-reason-invariant
... extension 2..5 Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:reason 1..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "reason"
..... value[x] 1..1 code Value of extension
Binding: Exit Reason (preferred)
.... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
..... extension 0..0
..... url 1..1 uri "other-reason"
..... value[x] C 0..1 string Value of extension
Constraints: other-reason-max250-length-invariant
.... extension:additional-acc-support-needed 1..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "additional-acc-support-needed"
..... value[x] 1..1 boolean Value of extension
.... extension:supporting-details 0..1 Extension Used to explain the client exit reason not being 'Recovery goal achieved'.
..... extension 0..0
..... url 1..1 uri "supporting-details"
..... value[x] C 0..1 string Value of extension
Constraints: supporting-details-max250-length-invariant
.... extension:outcome-summary 0..1 Extension A summary of the client's recovery outcome.
..... extension 0..0
..... url 1..1 uri "outcome-summary"
..... value[x] C 0..1 string Value of extension
Constraints: outcome-summary-max-length5000-invariant
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Exit Reason
Constraints: recovery-goal-not-achieved-or-acc-support-invariant, not-recovery-goal-achieved-and-acc-support-invariant, other-reason-invariant, not-other-reason-invariant
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..5 Extension Extension
Slice: Unordered, Open by value:url
.... extension:reason 1..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "reason"
..... value[x] 1..1 code Value of extension
Binding: Exit Reason (preferred)
.... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "other-reason"
..... value[x] C 0..1 string Value of extension
Constraints: other-reason-max250-length-invariant
.... extension:additional-acc-support-needed 1..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "additional-acc-support-needed"
..... value[x] 1..1 boolean Value of extension
.... extension:supporting-details 0..1 Extension Used to explain the client exit reason not being 'Recovery goal achieved'.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "supporting-details"
..... value[x] C 0..1 string Value of extension
Constraints: supporting-details-max250-length-invariant
.... extension:outcome-summary 0..1 Extension A summary of the client's recovery outcome.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "outcome-summary"
..... value[x] C 0..1 string Value of extension
Constraints: outcome-summary-max-length5000-invariant
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Integrated Care Pathways Exit Reason

  • reason: code: An Extension
  • other-reason: string: An Extension
  • additional-acc-support-needed: boolean: An Extension
  • supporting-details: string: A paragraph outlining the reason/rationale for the client exit. Required when the exit reason is not 'Recovery goal achieved' or additional ACC support required.
  • outcome-summary: string: A summary of the client's recovery outcome. Required when the exit reason is not 'Recovery goal achieved' or additional ACC support required.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Exit Reason
Constraints: recovery-goal-not-achieved-or-acc-support-invariant, not-recovery-goal-achieved-and-acc-support-invariant, other-reason-invariant, not-other-reason-invariant
... extension 2..5 Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:reason 1..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "reason"
..... value[x] 1..1 code Value of extension
Binding: Exit Reason (preferred)
.... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
..... extension 0..0
..... url 1..1 uri "other-reason"
..... value[x] C 0..1 string Value of extension
Constraints: other-reason-max250-length-invariant
.... extension:additional-acc-support-needed 1..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "additional-acc-support-needed"
..... value[x] 1..1 boolean Value of extension
.... extension:supporting-details 0..1 Extension Used to explain the client exit reason not being 'Recovery goal achieved'.
..... extension 0..0
..... url 1..1 uri "supporting-details"
..... value[x] C 0..1 string Value of extension
Constraints: supporting-details-max250-length-invariant
.... extension:outcome-summary 0..1 Extension A summary of the client's recovery outcome.
..... extension 0..0
..... url 1..1 uri "outcome-summary"
..... value[x] C 0..1 string Value of extension
Constraints: outcome-summary-max-length5000-invariant
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Exit Reason
Constraints: recovery-goal-not-achieved-or-acc-support-invariant, not-recovery-goal-achieved-and-acc-support-invariant, other-reason-invariant, not-other-reason-invariant
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..5 Extension Extension
Slice: Unordered, Open by value:url
.... extension:reason 1..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "reason"
..... value[x] 1..1 code Value of extension
Binding: Exit Reason (preferred)
.... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "other-reason"
..... value[x] C 0..1 string Value of extension
Constraints: other-reason-max250-length-invariant
.... extension:additional-acc-support-needed 1..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "additional-acc-support-needed"
..... value[x] 1..1 boolean Value of extension
.... extension:supporting-details 0..1 Extension Used to explain the client exit reason not being 'Recovery goal achieved'.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "supporting-details"
..... value[x] C 0..1 string Value of extension
Constraints: supporting-details-max250-length-invariant
.... extension:outcome-summary 0..1 Extension A summary of the client's recovery outcome.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "outcome-summary"
..... value[x] C 0..1 string Value of extension
Constraints: outcome-summary-max-length5000-invariant
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:reason.value[x]preferredICPExitReason
http://hl7.org.nz/fhir/ValueSet/acc-icp-exit-reason
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
not-other-reason-invarianterrorExtensionif reason code is not 'other', other-reason must not be populated.
: (extension.where(url='reason').value != 'other' implies extension.where(url='other-reason').value.empty())
not-recovery-goal-achieved-and-acc-support-invarianterrorExtensionif 'additional-acc-support-needed' is false and reason is 'goal-achieved', supporting-details and outcome-summary must not be populated.
: ((extension.where(url='additional-acc-support-needed').value = false and extension.where(url='reason').value = 'goal-achieved') implies (extension.where(url='supporting-details').value.empty() and extension.where(url='outcome-summary').value.empty()))
other-reason-invarianterrorExtensionif reason code is 'other', other-reason is required.
: (extension.where(url='reason').value = 'other' implies extension.where(url='other-reason').value.exists())
other-reason-max250-length-invarianterrorExtension.extension:other-reason.value[x]'other-reason' must be no more than 250 characters.
: value.length() <= 250
outcome-summary-max-length5000-invarianterrorExtension.extension:outcome-summary.value[x]'supporting-details' must be no more than 5000 characters.
: value.length() <= 5000
recovery-goal-not-achieved-or-acc-support-invarianterrorExtensionif 'additional-acc-support-needed' is true or reason is not 'goal-achieved', supporting-details and outcome-summary are required.
: ((extension.where(url='additional-acc-support-needed').value = true or extension.where(url='reason').value != 'goal-achieved') implies (extension.where(url='supporting-details').value.exists() and extension.where(url='outcome-summary').value.exists()))
supporting-details-max250-length-invarianterrorExtension.extension:supporting-details.value[x]'supporting-details' must be no more than 250 characters.
: value.length() <= 250