SDHRConsent - NZ Shared Digital Health Record API v1.1.6

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Resource Profile: SDHRConsent

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRConsent				Version: 1.1.6
Active as of 2026-10-20				Computable Name: SDHRConsent

Consent resource created to reflect a patient's preferences with regard to sharing their information with authorised health workers via the shared digital health record service. Note that this is a protected resource and scopes required to manage this resource are not provisioned to most API consumers. Facility participation preferences are managed by the Participate Operation. Health NZ channels manage global choices through HNZ Participate and independent domain choices through HNZ Domain Participate. For more details on the participate operation see SDHR Custom Operations.

Usage of this resource

Usages:

This Profile is not used by any profiles in this Specification

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.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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
Consent.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Consent.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Consent.status	This element is a modifier element. This element is included in summaries.	1..1	code	The state of the Consent. This must be active to release data from the server Binding: ConsentState (required): Indicates the state of the consent.
Consent.scope	This element is a modifier element. This element is included in summaries.	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.category	This element is included in summaries.	1..1	CodeableConcept	The category of the consent, which is a code that indicates the type of consent Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Fixed Value: `{ "coding" : [ { "system" : "http://snomed.info/sct", "code" : "887031000000108" } ] }`
Consent.patient	This element is included in summaries.	1..1	Reference(Patient)	Who the consent applies to
Consent.patient.reference	This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
Consent.patient.type	This element is included in summaries.	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient (extensions allowed)
Consent.policy		1..*	BackboneElement	Policies covered by this consent
Consent.policy.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision	This element is included in summaries. C	1..1	BackboneElement	The provision of the consent, which may be a permit or deny Constraints: sdhr-unique-domain
Consent.provision.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:HNZGlobalOptOutReasonExtension		0..1	code	The reason for the HNZ global opt-off URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-global-opt-out-reason-extension Binding: ValueSet for HNZ Global Opt Out Reason (required)
Consent.provision.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision.type	This element is included in summaries.	1..1	code	The type of consent, either permit or deny Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.action	This element is included in summaries.	1..*	CodeableConcept	The action that is being permitted or denied Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.Slices for provision		0..*	BackboneElement	Nested Exception Rules Slice: Unordered, Open by value:class.system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices				Content/Rules for all slices
Consent.provision.Slices for provision.provision:All Slices.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:All Slices.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision.Slices for provision.provision:domainParticipation		0..*	BackboneElement	Nested Exception Rules
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension				Content/Rules for all slices
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:lastUpdated		1..1	instant	Domain Participation Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/domain-participation-last-updated
Consent.provision.Slices for provision.provision:domainParticipation.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision.Slices for provision.provision:domainParticipation.type	This element is included in summaries.	1..1	code	deny \| permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.Slices for provision.provision:domainParticipation.class	This element is included in summaries.	1..1	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: SDHR Data Domains (required)
Consent.provision.Slices for provision.provision:domainParticipation.class.system	This element is included in summaries.	1..1	uri	Identity of the terminology system Required Pattern: https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains (extensions allowed)
Documentation for this format

Terminology Bindings

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.patient.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Consent.provision.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.action	Base	example	Consent Action Codes	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.actor.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.class	Base	required	SDHR Data Domains	📦1.1.6	This IG
Consent.provision.provision:domainParticipation.data.meaning	Base	required	ConsentDataMeaning	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Consent	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	Consent	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	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Consent	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()`
nhi-url-format	error	Consent.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	`matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}\|[0-9]{2}[A-Z]{2})$')`
ppc-1	error	Consent	Either a Policy or PolicyRule	`policy.exists() or policyRule.exists()`
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()`
ppc-3	error	Consent	IF Scope=research, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='research').exists().not()`
ppc-4	error	Consent	IF Scope=adr, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()`
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()`
sdhr-unique-domain	error	Consent.provision	Each domain may have only one recorded participation choice.	`provision.where(class.where(system = 'https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains').exists()).class.code.isDistinct()`

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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
Consent.status		1..1	code	The state of the Consent. This must be active to release data from the server
Consent.scope		1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.category		1..1	CodeableConcept	The category of the consent, which is a code that indicates the type of consent Fixed Value: `{ "coding" : [ { "system" : "http://snomed.info/sct", "code" : "887031000000108" } ] }`
Consent.patient		1..1	Reference(Patient)	Who the consent applies to
Consent.patient.reference	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
Consent.patient.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed)
Consent.policy		1..*	BackboneElement	Policies covered by this consent
Consent.provision	C	1..1	BackboneElement	The provision of the consent, which may be a permit or deny Constraints: sdhr-unique-domain
Consent.provision.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:HNZGlobalOptOutReasonExtension		0..1	code	The reason for the HNZ global opt-off URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-global-opt-out-reason-extension Binding: ValueSet for HNZ Global Opt Out Reason (required)
Consent.provision.type		1..1	code	The type of consent, either permit or deny
Consent.provision.period
Consent.provision.period.start		1..1	dateTime	The date and time the Consent is considered to be in effect
Consent.provision.period.end		0..1	dateTime	The date and time the Consent is considered to be expired
Consent.provision.action		1..*	CodeableConcept	The action that is being permitted or denied
Consent.provision.Slices for provision		0..*	BackboneElement	Nested Exception Rules Slice: Unordered, Open by value:class.system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices				Content/Rules for all slices
Consent.provision.Slices for provision.provision:All Slices.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:domainParticipation		0..*	BackboneElement	Nested Exception Rules
Consent.provision.Slices for provision.provision:domainParticipation.extension		1..*	Extension	Extension
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension				Content/Rules for all slices
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:lastUpdated		1..1	instant	Domain Participation Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/domain-participation-last-updated
Consent.provision.Slices for provision.provision:domainParticipation.type		1..1	code	deny \| permit
Consent.provision.Slices for provision.provision:domainParticipation.actor		0..0		Who\|what controlled by this rule (or group, by role)
Consent.provision.Slices for provision.provision:domainParticipation.class		1..1	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: SDHR Data Domains (required)
Consent.provision.Slices for provision.provision:domainParticipation.class.system		1..1	uri	Identity of the terminology system Required Pattern: https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains (extensions allowed)
Consent.provision.Slices for provision.provision:domainParticipation.data		0..0		Data controlled by this rule
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Consent.provision.provision:domainParticipation.class	Base	required	SDHR Data Domains	📦1.1.6	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
nhi-url-format	error	Consent.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	`matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}\|[0-9]{2}[A-Z]{2})$')`
sdhr-unique-domain	error	Consent.provision	Each domain may have only one recorded participation choice.	`provision.where(class.where(system = 'https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains').exists()).class.code.isDistinct()`

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

Consent.id This element is included in summaries. 0..1 id Logical id of this artifact

Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Consent.implicitRules This element is a modifier element. This element is included in summaries. 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

Consent.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

Consent.contained 0..* Resource Contained, inline Resources

Consent.extension 0..* Extension Additional content defined by implementations

Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}

Consent.status This element is a modifier element. This element is included in summaries. 1..1 code The state of the Consent. This must be active to release data from the server
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.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}

category

1..1

CodeableConcept

The category of the consent, which is a code that indicates the type of consent
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

Fixed Value:

{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "887031000000108"
    }
  ]
}

Consent.patient This element is included in summaries. 1..1 Reference(Patient) Who the consent applies to

Consent.patient.id 0..1 string Unique id for inter-element referencing

Consent.patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Consent.patient.reference This element is included in summaries. C 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format

Consent.patient.type This element is included in summaries. 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Patient (extensions allowed)

Consent.patient.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known

Consent.patient.display This element is included in summaries. 0..1 string Text alternative for the resource

Consent.dateTime This element is included in summaries. 0..1 dateTime When this Consent was created or indexed

Consent.performer This element is included in summaries. 0..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules

Consent.organization This element is included in summaries. 0..* Reference(Organization) Custodian of the consent

Consent.source[x] This element is included in summaries. 0..1 Source from which this consent is taken

Consent.source[x].sourceAttachment Attachment

Consent.source[x].sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)

Consent.policy 1..* BackboneElement Policies covered by this consent

Consent.policy.id 0..1 string Unique id for inter-element referencing

Consent.policy.extension 0..* Extension Additional content defined by implementations

Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.policy.authority C 0..1 uri Enforcement source for policy

Consent.policy.uri C 0..1 uri Specific policy covered by this consent

Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family

Consent.verification.id 0..1 string Unique id for inter-element referencing

Consent.verification.extension 0..* Extension Additional content defined by implementations

Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified

Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified

Consent.verification.verificationDate 0..1 dateTime When consent verified

Consent.provision This element is included in summaries. C 1..1 BackboneElement The provision of the consent, which may be a permit or deny
Constraints: sdhr-unique-domain

Consent.provision.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Consent.provision.Slices for extension.extension:HNZGlobalOptOutReasonExtension 0..1 code The reason for the HNZ global opt-off
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-global-opt-out-reason-extension
Binding: ValueSet for HNZ Global Opt Out Reason (required)

Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.provision.type This element is included in summaries. 1..1 code The type of consent, either permit or deny
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this rule

Consent.provision.period.id 0..1 string Unique id for inter-element referencing

Consent.provision.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Consent.provision.period.start This element is included in summaries. C 1..1 dateTime The date and time the Consent is considered to be in effect

Consent.provision.period.end This element is included in summaries. C 0..1 dateTime The date and time the Consent is considered to be expired

Consent.provision.actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)

Consent.provision.actor.id 0..1 string Unique id for inter-element referencing

Consent.provision.actor.extension 0..* Extension Additional content defined by implementations

Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

Consent.provision.action This element is included in summaries. 1..* CodeableConcept The action that is being permitted or denied
Binding: ConsentActionCodes (example): Detailed codes for the consent action.

Consent.provision.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

Consent.provision.purpose This element is included in summaries. 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.

Consent.provision.class This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.

Consent.provision.code This element is included in summaries. 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.

Consent.provision.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this rule

Consent.provision.data This element is included in summaries. 0..* BackboneElement Data controlled by this rule

Consent.provision.data.id 0..1 string Unique id for inter-element referencing

Consent.provision.data.extension 0..* Extension Additional content defined by implementations

Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.

Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference

Consent.provision.Slices for provision 0..* BackboneElement Nested Exception Rules
Slice: Unordered, Open by value:class.system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Consent.provision.Slices for provision.provision:All Slices Content/Rules for all slices

Consent.provision.Slices for provision.provision:All Slices.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for provision.provision:All Slices.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Consent.provision.Slices for provision.provision:All Slices.Slices for extension.extension:FacilityParticipationExtension 0..1 CodeableConcept Indicates the patient has opted out of participation entirely at the facility
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension
Binding: ValueSet for SDHR Participation Reason (required)

Consent.provision.Slices for provision.provision:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.provision.Slices for provision.provision:All Slices.type This element is included in summaries. 0..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

Consent.provision.Slices for provision.provision:All Slices.period This element is included in summaries. 0..1 Period Timeframe for this rule

Consent.provision.Slices for provision.provision:All Slices.actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)

Consent.provision.Slices for provision.provision:All Slices.actor.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for provision.provision:All Slices.actor.extension 0..* Extension Additional content defined by implementations

Consent.provision.Slices for provision.provision:All Slices.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.provision.Slices for provision.provision:All Slices.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

Consent.provision.Slices for provision.provision:All Slices.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.

Consent.provision.Slices for provision.provision:All Slices.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

Consent.provision.Slices for provision.provision:All Slices.purpose This element is included in summaries. 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.

Consent.provision.Slices for provision.provision:All Slices.class This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.

Consent.provision.Slices for provision.provision:All Slices.code This element is included in summaries. 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.

Consent.provision.Slices for provision.provision:All Slices.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this rule

Consent.provision.Slices for provision.provision:All Slices.data This element is included in summaries. 0..* BackboneElement Data controlled by this rule

Consent.provision.Slices for provision.provision:All Slices.data.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for provision.provision:All Slices.data.extension 0..* Extension Additional content defined by implementations

Consent.provision.Slices for provision.provision:All Slices.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.provision.Slices for provision.provision:All Slices.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.

Consent.provision.Slices for provision.provision:All Slices.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference

Consent.provision.Slices for provision.provision:All Slices.provision 0..* See provision (Consent) Nested Exception Rules

Consent.provision.Slices for provision.provision:domainParticipation 0..* BackboneElement Nested Exception Rules

Consent.provision.Slices for provision.provision:domainParticipation.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension Content/Rules for all slices

Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:FacilityParticipationExtension 0..1 CodeableConcept Indicates the patient has opted out of participation entirely at the facility
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension
Binding: ValueSet for SDHR Participation Reason (required)

Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:lastUpdated 1..1 instant Domain Participation Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/domain-participation-last-updated

Consent.provision.Slices for provision.provision:domainParticipation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Consent.provision.Slices for provision.provision:domainParticipation.type This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.

Consent.provision.Slices for provision.provision:domainParticipation.period This element is included in summaries. 0..1 Period Timeframe for this rule

Consent.provision.Slices for provision.provision:domainParticipation.action This element is included in summaries. 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.

Consent.provision.Slices for provision.provision:domainParticipation.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

Consent.provision.Slices for provision.provision:domainParticipation.purpose This element is included in summaries. 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.

Consent.provision.Slices for provision.provision:domainParticipation.class This element is included in summaries. 1..1 Coding e.g. Resource Type, Profile, CDA, etc.
Binding: SDHR Data Domains (required)

Consent.provision.Slices for provision.provision:domainParticipation.class.id 0..1 string Unique id for inter-element referencing

Consent.provision.Slices for provision.provision:domainParticipation.class.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Consent.provision.Slices for provision.provision:domainParticipation.class.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains (extensions allowed)

Consent.provision.Slices for provision.provision:domainParticipation.class.version This element is included in summaries. 0..1 string Version of the system - if relevant

Consent.provision.Slices for provision.provision:domainParticipation.class.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system

Consent.provision.Slices for provision.provision:domainParticipation.class.display This element is included in summaries. 0..1 string Representation defined by the system

Consent.provision.Slices for provision.provision:domainParticipation.class.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user

Consent.provision.Slices for provision.provision:domainParticipation.code This element is included in summaries. 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.

Consent.provision.Slices for provision.provision:domainParticipation.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this rule

Consent.provision.Slices for provision.provision:domainParticipation.provision 0..* See provision (Consent) Nested Exception Rules

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Consent.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
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.patient.type	Base	extensible	ResourceType	📍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 v7.4
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.
Consent.provision.provision.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.provision.actor.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.provision.action	Base	example	Consent Action Codes	📍4.0.1	FHIR Std.
Consent.provision.provision.securityLabel	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Consent.provision.provision.purpose	Base	extensible	PurposeOfUse	📦3.1.0	THO v7.4
Consent.provision.provision.class	Base	extensible	Consent Content Class	📍4.0.1	FHIR Std.
Consent.provision.provision.code	Base	example	Consent Content Codes	📍4.0.1	FHIR Std.
Consent.provision.provision.data.meaning	Base	required	ConsentDataMeaning	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.actor.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.action	Base	example	Consent Action Codes	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.securityLabel	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.purpose	Base	extensible	PurposeOfUse	📦3.1.0	THO v7.4
Consent.provision.provision:domainParticipation.class	Base	required	SDHR Data Domains	📦1.1.6	This IG
Consent.provision.provision:domainParticipation.code	Base	example	Consent Content Codes	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.data.meaning	Base	required	ConsentDataMeaning	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Consent	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	Consent	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	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Consent	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()`
nhi-url-format	error	Consent.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	`matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}\|[0-9]{2}[A-Z]{2})$')`
ppc-1	error	Consent	Either a Policy or PolicyRule	`policy.exists() or policyRule.exists()`
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()`
ppc-3	error	Consent	IF Scope=research, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='research').exists().not()`
ppc-4	error	Consent	IF Scope=adr, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()`
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()`
sdhr-unique-domain	error	Consent.provision	Each domain may have only one recorded participation choice.	`provision.where(class.where(system = 'https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains').exists()).class.code.isDistinct()`

This structure is derived from Consent

Summary

Mandatory: 7 elements(6 nested mandatory elements)
Fixed: 1 element
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Consent.provision.provision

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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
Consent.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Consent.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Consent.status	This element is a modifier element. This element is included in summaries.	1..1	code	The state of the Consent. This must be active to release data from the server Binding: ConsentState (required): Indicates the state of the consent.
Consent.scope	This element is a modifier element. This element is included in summaries.	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.category	This element is included in summaries.	1..1	CodeableConcept	The category of the consent, which is a code that indicates the type of consent Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Fixed Value: `{ "coding" : [ { "system" : "http://snomed.info/sct", "code" : "887031000000108" } ] }`
Consent.patient	This element is included in summaries.	1..1	Reference(Patient)	Who the consent applies to
Consent.patient.reference	This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
Consent.patient.type	This element is included in summaries.	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient (extensions allowed)
Consent.policy		1..*	BackboneElement	Policies covered by this consent
Consent.policy.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision	This element is included in summaries. C	1..1	BackboneElement	The provision of the consent, which may be a permit or deny Constraints: sdhr-unique-domain
Consent.provision.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:HNZGlobalOptOutReasonExtension		0..1	code	The reason for the HNZ global opt-off URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-global-opt-out-reason-extension Binding: ValueSet for HNZ Global Opt Out Reason (required)
Consent.provision.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision.type	This element is included in summaries.	1..1	code	The type of consent, either permit or deny Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.action	This element is included in summaries.	1..*	CodeableConcept	The action that is being permitted or denied Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.Slices for provision		0..*	BackboneElement	Nested Exception Rules Slice: Unordered, Open by value:class.system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices				Content/Rules for all slices
Consent.provision.Slices for provision.provision:All Slices.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:All Slices.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision.Slices for provision.provision:domainParticipation		0..*	BackboneElement	Nested Exception Rules
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension				Content/Rules for all slices
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:lastUpdated		1..1	instant	Domain Participation Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/domain-participation-last-updated
Consent.provision.Slices for provision.provision:domainParticipation.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Consent.provision.Slices for provision.provision:domainParticipation.type	This element is included in summaries.	1..1	code	deny \| permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Consent.provision.Slices for provision.provision:domainParticipation.class	This element is included in summaries.	1..1	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: SDHR Data Domains (required)
Consent.provision.Slices for provision.provision:domainParticipation.class.system	This element is included in summaries.	1..1	uri	Identity of the terminology system Required Pattern: https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains (extensions allowed)
Documentation for this format

Terminology Bindings

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.patient.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Consent.provision.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.action	Base	example	Consent Action Codes	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.actor.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.class	Base	required	SDHR Data Domains	📦1.1.6	This IG
Consent.provision.provision:domainParticipation.data.meaning	Base	required	ConsentDataMeaning	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Consent	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	Consent	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	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Consent	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()`
nhi-url-format	error	Consent.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	`matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}\|[0-9]{2}[A-Z]{2})$')`
ppc-1	error	Consent	Either a Policy or PolicyRule	`policy.exists() or policyRule.exists()`
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()`
ppc-3	error	Consent	IF Scope=research, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='research').exists().not()`
ppc-4	error	Consent	IF Scope=adr, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()`
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()`
sdhr-unique-domain	error	Consent.provision	Each domain may have only one recorded participation choice.	`provision.where(class.where(system = 'https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains').exists()).class.code.isDistinct()`

Differential View

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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
Consent.status		1..1	code	The state of the Consent. This must be active to release data from the server
Consent.scope		1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/consentscope", "code" : "patient-privacy" } ] }`
Consent.category		1..1	CodeableConcept	The category of the consent, which is a code that indicates the type of consent Fixed Value: `{ "coding" : [ { "system" : "http://snomed.info/sct", "code" : "887031000000108" } ] }`
Consent.patient		1..1	Reference(Patient)	Who the consent applies to
Consent.patient.reference	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
Consent.patient.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed)
Consent.policy		1..*	BackboneElement	Policies covered by this consent
Consent.provision	C	1..1	BackboneElement	The provision of the consent, which may be a permit or deny Constraints: sdhr-unique-domain
Consent.provision.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for extension.extension:HNZGlobalOptOutReasonExtension		0..1	code	The reason for the HNZ global opt-off URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-global-opt-out-reason-extension Binding: ValueSet for HNZ Global Opt Out Reason (required)
Consent.provision.type		1..1	code	The type of consent, either permit or deny
Consent.provision.period
Consent.provision.period.start		1..1	dateTime	The date and time the Consent is considered to be in effect
Consent.provision.period.end		0..1	dateTime	The date and time the Consent is considered to be expired
Consent.provision.action		1..*	CodeableConcept	The action that is being permitted or denied
Consent.provision.Slices for provision		0..*	BackboneElement	Nested Exception Rules Slice: Unordered, Open by value:class.system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices				Content/Rules for all slices
Consent.provision.Slices for provision.provision:All Slices.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for provision.provision:All Slices.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:domainParticipation		0..*	BackboneElement	Nested Exception Rules
Consent.provision.Slices for provision.provision:domainParticipation.extension		1..*	Extension	Extension
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension				Content/Rules for all slices
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:FacilityParticipationExtension		0..1	CodeableConcept	Indicates the patient has opted out of participation entirely at the facility URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension Binding: ValueSet for SDHR Participation Reason (required)
Consent.provision.Slices for provision.provision:domainParticipation.Slices for extension.extension:lastUpdated		1..1	instant	Domain Participation Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/domain-participation-last-updated
Consent.provision.Slices for provision.provision:domainParticipation.type		1..1	code	deny \| permit
Consent.provision.Slices for provision.provision:domainParticipation.actor		0..0		Who\|what controlled by this rule (or group, by role)
Consent.provision.Slices for provision.provision:domainParticipation.class		1..1	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: SDHR Data Domains (required)
Consent.provision.Slices for provision.provision:domainParticipation.class.system		1..1	uri	Identity of the terminology system Required Pattern: https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains (extensions allowed)
Consent.provision.Slices for provision.provision:domainParticipation.data		0..0		Data controlled by this rule
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Consent.provision.provision:domainParticipation.class	Base	required	SDHR Data Domains	📦1.1.6	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
nhi-url-format	error	Consent.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	`matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}\|[0-9]{2}[A-Z]{2})$')`
sdhr-unique-domain	error	Consent.provision	Each domain may have only one recorded participation choice.	`provision.where(class.where(system = 'https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains').exists()).class.code.isDistinct()`

Snapshot View

Description & Constraints Filter:

Consent.id This element is included in summaries. 0..1 id Logical id of this artifact

Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Consent.implicitRules This element is a modifier element. This element is included in summaries. 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

Consent.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

Consent.contained 0..* Resource Contained, inline Resources

Consent.extension 0..* Extension Additional content defined by implementations

Consent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

scope

1..1

CodeableConcept

Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Consent.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
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.patient.type	Base	extensible	ResourceType	📍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 v7.4
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.
Consent.provision.provision.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.provision.actor.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.provision.action	Base	example	Consent Action Codes	📍4.0.1	FHIR Std.
Consent.provision.provision.securityLabel	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Consent.provision.provision.purpose	Base	extensible	PurposeOfUse	📦3.1.0	THO v7.4
Consent.provision.provision.class	Base	extensible	Consent Content Class	📍4.0.1	FHIR Std.
Consent.provision.provision.code	Base	example	Consent Content Codes	📍4.0.1	FHIR Std.
Consent.provision.provision.data.meaning	Base	required	ConsentDataMeaning	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.type	Base	required	ConsentProvisionType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.actor.role	Base	extensible	SecurityRoleType	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.action	Base	example	Consent Action Codes	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.securityLabel	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.purpose	Base	extensible	PurposeOfUse	📦3.1.0	THO v7.4
Consent.provision.provision:domainParticipation.class	Base	required	SDHR Data Domains	📦1.1.6	This IG
Consent.provision.provision:domainParticipation.code	Base	example	Consent Content Codes	📍4.0.1	FHIR Std.
Consent.provision.provision:domainParticipation.data.meaning	Base	required	ConsentDataMeaning	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Consent	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	Consent	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	Consent	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Consent	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()`
nhi-url-format	error	Consent.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	`matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}\|[0-9]{2}[A-Z]{2})$')`
ppc-1	error	Consent	Either a Policy or PolicyRule	`policy.exists() or policyRule.exists()`
ppc-2	error	Consent	IF Scope=privacy, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()`
ppc-3	error	Consent	IF Scope=research, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='research').exists().not()`
ppc-4	error	Consent	IF Scope=adr, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()`
ppc-5	error	Consent	IF Scope=treatment, there must be a patient	`patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()`
sdhr-unique-domain	error	Consent.provision	Each domain may have only one recorded participation choice.	`provision.where(class.where(system = 'https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-domains').exists()).class.code.isDistinct()`

This structure is derived from Consent

Summary

Mandatory: 7 elements(6 nested mandatory elements)
Fixed: 1 element
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Consent.provision.provision

Other representations of profile: CSV, Excel, Schematron