RIVO Noord Zorgviewer MVP2 Implementation Guide
0.2.1 - CI build Netherlands flag

RIVO Noord Zorgviewer MVP2 Implementation Guide - Local Development build (v0.2.1). See the Directory of published versions

Resource Profile: TreatmentDirective - Detailed Descriptions

Draft as of 2023-03-22

Definitions for the TreatmentDirective resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Consent
2. Consent.extension:treatment
SliceNametreatment
Must Supporttrue
3. Consent.extension:treatment.valueCodeableConcept:valueCodeableConcept
SliceNamevalueCodeableConcept
BindingThe codes SHALL be taken from ACP-TreatmentCodelist; other codes may be used where these codes are not suitableThe codes SHALL be taken from BehandelingCodelijst; other codes may be used where these codes are not suitable
Must Supporttrue
4. Consent.extension:comments
SliceNamecomments
Control0..?
Must Supporttrue
5. Consent.modifierExtension:treatmentPermitted
SliceNametreatmentPermitted
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. Consent
Definition

A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Control0..*
Alternate NamesBehandelAanwijzing
Comments

Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.

InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: 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())
hcim-treatmentdirective-1: extension.additionalSources may only be used for AdvanceDirective references in addition to first reference in .source[x] (: extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources').empty() or source.exists())
ppc-1: Either a Policy or PolicyRule (: policy.exists() or policyRule.exists())
2. Consent.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

3. Consent.extension:verification
SliceNameverification
Definition

Container of the Verification concept. This container contains all data elements of the Verification concept.

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control This element is affected by the following invariants: ele-1
TypeExtension(Zib TreatmentDirective Verification) (Complex Extension)
Alternate NamesVerificatie, extensions, user content
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. Consent.extension:verification.extension:Verified
SliceNameVerified
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control10..1*
TypeExtension
Alternate NamesGeverifieerd, extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

5. Consent.extension:verification.extension:Verified.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueVerified
6. Consent.extension:verification.extension:Verified.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: boolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
7. Consent.extension:verification.extension:Verified.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Indication of the fact that the treatment instruction has been verified with the patient, the patient’s family and/or the patient's authorized representative.

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: boolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate NamesGeverifieerd
8. Consent.extension:verification.extension:VerifiedWith
SliceNameVerifiedWith
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate NamesGeverifieerdBij, extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

9. Consent.extension:verification.extension:VerifiedWith.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueVerifiedWith
10. Consent.extension:verification.extension:VerifiedWith.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
11. Consent.extension:verification.extension:VerifiedWith.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
BindingThe codes SHALL be taken from GeverifieerdBijCodelijst; other codes may be used where these codes are not suitableFor codes, see (unbound) The person with whom the treatment instruction was discussed and verified
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
12. Consent.extension:verification.extension:VerificationDate
SliceNameVerificationDate
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..1*
TypeExtension
Alternate NamesVerificatieDatum, extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

13. Consent.extension:verification.extension:VerificationDate.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueVerificationDate
14. Consent.extension:verification.extension:VerificationDate.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: dateTime, date, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
15. Consent.extension:verification.extension:VerificationDate.value[x]:valueDateTime
SliceNamevalueDateTime
Definition

Date on which the verification with the patient, the patient’s family and/or the patient's authorized representative took place.

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: dateTime, date, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate NamesVerificatieDatum
16. Consent.extension:verification.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification
17. Consent.extension:verification.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..01
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
18. Consent.extension:comment
SliceNamecomment
Definition

Comments on the treatment instruction such as a written description of an end date which can be indicated as a date (“until discharge from hospital”).

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Comment) (Extension Type: string)
Alternate NamesToelichting
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. Consent.extension:treatment
SliceNametreatment
Definition

Optional Extension Element - found in all resources.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Zib TreatmentDirective Treatment) (Extension Type: CodeableConcept)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
20. Consent.extension:treatment.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment
21. Consent.extension:treatment.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
22. Consent.extension:treatment.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The medical treatment to which the treatment instruction applies.

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
BindingThe codes SHALL be taken from ACP-TreatmentCodelist; other codes may be used where these codes are not suitableFor codes, see (unbound) The medical treatment to which the treatment instruction applies
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Alternate NamesBehandeling
23. Consent.extension:additionalSources
SliceNameadditionalSources
Definition

Optional Extension Element - found in all resources.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Consent additionalSources) (Extension Type: Choice of: Attachment, Identifier, Reference(Consent|DocumentReference|Contract|QuestionnaireResponse))
Comments

The cardinality of the source element does not comply with the cardinality of the AdvanceDirective concept (NL-CM:2.1.14) specified in the HCIM TreatmentDirective. Additional AdvanceDirective references can be added using this extension.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. Consent.extension:additionalSources.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/consent-additionalSources
25. Consent.extension:comments
SliceNamecomments
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Must Supporttrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

26. Consent.modifierExtension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
27. Consent.modifierExtension:treatmentPermitted
SliceNametreatmentPermitted
Definition

An Extension

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(Zib TreatmentDirective TreatmentPermitted) (Extension Type: CodeableConcept)
Is Modifiertrue
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
28. Consent.modifierExtension:treatmentPermitted.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-TreatmentPermitted
29. Consent.modifierExtension:treatmentPermitted.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.modifierExtension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
30. Consent.modifierExtension:treatmentPermitted.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints.

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
BindingThe codes SHALL be taken from BehandelingToegestaanCodelijst; other codes may be used where these codes are not suitableFor codes, see (unbound) Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate NamesBehandelingToegestaan
31. Consent.status
Definition

Indicates the current state of this consent.

Control1..1
BindingThe codes SHALL be taken from ConsentState

Indicates the state of the consent

Typecode
Is Modifiertrue
Summarytrue
Requirements

The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.

Comments

The HCIM treatmentDirective is not explicit on its intention. The expectation however is that any instantation of a TreatmentDirective is "active" unless stated otherwise.

This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.

32. Consent.category
Definition

A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

Control10..*
BindingFor example codes, see Consent Category Codes

A classification of the type of consents found in a consent statement

TypeCodeableConcept
Summarytrue
33. Consent.category.coding
Definition

A reference to a code defined by a terminology system.

Control10..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

SlicingThis element introduces a set of slices on Consent.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
34. Consent.category.coding:treatmentDirective
SliceNametreatmentDirective
Definition

Category SNOMED code used for indexing/retrieval of the HCIM TreatmentDirective.

A reference to a code defined by a terminology system.

Control10..1*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

35. Consent.category.coding:treatmentDirective.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://snomed.info/sct
36. Consent.category.coding:treatmentDirective.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control10..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value11291000146105
37. Consent.patient
Definition

The patient/healthcare consumer to whom this consent applies.

Control1..1
TypeReference(nl-core-patient|Patient)
Summarytrue
Comments

Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.

Guidance on how to interpret the contents of this table can be found here.

1. Consent
Definition

A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Control0..*
Alternate NamesBehandelAanwijzing
Comments

Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.

2. Consent.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Consent.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
4. Consent.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. Consent.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

6. Consent.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

7. Consent.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

8. Consent.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Consent.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Consent.extension:verification
SliceNameverification
Definition

Container of the Verification concept. This container contains all data elements of the Verification concept.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Zib TreatmentDirective Verification) (Complex Extension)
Alternate NamesVerificatie
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Consent.extension:verification.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
11. Consent.extension:verification.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Consent.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. Consent.extension:verification.extension:Verified
SliceNameVerified
Definition

An Extension

Control1..1
TypeExtension
Alternate NamesGeverifieerd
13. Consent.extension:verification.extension:Verified.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. Consent.extension:verification.extension:Verified.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
15. Consent.extension:verification.extension:Verified.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueVerified
16. Consent.extension:verification.extension:Verified.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
17. Consent.extension:verification.extension:Verified.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Indication of the fact that the treatment instruction has been verified with the patient, the patient’s family and/or the patient's authorized representative.

Control0..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate NamesGeverifieerd
18. Consent.extension:verification.extension:VerifiedWith
SliceNameVerifiedWith
Definition

An Extension

Control0..*
TypeExtension
Alternate NamesGeverifieerdBij
19. Consent.extension:verification.extension:VerifiedWith.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Consent.extension:verification.extension:VerifiedWith.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
21. Consent.extension:verification.extension:VerifiedWith.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueVerifiedWith
22. Consent.extension:verification.extension:VerifiedWith.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
23. Consent.extension:verification.extension:VerifiedWith.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
BindingThe codes SHALL be taken from GeverifieerdBijCodelijst; other codes may be used where these codes are not suitable The person with whom the treatment instruction was discussed and verified
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
24. Consent.extension:verification.extension:VerificationDate
SliceNameVerificationDate
Definition

An Extension

Control0..1
TypeExtension
Alternate NamesVerificatieDatum
25. Consent.extension:verification.extension:VerificationDate.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
26. Consent.extension:verification.extension:VerificationDate.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
27. Consent.extension:verification.extension:VerificationDate.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueVerificationDate
28. Consent.extension:verification.extension:VerificationDate.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypedateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
29. Consent.extension:verification.extension:VerificationDate.value[x]:valueDateTime
SliceNamevalueDateTime
Definition

Date on which the verification with the patient, the patient’s family and/or the patient's authorized representative took place.

Control0..1
TypedateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate NamesVerificatieDatum
30. Consent.extension:verification.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification
31. Consent.extension:verification.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..0
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
32. Consent.extension:comment
SliceNamecomment
Definition

Comments on the treatment instruction such as a written description of an end date which can be indicated as a date (“until discharge from hospital”).

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Comment) (Extension Type: string)
Alternate NamesToelichting
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. Consent.extension:treatment
SliceNametreatment
Definition

Optional Extension Element - found in all resources.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Zib TreatmentDirective Treatment) (Extension Type: CodeableConcept)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. Consent.extension:treatment.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
35. Consent.extension:treatment.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
36. Consent.extension:treatment.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment
37. Consent.extension:treatment.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
38. Consent.extension:treatment.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

The medical treatment to which the treatment instruction applies.

Control0..1
BindingThe codes SHALL be taken from ACP-TreatmentCodelist; other codes may be used where these codes are not suitable The medical treatment to which the treatment instruction applies
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Alternate NamesBehandeling
39. Consent.extension:additionalSources
SliceNameadditionalSources
Definition

Optional Extension Element - found in all resources.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Consent additionalSources) (Extension Type: Choice of: Attachment, Identifier, Reference(Consent|DocumentReference|Contract|QuestionnaireResponse))
Comments

The cardinality of the source element does not comply with the cardinality of the AdvanceDirective concept (NL-CM:2.1.14) specified in the HCIM TreatmentDirective. Additional AdvanceDirective references can be added using this extension.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
40. Consent.extension:additionalSources.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
41. Consent.extension:additionalSources.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. Consent.extension:additionalSources.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/consent-additionalSources
43. Consent.extension:additionalSources.value[x]
Definition

A (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter.

Control0..1
TypeChoice of: Attachment, Identifier, Reference(Zib AdvanceDirective|DocumentReference|Contract|QuestionnaireResponse)
[x] NoteSee Choice of Data Types for further information about how to use [x]
44. Consent.extension:comments
SliceNamecomments
Definition

An Extension

Control0..*
TypeExtension
Must Supporttrue
45. Consent.modifierExtension
Definition

An Extension

Control0..*
TypeExtension
Is Modifiertrue
SlicingThis element introduces a set of slices on Consent.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. Consent.modifierExtension:treatmentPermitted
SliceNametreatmentPermitted
Definition

An Extension

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(Zib TreatmentDirective TreatmentPermitted) (Extension Type: CodeableConcept)
Is Modifiertrue
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. Consent.modifierExtension:treatmentPermitted.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
48. Consent.modifierExtension:treatmentPermitted.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.modifierExtension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. Consent.modifierExtension:treatmentPermitted.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-TreatmentPermitted
50. Consent.modifierExtension:treatmentPermitted.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Consent.modifierExtension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
51. Consent.modifierExtension:treatmentPermitted.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints.

Control0..1
BindingThe codes SHALL be taken from BehandelingToegestaanCodelijst; other codes may be used where these codes are not suitable Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate NamesBehandelingToegestaan
52. Consent.identifier
Definition

Unique identifier for this copy of the Consent Statement.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Comments

This identifier is identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.

Example
General:<valueIdentifier xmlns="http://hl7.org/fhir">
  <system value="urn:ietf:rfc:3986"/>
  <value value="Local eCMS identifier"/>
</valueIdentifier>
53. Consent.status
Definition

Indicates the current state of this consent.

Control1..1
BindingThe codes SHALL be taken from ConsentState Indicates the state of the consen
Typecode
Is Modifiertrue
Summarytrue
Requirements

The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.

Comments

The HCIM treatmentDirective is not explicit on its intention. The expectation however is that any instantation of a TreatmentDirective is "active" unless stated otherwise.

54. Consent.category
Definition

A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

Control1..*
BindingFor example codes, see Consent Category Codes A classification of the type of consents found in a consent statemen
TypeCodeableConcept
Summarytrue
55. Consent.category.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
56. Consent.category.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
57. Consent.category.coding
Definition

A reference to a code defined by a terminology system.

Control1..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

SlicingThis element introduces a set of slices on Consent.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
58. Consent.category.coding:treatmentDirective
SliceNametreatmentDirective
Definition

Category SNOMED code used for indexing/retrieval of the HCIM TreatmentDirective.

Control1..1
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

59. Consent.category.coding:treatmentDirective.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
60. Consent.category.coding:treatmentDirective.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.category.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
61. Consent.category.coding:treatmentDirective.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://snomed.info/sct
62. Consent.category.coding:treatmentDirective.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

63. Consent.category.coding:treatmentDirective.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Value11291000146105
64. Consent.category.coding:treatmentDirective.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

65. Consent.category.coding:treatmentDirective.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

66. Consent.category.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

67. Consent.patient
Definition

The patient/healthcare consumer to whom this consent applies.

Control1..1
TypeReference(nl-core-patient)
Summarytrue
Comments

Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.

68. Consent.period
Definition

Relevant time or time-period when this Consent is applicable.

Control0..1
TypePeriod
Summarytrue
Comments

This can be a subset of the period of the original statement.

Meaning if Missingall date ranges included
69. Consent.period.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
70. Consent.period.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Consent.period.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
71. Consent.period.start
Definition

Date on which the treatment instruction went into effect. A ‘vague’ date, such as only the year, is permitted.

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Summarytrue
Alternate NamesBeginDatum
Comments

If the low element is missing, the meaning is that the low boundary is not known.

72. Consent.period.end
Definition

Date on which the treatment instruction ends. A ‘vague’ date, such as only the year, is permitted.

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Summarytrue
Alternate NamesEindDatum
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
73. Consent.dateTime
Definition

When this Consent was issued / created / indexed.

Control0..1
TypedateTime
Summarytrue
Comments

This is not the time of the original consent, but the time that this statement was made or derived.

74. Consent.consentingParty
Definition

Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

Control0..*
TypeReference(nl-core-relatedperson|nl-core-organization|nl-core-patient|nl-core-practitioner)
Summarytrue
Alternate Namesconsentor
Comments

Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.

75. Consent.consentingParty.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
76. Consent.consentingParty.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Consent.consentingParty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
77. Consent.consentingParty.extension:practitionerRole
SliceNamepractitionerRole
Definition

Optional Extension Element - found in all resources.

Control0..1
TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
78. Consent.consentingParty.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Summarytrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

79. Consent.consentingParty.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

80. Consent.consentingParty.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Summarytrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

81. Consent.actor
Definition

Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Control0..*
TypeBackboneElement
Summarytrue
Meaning if MissingThere is no specific actor associated with the consent
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
82. Consent.actor.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
83. Consent.actor.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

84. Consent.actor.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

85. Consent.actor.role
Definition

How the individual is involved in the resources content that is described in the consent.

Control1..1
BindingThe codes SHALL be taken from SecurityRoleType; other codes may be used where these codes are not suitable How an actor is involved in the consent consideration
TypeCodeableConcept
86. Consent.actor.reference
Definition

The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Control1..1
TypeReference(Device|Group|CareTeam|nl-core-organization|nl-core-patient|nl-core-practitioner|nl-core-relatedperson)
87. Consent.actor.reference.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
88. Consent.actor.reference.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Consent.actor.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
89. Consent.actor.reference.extension:practitionerRole
SliceNamepractitionerRole
Definition

Optional Extension Element - found in all resources.

Control0..1
TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
90. Consent.actor.reference.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Summarytrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

91. Consent.actor.reference.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

92. Consent.actor.reference.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Summarytrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

93. Consent.action
Definition

Actions controlled by this consent.

Control0..*
BindingFor example codes, see Consent Action Codes Detailed codes for the consent action
TypeCodeableConcept
Summarytrue
Comments

Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.

Meaning if Missingall actions
94. Consent.organization
Definition

The organization that manages the consent, and the framework within which it is executed.

Control0..*
TypeReference(nl-core-organization)
Summarytrue
Alternate Namescustodian
95. Consent.source[x]
Definition

A (written) statement in which a person indicates wishes concerning future medical action, in the event that this person is at that point no longer (deemed) capable of taking decisions on the matter.

Control0..1
TypeChoice of: Attachment, Identifier, Reference(Zib AdvanceDirective|DocumentReference|Contract|QuestionnaireResponse)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Alternate NamesWilsverklaring
Comments

The cardinality of the source element does not comply with the cardinality of the AdvanceDirective concept (NL-CM:2.1.14) specified in the HCIM TreatmentDirective. Additional AdvanceDirective references can be added using the additionalSources extension.

96. Consent.policy
Definition

The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
97. Consent.policy.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
98. Consent.policy.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

99. Consent.policy.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

100. Consent.policy.authority
Definition

Entity or Organization having regulatory jurisdiction or accountability for  enforcing policies pertaining to Consent Directives.

Control0..1 This element is affected by the following invariants: ppc-1
Typeuri
101. Consent.policy.uri
Definition

The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

Control0..1 This element is affected by the following invariants: ppc-1
Typeuri
Comments

Either .policy or .policyRule should exist following core constraint ppc-1. If no explicit value is recorded, a fallback is to populate .policy.uri with https://wetten.overheid.nl/ if the treatment directive is recorded following Dutch law and regulations.

Example
General Dutch Law:http://wetten.overheid.nl/
102. Consent.policyRule
Definition

A referece to the specific computable policy.

Control0..1 This element is affected by the following invariants: ppc-1
Typeuri
Summarytrue
Requirements

Might be a unique identifier of a policy set in XACML, or other rules engine.

Comments

If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in the consent resource.

103. Consent.securityLabel
Definition

A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Summarytrue
Comments

If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?).

104. Consent.purpose
Definition

The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.

Control0..*
BindingThe codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified label
TypeCoding
Summarytrue
Comments

This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies).

105. Consent.dataPeriod
Definition

Clinical or Operational Relevant period of time that bounds the data controlled by this consent.

Control0..1
TypePeriod
Summarytrue
Comments

This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.

106. Consent.data
Definition

The resources controlled by this consent, if specific resources are referenced.

Control0..*
TypeBackboneElement
Summarytrue
Meaning if Missingall data
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
107. Consent.data.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
108. Consent.data.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

109. Consent.data.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

110. Consent.data.meaning
Definition

How the resource reference is interpreted when testing consent restrictions.

Control1..1
BindingThe codes SHALL be taken from ConsentDataMeaning How a resource reference is interpreted when testing consent restriction
Typecode
Summarytrue
111. Consent.data.reference
Definition

A reference to a specific resource that defines which resources are covered by this consent.

Control1..1
TypeReference(Resource)
Summarytrue
112. Consent.except
Definition

An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Control0..*
TypeBackboneElement
Summarytrue
Comments

If a Consent.except is used in accordance with the HCIM TreatmentDirective, then the only time an except is in order, is when the value of the element NL-CM:2.1.4 TreatmentPermitted is YESBUT/JAMAAR.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
113. Consent.except.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
114. Consent.except.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Consent.except.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
115. Consent.except.extension:restrictions
SliceNamerestrictions
Definition

The restrictions or specific circumstances that apply to a certain treatment.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Zib TreatmentDirective Restrictions) (Extension Type: string)
Alternate NamesBeperkingen
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
116. Consent.except.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

117. Consent.except.type
Definition

Action to take - permit or deny - when the exception conditions are met.

Control1..1
BindingThe codes SHALL be taken from ConsentExceptType How an exception statement is applied, such as adding additional consent or removing consen
Typecode
Summarytrue
Comments

If a Consent.except is used in accordance with the HCIM TreatmentDirective and the value of the element NL-CM:2.1.4 TreatmentPermitted is YESBUT/JAMAAR, then the value of this element SHALL be "deny"

118. Consent.except.period
Definition

The timeframe in this exception is valid.

Control0..1
TypePeriod
Summarytrue
119. Consent.except.actor
Definition

Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Control0..*
TypeBackboneElement
Summarytrue
Meaning if MissingThere is no specific actor associated with the exception
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
120. Consent.except.actor.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
121. Consent.except.actor.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

122. Consent.except.actor.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

123. Consent.except.actor.role
Definition

How the individual is involved in the resources content that is described in the exception.

Control1..1
BindingThe codes SHALL be taken from SecurityRoleType; other codes may be used where these codes are not suitable How an actor is involved in the consent consideration
TypeCodeableConcept
124. Consent.except.actor.reference
Definition

The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Control1..1
TypeReference(Device|Group|CareTeam|nl-core-organization|nl-core-patient|nl-core-practitioner|nl-core-relatedperson)
125. Consent.except.actor.reference.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
126. Consent.except.actor.reference.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Consent.except.actor.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
127. Consent.except.actor.reference.extension:practitionerRole
SliceNamepractitionerRole
Definition

Optional Extension Element - found in all resources.

Control0..1
TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
128. Consent.except.actor.reference.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Summarytrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

129. Consent.except.actor.reference.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

130. Consent.except.actor.reference.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Summarytrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

131. Consent.except.action
Definition

Actions controlled by this Exception.

Control0..*
BindingFor example codes, see Consent Action Codes Detailed codes for the consent action
TypeCodeableConcept
Summarytrue
Comments

Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.

Meaning if Missingall actions
132. Consent.except.securityLabel
Definition

A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Summarytrue
Comments

If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?).

133. Consent.except.purpose
Definition

The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.

Control0..*
BindingThe codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified label
TypeCoding
Summarytrue
Comments

E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?).

134. Consent.except.class
Definition

The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.

Control0..*
BindingThe codes SHALL be taken from Consent Content Class; other codes may be used where these codes are not suitable The class (type) of information a consent rule cover
TypeCoding
Summarytrue
Comments

Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.

135. Consent.except.code
Definition

If this code is found in an instance, then the exception applies.

Control0..*
BindingFor example codes, see Consent Content Codes If this code is found in an instance, then the exception applie
TypeCoding
Summarytrue
Comments

Typical use of this is a Document code with class = CDA.

136. Consent.except.dataPeriod
Definition

Clinical or Operational Relevant period of time that bounds the data controlled by this exception.

Control0..1
TypePeriod
Summarytrue
Comments

This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.

137. Consent.except.data
Definition

The resources controlled by this exception, if specific resources are referenced.

Control0..*
TypeBackboneElement
Summarytrue
Meaning if Missingall data
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
138. Consent.except.data.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
139. Consent.except.data.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

140. Consent.except.data.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

141. Consent.except.data.meaning
Definition

How the resource reference is interpreted when testing consent restrictions.

Control1..1
BindingThe codes SHALL be taken from ConsentDataMeaning How a resource reference is interpreted when testing consent restriction
Typecode
Summarytrue
142. Consent.except.data.reference
Definition

A reference to a specific resource that defines which resources are covered by this consent.

Control1..1
TypeReference(Resource)
Summarytrue