Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-communication-person | Version: 0.0.1 | |||
| Active as of 2025-06-05 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Path | Conformance | ValueSet | URI |
| Person.meta.source | required | TelecomInfoSource(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-information-source-valuesetFrom this IG | |
| Person.meta.tag:PurposeOfUse | required | NZPurposeOfUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-purpose-of-use-value-setFrom this IG | |
| Person.meta.tag:LastUpdatedBy | required | TelecomLastUpdatedBy(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-last-updated-by-valuesetFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Person.meta.source | required | TelecomInfoSource(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-information-source-valuesetFrom this IG | ||||
| Person.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Person.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Person.meta.tag:PurposeOfUse | required | NZPurposeOfUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-purpose-of-use-value-setFrom this IG | ||||
| Person.meta.tag:LastUpdatedBy | required | TelecomLastUpdatedBy(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-last-updated-by-valuesetFrom this IG | ||||
| Person.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Person.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Person.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | ||||
| Person.link.assurance | required | IdentityAssuranceLevelhttp://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 0 element(4 nested mandatory elements)
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Path | Conformance | ValueSet | URI |
| Person.meta.source | required | TelecomInfoSource(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-information-source-valuesetFrom this IG | |
| Person.meta.tag:PurposeOfUse | required | NZPurposeOfUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-purpose-of-use-value-setFrom this IG | |
| Person.meta.tag:LastUpdatedBy | required | TelecomLastUpdatedBy(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-last-updated-by-valuesetFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Person.meta.source | required | TelecomInfoSource(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-information-source-valuesetFrom this IG | ||||
| Person.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Person.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Person.meta.tag:PurposeOfUse | required | NZPurposeOfUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-purpose-of-use-value-setFrom this IG | ||||
| Person.meta.tag:LastUpdatedBy | required | TelecomLastUpdatedBy(a valid code from Codes for Telecom Source Systems)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-telecom-last-updated-by-valuesetFrom this IG | ||||
| Person.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Person.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Person.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | ||||
| Person.link.assurance | required | IdentityAssuranceLevelhttp://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 0 element(4 nested mandatory elements)
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
