Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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-consent | Version: 0.1.7 | |||
| Active as of 2026-10-13 | Computable Name: ManaakiNgaTahiConsent | |||
Consent FHIR resource for Manaaki Nga Tahi
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
  status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
 scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | |
 patient |
1..1 | Reference(Patient) | Who the consent applies to | |
  Slices for source[x] |
0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
  sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
  source[x]:sourceReference |
0..1 | Reference(QuestionnaireResponse) | Source from which this consent is taken | |
 policy |
1..* | BackboneElement | Policies covered by this consent | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
 modifierExtension |
0..0 | Extension | ||
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| Slices for source[x] |
0..1 | Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
| source[x]:sourceReference |
0..1 | Reference(QuestionnaireResponse) | Source from which this consent is taken | |
| policy |
1..* | BackboneElement | Policies covered by this consent | |
| id |
0..0 | Unique id for inter-element referencing | ||
 extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
 provision |
||||
 period |
1..1 | Period | Must be in UTC timezone on the FHIR server | |
| provision |
0..0 | Nested Exception Rules | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| 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 | Additional content defined by implementations | |
| identifier |
0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
| scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |
| performer |
0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
| organization |
0..* | Reference(Organization) | Custodian of the consent | |
| Slices for source[x] |
0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
| source[x]:sourceReference |
0..1 | Reference(QuestionnaireResponse) | Source from which this consent is taken | |
| policy |
1..* | BackboneElement | Policies covered by this consent | |
| authority |
C | 0..1 | uri | Enforcement source for policy |
| uri |
C | 0..1 | uri | Specific policy covered by this consent |
| policyRule |
C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. |
| verification |
0..* | BackboneElement | Consent Verified by patient or family | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| verified |
1..1 | boolean | Has been verified | |
| verifiedWith |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |
| verificationDate |
0..1 | dateTime | When consent verified | |
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | |
| period |
1..1 | Period | Must be in UTC timezone on the FHIR server | |
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| action |
0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | |
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| purpose |
0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | |
| class |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |
| code |
0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | |
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this rule | |
| data |
0..* | BackboneElement | Data controlled by this rule | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | |
| reference |
1..1 | Reference(Resource) | The actual data reference | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.0.1 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.type | Base | required | ConsentProvisionType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| Consent.provision.class | Base | extensible | Consent Content Class | 📍4.0.1 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
| scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| Slices for source[x] |
0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
| source[x]:sourceReference |
0..1 | Reference(QuestionnaireResponse) | Source from which this consent is taken | |
| policy |
1..* | BackboneElement | Policies covered by this consent | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| modifierExtension |
0..0 | Extension | ||
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| Slices for source[x] |
0..1 | Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
| source[x]:sourceReference |
0..1 | Reference(QuestionnaireResponse) | Source from which this consent is taken | |
| policy |
1..* | BackboneElement | Policies covered by this consent | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| provision |
||||
| period |
1..1 | Period | Must be in UTC timezone on the FHIR server | |
| provision |
0..0 | Nested Exception Rules | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| 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 | Additional content defined by implementations | |
| identifier |
0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | |
| status |
1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | |
| scope |
1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |
| category |
1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | |
| patient |
1..1 | Reference(Patient) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | When this Consent was created or indexed | |
| performer |
0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
| organization |
0..* | Reference(Organization) | Custodian of the consent | |
| Slices for source[x] |
0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
| source[x]:sourceReference |
0..1 | Reference(QuestionnaireResponse) | Source from which this consent is taken | |
| policy |
1..* | BackboneElement | Policies covered by this consent | |
| authority |
C | 0..1 | uri | Enforcement source for policy |
| uri |
C | 0..1 | uri | Specific policy covered by this consent |
| policyRule |
C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. |
| verification |
0..* | BackboneElement | Consent Verified by patient or family | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| verified |
1..1 | boolean | Has been verified | |
| verifiedWith |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |
| verificationDate |
0..1 | dateTime | When consent verified | |
| provision |
0..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | |
| period |
1..1 | Period | Must be in UTC timezone on the FHIR server | |
| actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| action |
0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | |
| securityLabel |
0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| purpose |
0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | |
| class |
0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |
| code |
0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | |
| dataPeriod |
0..1 | Period | Timeframe for data controlled by this rule | |
| data |
0..* | BackboneElement | Data controlled by this rule | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| meaning |
1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | |
| reference |
1..1 | Reference(Resource) | The actual data reference | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.status | Base | required | ConsentState | 📍4.0.1 | FHIR Std. |
| Consent.scope | Base | extensible | Consent Scope Codes | 📍4.0.1 | FHIR Std. |
| Consent.category | Base | extensible | Consent Category Codes | 📍4.0.1 | FHIR Std. |
| Consent.policyRule | Base | extensible | Consent PolicyRule Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.type | Base | required | ConsentProvisionType | 📍4.0.1 | FHIR Std. |
| Consent.provision.actor.role | Base | extensible | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Consent.provision.action | Base | example | Consent Action Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Consent.provision.purpose | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| Consent.provision.class | Base | extensible | Consent Content Class | 📍4.0.1 | FHIR Std. |
| Consent.provision.code | Base | example | Consent Content Codes | 📍4.0.1 | FHIR Std. |
| Consent.provision.data.meaning | Base | required | ConsentDataMeaning | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Other representations of profile: CSV, Excel, Schematron