Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	EpisodeOfCare	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
contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
Slices for extension		1..*	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
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.
id		0..0		Unique id for inter-element referencing
extension		0..0		Extension
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
period		0..0		Time period when id is/was valid for use
assigner		0..0		Organization that issued id (may be just text)
status		1..1	code	active | finished Binding: Status (required)
statusHistory		0..0		Past list of status codes (the current status may be included to cover the start date of the status)
type		0..1	CodeableConcept	The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
code		1..1	code	(msk) Binding: Service Type (required)
diagnosis		0..0		The list of diagnosis relevant to this episode of care
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
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
referralRequest		0..0		Originating Referral Request(s)
careManager		0..0		Care manager/care coordinator for the patient
team		0..0		Other practitioners facilitating this episode of care
account		0..0		The set of accounts that may be used for billing for this EpisodeOfCare
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
EpisodeOfCare.status	Base	required	Status	📦1.1.0	This IG
EpisodeOfCare.type.coding.​code	Base	required	Service Type	📦1.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	EpisodeOfCare	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
Slices for extension		1..*	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
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		Extension Slice: Unordered, Open by value:url
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)
type	Σ	0..1	CodeableConcept	The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
code	Σ	1..1	code	(msk) Binding: Service Type (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	Status	Usage	ValueSet	Version	Source
EpisodeOfCare.identifier:icpclaimnumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
EpisodeOfCare.status	Base	required	Status	📦1.1.0	This IG
EpisodeOfCare.statusHistory.​status	Base	required	EpisodeOfCareStatus	📍4.0.1	FHIR Std.
EpisodeOfCare.type	Base	example	Episode of care type	📍4.0.1	FHIR Std.
EpisodeOfCare.type.coding.​code	Base	required	Service Type	📦1.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	EpisodeOfCare	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
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
contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
Slices for extension		1..*	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
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		Extension Slice: Unordered, Open by value:url
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)
type	Σ	0..1	CodeableConcept	The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	(msk) Binding: Service Type (required)
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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	Status	Usage	ValueSet	Version	Source
EpisodeOfCare.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
EpisodeOfCare.identifier:icpclaimnumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
EpisodeOfCare.identifier:icpclaimnumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
EpisodeOfCare.status	Base	required	Status	📦1.1.0	This IG
EpisodeOfCare.statusHistory.​status	Base	required	EpisodeOfCareStatus	📍4.0.1	FHIR Std.
EpisodeOfCare.type	Base	example	Episode of care type	📍4.0.1	FHIR Std.
EpisodeOfCare.type.coding.​code	Base	required	Service Type	📦1.1.0	This IG
EpisodeOfCare.diagnosis.​role	Base	preferred	DiagnosisRole	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Summary

Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 10 elements

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-providerid

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of EpisodeOfCare.contained
• The element 1 is sliced based on the value of EpisodeOfCare.identifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	EpisodeOfCare	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
contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
Slices for extension		1..*	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
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.
id		0..0		Unique id for inter-element referencing
extension		0..0		Extension
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
period		0..0		Time period when id is/was valid for use
assigner		0..0		Organization that issued id (may be just text)
status		1..1	code	active | finished Binding: Status (required)
statusHistory		0..0		Past list of status codes (the current status may be included to cover the start date of the status)
type		0..1	CodeableConcept	The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
code		1..1	code	(msk) Binding: Service Type (required)
diagnosis		0..0		The list of diagnosis relevant to this episode of care
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
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
referralRequest		0..0		Originating Referral Request(s)
careManager		0..0		Care manager/care coordinator for the patient
team		0..0		Other practitioners facilitating this episode of care
account		0..0		The set of accounts that may be used for billing for this EpisodeOfCare
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
EpisodeOfCare.status	Base	required	Status	📦1.1.0	This IG
EpisodeOfCare.type.coding.​code	Base	required	Service Type	📦1.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	EpisodeOfCare	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
Slices for extension		1..*	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
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		Extension Slice: Unordered, Open by value:url
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)
type	Σ	0..1	CodeableConcept	The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
code	Σ	1..1	code	(msk) Binding: Service Type (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	Status	Usage	ValueSet	Version	Source
EpisodeOfCare.identifier:icpclaimnumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
EpisodeOfCare.status	Base	required	Status	📦1.1.0	This IG
EpisodeOfCare.statusHistory.​status	Base	required	EpisodeOfCareStatus	📍4.0.1	FHIR Std.
EpisodeOfCare.type	Base	example	Episode of care type	📍4.0.1	FHIR Std.
EpisodeOfCare.type.coding.​code	Base	required	Service Type	📦1.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
EpisodeOfCare	C	0..*	EpisodeOfCare	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
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
contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Open by profile:$this
Slices for extension		1..*	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
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		Extension Slice: Unordered, Open by value:url
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)
type	Σ	0..1	CodeableConcept	The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	(msk) Binding: Service Type (required)
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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	Status	Usage	ValueSet	Version	Source
EpisodeOfCare.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
EpisodeOfCare.identifier:icpclaimnumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
EpisodeOfCare.identifier:icpclaimnumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
EpisodeOfCare.status	Base	required	Status	📦1.1.0	This IG
EpisodeOfCare.statusHistory.​status	Base	required	EpisodeOfCareStatus	📍4.0.1	FHIR Std.
EpisodeOfCare.type	Base	example	Episode of care type	📍4.0.1	FHIR Std.
EpisodeOfCare.type.coding.​code	Base	required	Service Type	📦1.1.0	This IG
EpisodeOfCare.diagnosis.​role	Base	preferred	DiagnosisRole	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Summary

Mandatory: 7 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 10 elements

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-providerid

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of EpisodeOfCare.contained
• The element 1 is sliced based on the value of EpisodeOfCare.identifier