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

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: ACC ICP Episode of Care Exit Resource

This profile supports suppliers needing to inform ACC of a patient being exited from their ICP service.

Usages:

• Examples for this Profile: EpisodeOfCare/icp-tbi-exit-case

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 IcpCase

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	IcpCase	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: finished-status-invariant
contained		1..*	Resource	Contained, inline Resources
Slices for contained				Content/Rules for all slices
contained:patient		1..1	IcpPatient	Information about an individual or animal receiving health care services
extension		2..2	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:exit-reason		1..1	(Complex)	Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason
Slices for extension				Content/Rules for all slices
extension:reason		1..1	Extension	Extension
value[x]		1..1	code	Value of extension Binding: Exit Reason (required)
status		1..1	code	active | finished
type		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EpisodeOfCare.extension:exit-reason.extension:reason.value[x]	required	ICPTbiExitReason http://hl7.org.nz/fhir/ValueSet/acc-icp-tbi-exit-reason From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
finished-status-invariant	error	EpisodeOfCare	The status attribute must be set to 'finished'. : status = 'finished'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	IcpCase	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, finished-status-invariant
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
contained:patient		1..1	IcpPatient	Information about an individual or animal receiving health care services
Slices for extension		2..2	Extension	Extension Slice: Unordered, Open by value:url
extension:acc-providerid		1..1	string	The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
extension:exit-reason		1..1	(Complex)	Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason
Slices for extension		2..5	Extension	Extension Slice: Unordered, Open by value:url
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"
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"
extension:outcome-summary		0..1	Extension	A summary of the client's recovery outcome.
extension		0..0
url		1..1	uri	"outcome-summary"
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:icpclaimnumber		1..1	Identifier	The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
value	ΣC	1..1	string	The ACC 45 number. Constraints: acc-claim-number Example General: 123456
status	?!Σ	1..1	code	active | finished Binding: Status (required)
patient	Σ	1..1	Reference(ACC ICP Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.extension:exit-reason.extension:reason.value[x]	required	ICPTbiExitReason http://hl7.org.nz/fhir/ValueSet/acc-icp-tbi-exit-reason From this IG
EpisodeOfCare.identifier:icpclaimnumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
EpisodeOfCare.status	required	ICPStatusVS http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status From this IG
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type.coding.code	required	ICPServiceType(a valid code from Service Type) http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
acc-claim-number	error	EpisodeOfCare.identifier:icpclaimnumber.value	The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dom-2	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	EpisodeOfCare	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	EpisodeOfCare	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	EpisodeOfCare	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	EpisodeOfCare	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())
end-date-when-active-invariant	error	EpisodeOfCare	End date is not allowed when status is active : status = 'active' implies period.end.empty()
end-date-when-finished-invariant	error	EpisodeOfCare	End date is required when status is finished : status = 'finished' implies period.end.exists()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
finished-status-invariant	error	EpisodeOfCare	The status attribute must be set to 'finished'. : status = 'finished'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	IcpCase	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, finished-status-invariant
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
contained:patient		1..1	IcpPatient	Information about an individual or animal receiving health care services
Slices for extension		2..2	Extension	Extension Slice: Unordered, Open by value:url
extension:acc-providerid		1..1	string	The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
extension:exit-reason		1..1	(Complex)	Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason
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 (required)
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"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:icpclaimnumber		1..1	Identifier	The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
value	ΣC	1..1	string	The ACC 45 number. Constraints: acc-claim-number Example General: 123456
status	?!Σ	1..1	code	active | finished Binding: Status (required)
patient	Σ	1..1	Reference(ACC ICP Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
period	Σ	0..1	Period	Interval during responsibility is assumed
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: date-invariant, date-not-in-future-invariant
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: date-invariant, date-not-in-future-invariant
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.extension:exit-reason.extension:reason.value[x]	required	ICPTbiExitReason http://hl7.org.nz/fhir/ValueSet/acc-icp-tbi-exit-reason From this IG
EpisodeOfCare.identifier:icpclaimnumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
EpisodeOfCare.identifier:icpclaimnumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
EpisodeOfCare.status	required	ICPStatusVS http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status From this IG
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type.coding.code	required	ICPServiceType(a valid code from Service Type) http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type From this IG
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
acc-claim-number	error	EpisodeOfCare.identifier:icpclaimnumber.value	The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
date-invariant	error	EpisodeOfCare.period.start, EpisodeOfCare.period.end	All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
date-not-in-future-invariant	error	EpisodeOfCare.period.start, EpisodeOfCare.period.end	The date value cannot be in the future : $this <= today()
dom-2	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	EpisodeOfCare	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	EpisodeOfCare	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	EpisodeOfCare	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	EpisodeOfCare	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())
end-date-when-active-invariant	error	EpisodeOfCare	End date is not allowed when status is active : status = 'active' implies period.end.empty()
end-date-when-finished-invariant	error	EpisodeOfCare	End date is required when status is finished : status = 'finished' implies period.end.exists()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
finished-status-invariant	error	EpisodeOfCare	The status attribute must be set to 'finished'. : status = 'finished'
other-reason-max250-length-invariant	error	EpisodeOfCare.extension:exit-reason.extension:other-reason.value[x]	'other-reason' must be no more than 250 characters. : value.length() <= 250
outcome-summary-max-length5000-invariant	error	EpisodeOfCare.extension:exit-reason.extension:outcome-summary.value[x]	'supporting-details' must be no more than 5000 characters. : value.length() <= 5000
supporting-details-max250-length-invariant	error	EpisodeOfCare.extension:exit-reason.extension:supporting-details.value[x]	'supporting-details' must be no more than 250 characters. : value.length() <= 250

This structure is derived from IcpCase

Summary

Mandatory: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• ACC ICP Patient (http://hl7.org.nz/fhir/StructureDefinition/acc-icp-patient)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason

Differential View

This structure is derived from IcpCase

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	IcpCase	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: finished-status-invariant
contained		1..*	Resource	Contained, inline Resources
Slices for contained				Content/Rules for all slices
contained:patient		1..1	IcpPatient	Information about an individual or animal receiving health care services
extension		2..2	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:exit-reason		1..1	(Complex)	Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason
Slices for extension				Content/Rules for all slices
extension:reason		1..1	Extension	Extension
value[x]		1..1	code	Value of extension Binding: Exit Reason (required)
status		1..1	code	active | finished
type		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EpisodeOfCare.extension:exit-reason.extension:reason.value[x]	required	ICPTbiExitReason http://hl7.org.nz/fhir/ValueSet/acc-icp-tbi-exit-reason From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
finished-status-invariant	error	EpisodeOfCare	The status attribute must be set to 'finished'. : status = 'finished'

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	IcpCase	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, finished-status-invariant
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
contained:patient		1..1	IcpPatient	Information about an individual or animal receiving health care services
Slices for extension		2..2	Extension	Extension Slice: Unordered, Open by value:url
extension:acc-providerid		1..1	string	The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
extension:exit-reason		1..1	(Complex)	Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason
Slices for extension		2..5	Extension	Extension Slice: Unordered, Open by value:url
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"
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"
extension:outcome-summary		0..1	Extension	A summary of the client's recovery outcome.
extension		0..0
url		1..1	uri	"outcome-summary"
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:icpclaimnumber		1..1	Identifier	The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
value	ΣC	1..1	string	The ACC 45 number. Constraints: acc-claim-number Example General: 123456
status	?!Σ	1..1	code	active | finished Binding: Status (required)
patient	Σ	1..1	Reference(ACC ICP Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.extension:exit-reason.extension:reason.value[x]	required	ICPTbiExitReason http://hl7.org.nz/fhir/ValueSet/acc-icp-tbi-exit-reason From this IG
EpisodeOfCare.identifier:icpclaimnumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
EpisodeOfCare.status	required	ICPStatusVS http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status From this IG
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type.coding.code	required	ICPServiceType(a valid code from Service Type) http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
acc-claim-number	error	EpisodeOfCare.identifier:icpclaimnumber.value	The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dom-2	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	EpisodeOfCare	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	EpisodeOfCare	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	EpisodeOfCare	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	EpisodeOfCare	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())
end-date-when-active-invariant	error	EpisodeOfCare	End date is not allowed when status is active : status = 'active' implies period.end.empty()
end-date-when-finished-invariant	error	EpisodeOfCare	End date is required when status is finished : status = 'finished' implies period.end.exists()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
finished-status-invariant	error	EpisodeOfCare	The status attribute must be set to 'finished'. : status = 'finished'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	IcpCase	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, finished-status-invariant
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
contained:patient		1..1	IcpPatient	Information about an individual or animal receiving health care services
Slices for extension		2..2	Extension	Extension Slice: Unordered, Open by value:url
extension:acc-providerid		1..1	string	The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
extension:exit-reason		1..1	(Complex)	Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason
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 (required)
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"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		1..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:icpclaimnumber		1..1	Identifier	The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
value	ΣC	1..1	string	The ACC 45 number. Constraints: acc-claim-number Example General: 123456
status	?!Σ	1..1	code	active | finished Binding: Status (required)
patient	Σ	1..1	Reference(ACC ICP Patient)	The patient who is the focus of this episode of care
managingOrganization	Σ	1..1	Reference(Organization)	This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
period	Σ	0..1	Period	Interval during responsibility is assumed
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: date-invariant, date-not-in-future-invariant
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: date-invariant, date-not-in-future-invariant
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.extension:exit-reason.extension:reason.value[x]	required	ICPTbiExitReason http://hl7.org.nz/fhir/ValueSet/acc-icp-tbi-exit-reason From this IG
EpisodeOfCare.identifier:icpclaimnumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
EpisodeOfCare.identifier:icpclaimnumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
EpisodeOfCare.status	required	ICPStatusVS http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status From this IG
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 From the FHIR Standard
EpisodeOfCare.type.coding.code	required	ICPServiceType(a valid code from Service Type) http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type From this IG
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
acc-claim-number	error	EpisodeOfCare.identifier:icpclaimnumber.value	The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
date-invariant	error	EpisodeOfCare.period.start, EpisodeOfCare.period.end	All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
date-not-in-future-invariant	error	EpisodeOfCare.period.start, EpisodeOfCare.period.end	The date value cannot be in the future : $this <= today()
dom-2	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	EpisodeOfCare	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	EpisodeOfCare	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	EpisodeOfCare	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	EpisodeOfCare	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())
end-date-when-active-invariant	error	EpisodeOfCare	End date is not allowed when status is active : status = 'active' implies period.end.empty()
end-date-when-finished-invariant	error	EpisodeOfCare	End date is required when status is finished : status = 'finished' implies period.end.exists()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
finished-status-invariant	error	EpisodeOfCare	The status attribute must be set to 'finished'. : status = 'finished'
other-reason-max250-length-invariant	error	EpisodeOfCare.extension:exit-reason.extension:other-reason.value[x]	'other-reason' must be no more than 250 characters. : value.length() <= 250
outcome-summary-max-length5000-invariant	error	EpisodeOfCare.extension:exit-reason.extension:outcome-summary.value[x]	'supporting-details' must be no more than 5000 characters. : value.length() <= 5000
supporting-details-max250-length-invariant	error	EpisodeOfCare.extension:exit-reason.extension:supporting-details.value[x]	'supporting-details' must be no more than 250 characters. : value.length() <= 250

This structure is derived from IcpCase

Summary

Mandatory: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• ACC ICP Patient (http://hl7.org.nz/fhir/StructureDefinition/acc-icp-patient)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason

Other representations of profile: CSV, Excel, Schematron