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: Exit Reason
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason | Version: 1.0.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
This extension may be used on the following element(s):
Usage info
Usage:
- Use this Extension: ACC ICP Episode of Care Exit Resource
- Examples for this Extension: EpisodeOfCare/icp-exit-case-other, EpisodeOfCare/icp-exit-case-with-supporting-details and EpisodeOfCare/icp-exit-case
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension |
C | 0..* | Extension | Exit Reason recovery-goal-not-achieved-or-acc-support-invariant: if 'additional-acc-support-needed' is true or reason is not 'goal-achieved', supporting-details and outcome-summary are required. not-recovery-goal-achieved-and-acc-support-invariant: if 'additional-acc-support-needed' is false and reason is 'goal-achieved', supporting-details and outcome-summary must not be populated. other-reason-invariant: if reason code is 'other', other-reason is required. not-other-reason-invariant: if reason code is not 'other', other-reason must not be populated. |
  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 (required) | |
| 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 other-reason-max250-length-invariant: 'other-reason' must be no more than 250 characters. |
| 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 supporting-details-max250-length-invariant: 'supporting-details' must be no more than 250 characters. |
 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 outcome-summary-max-length5000-invariant: 'supporting-details' must be no more than 5000 characters. |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Extension.extension:reason.value[x] | required | ICPExitReason (a valid code from Exit Reason)http://hl7.org.nz/fhir/ValueSet/acc-icp-exit-reasonfrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| not-other-reason-invariant | error | Extension | if 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-invariant | error | Extension | if '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-invariant | error | Extension | if 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-invariant | error | Extension.extension:other-reason.value[x] | 'other-reason' must be no more than 250 characters. : value.length() <= 250 | |
| outcome-summary-max-length5000-invariant | error | Extension.extension:outcome-summary.value[x] | 'supporting-details' must be no more than 5000 characters. : value.length() <= 5000 | |
| recovery-goal-not-achieved-or-acc-support-invariant | error | Extension | if '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-invariant | error | Extension.extension:supporting-details.value[x] | 'supporting-details' must be no more than 250 characters. : value.length() <= 250 |