Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: CommunicationPerson

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-communication-person Version: 0.0.1
Active as of 2026-07-20 Computable Name: CommunicationPerson

A person resource used to record contact preferences for a person who is part of an HNZ cohort.

Records communication preferences for a person who is part of an HNZ cohort

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean This person's record is in active use

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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 Person

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... meta
.... source 1..1 uri Identifies where the resource comes from
Binding: Information source when using the telecom information source extension (required)
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... Slices for tag 2..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
..... tag:PurposeOfUse 1..1 Coding Tags applied to this resource
Binding: NZ purpose of use (required)
..... tag:LastUpdatedBy 1..1 Coding Tags applied to this resource
Binding: System that last updated the record (required)
... contained 0..0 Contained, inline Resources
... telecom
.... Slices for extension Content/Rules for all slices
..... extension:SmartContactDetailScore 0..* (Complex) HNZ Person Telecom Score
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-score-extension-id
..... extension:SmartContactCountShared 0..1 integer HNZ Person Telecom Count Shared
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-count-shared-extension-id
..... extension:SmartContactLastContacted 0..1 dateTime HNZ Person Telecom Last Contacted
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-last-contacted-extension-id
..... extension:SmartContactPhoneType 0..1 Coding HNZ Person Telecom Phone Type
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-phone-type-extension-id
Binding: Telecom phone type indicator (required)
..... extension:SmartContactInvalidIndicator 0..1 (Complex) HNZ Person Telecom Invalid Indicator
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id
... birthDate 0..0 The date on which the person was born
... address 0..0 One or more addresses for the person
... photo 0..0 Image of the person
... link 0..0 Link to a resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Person.meta.source Base required Information source when using the telecom information source extension 📦1.0.0 This IG
Person.meta.tag:PurposeOfUse Base required NZ purpose of use 📦20240725 This IG
Person.meta.tag:LastUpdatedBy Base required System that last updated the record 📦1.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 1..1 uri Identifies where the resource comes from
Binding: Information source when using the telecom information source extension (required)
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... Slices for tag Σ 2..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... tag:PurposeOfUse Σ 1..1 Coding Tags applied to this resource
Binding: NZ purpose of use (required)
..... tag:LastUpdatedBy Σ 1..1 Coding Tags applied to this resource
Binding: System that last updated the record (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier A human identifier for this person
... name Σ 0..* HumanName A name associated with the person
... telecom Σ 0..* ContactPoint A contact detail for the person
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:SmartContactDetailScore 0..* (Complex) HNZ Person Telecom Score
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-score-extension-id
..... extension:SmartContactCountShared 0..1 integer HNZ Person Telecom Count Shared
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-count-shared-extension-id
..... extension:SmartContactLastContacted 0..1 dateTime HNZ Person Telecom Last Contacted
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-last-contacted-extension-id
..... extension:SmartContactPhoneType 0..1 Coding HNZ Person Telecom Phone Type
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-phone-type-extension-id
Binding: Telecom phone type indicator (required)
..... extension:SmartContactInvalidIndicator 0..1 (Complex) HNZ Person Telecom Invalid Indicator
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... managingOrganization Σ 0..1 Reference(Organization) The organization that is the custodian of the person record
... active ?!Σ 0..1 boolean This person's record is in active use

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.source Base required Information source when using the telecom information source extension 📦1.0.0 This IG
Person.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Person.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Person.meta.tag:PurposeOfUse Base required NZ purpose of use 📦20240725 This IG
Person.meta.tag:LastUpdatedBy Base required System that last updated the record 📦1.0.0 This IG
Person.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Person.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean This person's record is in active use

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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()

Differential View

This structure is derived from Person

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... meta
.... source 1..1 uri Identifies where the resource comes from
Binding: Information source when using the telecom information source extension (required)
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... Slices for tag 2..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
..... tag:PurposeOfUse 1..1 Coding Tags applied to this resource
Binding: NZ purpose of use (required)
..... tag:LastUpdatedBy 1..1 Coding Tags applied to this resource
Binding: System that last updated the record (required)
... contained 0..0 Contained, inline Resources
... telecom
.... Slices for extension Content/Rules for all slices
..... extension:SmartContactDetailScore 0..* (Complex) HNZ Person Telecom Score
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-score-extension-id
..... extension:SmartContactCountShared 0..1 integer HNZ Person Telecom Count Shared
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-count-shared-extension-id
..... extension:SmartContactLastContacted 0..1 dateTime HNZ Person Telecom Last Contacted
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-last-contacted-extension-id
..... extension:SmartContactPhoneType 0..1 Coding HNZ Person Telecom Phone Type
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-phone-type-extension-id
Binding: Telecom phone type indicator (required)
..... extension:SmartContactInvalidIndicator 0..1 (Complex) HNZ Person Telecom Invalid Indicator
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id
... birthDate 0..0 The date on which the person was born
... address 0..0 One or more addresses for the person
... photo 0..0 Image of the person
... link 0..0 Link to a resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Person.meta.source Base required Information source when using the telecom information source extension 📦1.0.0 This IG
Person.meta.tag:PurposeOfUse Base required NZ purpose of use 📦20240725 This IG
Person.meta.tag:LastUpdatedBy Base required System that last updated the record 📦1.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person A generic person record
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 1..1 uri Identifies where the resource comes from
Binding: Information source when using the telecom information source extension (required)
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... Slices for tag Σ 2..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... tag:PurposeOfUse Σ 1..1 Coding Tags applied to this resource
Binding: NZ purpose of use (required)
..... tag:LastUpdatedBy Σ 1..1 Coding Tags applied to this resource
Binding: System that last updated the record (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier A human identifier for this person
... name Σ 0..* HumanName A name associated with the person
... telecom Σ 0..* ContactPoint A contact detail for the person
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:SmartContactDetailScore 0..* (Complex) HNZ Person Telecom Score
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-score-extension-id
..... extension:SmartContactCountShared 0..1 integer HNZ Person Telecom Count Shared
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-count-shared-extension-id
..... extension:SmartContactLastContacted 0..1 dateTime HNZ Person Telecom Last Contacted
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-last-contacted-extension-id
..... extension:SmartContactPhoneType 0..1 Coding HNZ Person Telecom Phone Type
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-phone-type-extension-id
Binding: Telecom phone type indicator (required)
..... extension:SmartContactInvalidIndicator 0..1 (Complex) HNZ Person Telecom Invalid Indicator
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-telecom-invalid-indicator-extension-id
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... managingOrganization Σ 0..1 Reference(Organization) The organization that is the custodian of the person record
... active ?!Σ 0..1 boolean This person's record is in active use

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.source Base required Information source when using the telecom information source extension 📦1.0.0 This IG
Person.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Person.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Person.meta.tag:PurposeOfUse Base required NZ purpose of use 📦20240725 This IG
Person.meta.tag:LastUpdatedBy Base required System that last updated the record 📦1.0.0 This IG
Person.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Person.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Person.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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()

 

Other representations of profile: CSV, Excel, Schematron