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
• JSON

Resource Profile: ACC ICP Patient

The ACC ICP Patient resource based on NzPatient. Used to verify that an ICP Case has a valid claim.

An ICP Patient resource is used within an Icp Case, as a data point to verify weither an Icp case has a valid claim

Usages:

• Use this Profile: ACC ICP Patient Referral for BIST, ACC ICP Case Create Resource, ACC ICP Episode of Care Exit Resource, ACC ICP Episode of Care Service Bundle Update Resource... Show 6 more, ACC Integrated Care Pathway Observation, ACC ICP MSK Case Create Resource, ACC ICP Referral Decline Resource, ACC ICP TBI Case Create Resource, ACC ICP Episode of Care Exit Resource and ACC ICP Referral Decline Resource
• Refer to this Profile: ACC ICP Patient Referral for BIST, ACC ICP Episode of Care Resource, ACC Integrated Care Pathway Observation, ACC ICP Referral Decline Resource... Show 5 more, ACC Integrated Care Pathway TBI BIST, ACC Integrated Care Pathway TBI Cover and Causation, ACC ICP Referral Decline Resource, ACC Integrated Care Pathway TBI Start C and ACC Patient Referral

You can also check for usages in the FHIR IG Statistics

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 Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier
period		0..0		Time period when id is/was valid for use
active		0..0		Whether this patient's record is in active use
name
text		0..0		Text representation of the full name
period		0..0		Time period when name was/is in use
birthDate	C	1..1	date	The date of birth for the individual Constraints: date-invariant, date-not-in-future-invariant
maritalStatus		0..0		Marital (civil) status of a patient
multipleBirth[x]		0..0		Whether patient is part of a multiple birth
photo		0..0		Image of the patient
contact		0..0		A contact party (e.g. guardian, partner, friend) for the patient
communication		0..0		A language which may be used to communicate with the patient about his or her health
managingOrganization		0..0		Organization that is the custodian of the patient record
link		0..0		Link to another patient resource that concerns the same actual person
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
date-invariant	error	Patient.birthDate	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	Patient.birthDate	The date value cannot be in the future	$this <= today()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
birthDate	ΣC	1..1	date	The date of birth for the individual Constraints: date-invariant, date-not-in-future-invariant
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
date-invariant	error	Patient.birthDate	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	Patient.birthDate	The date value cannot be in the future	$this <= today()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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())
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
Patient		0..*	Patient	Information about an individual or animal receiving health care services
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
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
name	Σ	0..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	ΣC	1..1	date	The date of birth for the individual Constraints: date-invariant, date-not-in-future-invariant
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	Address	An address for the individual
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
date-invariant	error	Patient.birthDate	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	Patient.birthDate	The date value cannot be in the future	$this <= today()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Patient

Summary

Mandatory: 1 element
Prohibited: 11 elements

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier
period		0..0		Time period when id is/was valid for use
active		0..0		Whether this patient's record is in active use
name
text		0..0		Text representation of the full name
period		0..0		Time period when name was/is in use
birthDate	C	1..1	date	The date of birth for the individual Constraints: date-invariant, date-not-in-future-invariant
maritalStatus		0..0		Marital (civil) status of a patient
multipleBirth[x]		0..0		Whether patient is part of a multiple birth
photo		0..0		Image of the patient
contact		0..0		A contact party (e.g. guardian, partner, friend) for the patient
communication		0..0		A language which may be used to communicate with the patient about his or her health
managingOrganization		0..0		Organization that is the custodian of the patient record
link		0..0		Link to another patient resource that concerns the same actual person
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
date-invariant	error	Patient.birthDate	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	Patient.birthDate	The date value cannot be in the future	$this <= today()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
birthDate	ΣC	1..1	date	The date of birth for the individual Constraints: date-invariant, date-not-in-future-invariant
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
date-invariant	error	Patient.birthDate	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	Patient.birthDate	The date value cannot be in the future	$this <= today()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
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
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations 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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
name	Σ	0..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	ΣC	1..1	date	The date of birth for the individual Constraints: date-invariant, date-not-in-future-invariant
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	Address	An address for the individual
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
date-invariant	error	Patient.birthDate	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	Patient.birthDate	The date value cannot be in the future	$this <= today()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Patient

Summary

Mandatory: 1 element
Prohibited: 11 elements

Other representations of profile: CSV, Excel, Schematron