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

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

## Resource Profile: ManaakiNgaTahiConsent

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-consent | Version: 0.1.7
Active as of 2025-12-11 | Computable Name: ManaakiNgaTahiConsent

Consent FHIR resource for Manaaki Nga Tahi

Usages:

- Examples for this Profile: Consent/ConsentByQuestionnaireExample, Consent/ConsentByRelatedPersonExample, Consent/ConsentExample and Consent/ProvisionalConsentExample
- CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

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
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Consent.status | required | ConsentState `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` From the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` From the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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()) |
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() |

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
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
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
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 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
provision |  |  |  |
period |  | 1..1 | Period | Must be in UTC timezone on the FHIR server
provision |  | 0..0 |  |
Documentation for this format

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
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Consent.status | required | ConsentState `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` From the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` From the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` From the FHIR Standard
Consent.policyRule | extensible | ConsentPolicyRuleCodes `http://hl7.org/fhir/ValueSet/consent-policy` From the FHIR Standard
Consent.provision.type | required | ConsentProvisionType `http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1` From the FHIR Standard
Consent.provision.actor.role | extensible | SecurityRoleType `http://hl7.org/fhir/ValueSet/security-role-type` From the FHIR Standard
Consent.provision.action | example | ConsentActionCodes `http://hl7.org/fhir/ValueSet/consent-action` From the FHIR Standard
Consent.provision.securityLabel | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Consent.provision.purpose | extensible | PurposeOfUse `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse`
Consent.provision.class | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` From the FHIR Standard
Consent.provision.code | example | ConsentContentCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/consent-content-code` From the FHIR Standard
Consent.provision.data.meaning | required | ConsentDataMeaning `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
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() |

This structure is derived from Consent

Summary

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

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Consent.source[x]

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
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Consent.status | required | ConsentState `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` From the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` From the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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()) |
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() |

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
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
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
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 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
provision |  |  |  |
period |  | 1..1 | Period | Must be in UTC timezone on the FHIR server
provision |  | 0..0 |  |
Documentation for this format

Snapshot 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
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Consent.status | required | ConsentState `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` From the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` From the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` From the FHIR Standard
Consent.policyRule | extensible | ConsentPolicyRuleCodes `http://hl7.org/fhir/ValueSet/consent-policy` From the FHIR Standard
Consent.provision.type | required | ConsentProvisionType `http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1` From the FHIR Standard
Consent.provision.actor.role | extensible | SecurityRoleType `http://hl7.org/fhir/ValueSet/security-role-type` From the FHIR Standard
Consent.provision.action | example | ConsentActionCodes `http://hl7.org/fhir/ValueSet/consent-action` From the FHIR Standard
Consent.provision.securityLabel | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Consent.provision.purpose | extensible | PurposeOfUse `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse`
Consent.provision.class | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` From the FHIR Standard
Consent.provision.code | example | ConsentContentCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/consent-content-code` From the FHIR Standard
Consent.provision.data.meaning | required | ConsentDataMeaning `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
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() |

This structure is derived from Consent

Summary

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

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Consent.source[x]

Other representations of profile: CSV, Excel, Schematron