Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HCIM AdvanceDirective

Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective Version: 1.3.15
Active as of 2024-04-09 Computable Name: Zib AdvanceDirective

Copyright/Legal: CC0

AdvanceDirective (formerly know as LivingWill) as defined by the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) version 3.1. A living will is a verbal or written description of the patient’s wishes with regard to future medical action or end of their life. A living will is mainly used for situations in which the patient is no longer able to speak about these decisions with their healthcare provider.

A good overview of the patient’s wishes is important. A healthcare provider can use the living will to discuss the existing wishes with the persons involved and to incorporate these wishes in their own policy. A concise, orderly list is of particular importance in acute care situations.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..* Consent LivingWill
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... disorder 0..* Reference(HCIM Problem) Disorder
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective-Disorder
... comment 0..1 string Comment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
... Slices for category 2..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
.... category:livingWill 1..1 CodeableConcept Living will and advance directive record
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11341000146107
..... coding
...... display 0..1 string Representation defined by the system
.... category:typeOfLivingWill 1..1 CodeableConcept TypeOfLivingWill
Binding: WilsverklaringTypeCodelijst (required): List of the different types of living wills.

..... coding 1..* Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
... patient 1..1 Reference(nl-core-patient) Who the consent applies to
... dateTime 1..1 dateTime LivingWillDate
... consentingParty 0..1 Reference(nl-core-relatedperson) Representative
... actor
.... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... organization 0..* Reference(nl-core-organization) Custodian of the consent
... source[x] 0..1 Attachment, Identifier, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) LivingWillDocument
... except
.... actor
..... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Consent.category:typeOfLivingWillrequiredWilsverklaringTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C 0..* Consent LivingWill
ppc-1: Either a Policy or PolicyRule
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... disorder 0..* Reference(HCIM Problem) Disorder
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective-Disorder
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Identifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... Slices for category Σ 2..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... category:livingWill Σ 1..1 CodeableConcept Living will and advance directive record
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement



Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11341000146107
.... category:typeOfLivingWill Σ 1..1 CodeableConcept TypeOfLivingWill
Binding: WilsverklaringTypeCodelijst (required): List of the different types of living wills.


..... coding Σ 1..* Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
... patient Σ 1..1 Reference(nl-core-patient) Who the consent applies to
... dateTime Σ 1..1 dateTime LivingWillDate
... consentingParty Σ 0..1 Reference(nl-core-relatedperson) Representative
... organization Σ 0..* Reference(nl-core-organization) Custodian of the consent
... source[x] Σ 0..1 LivingWillDocument
.... sourceAttachment Attachment
.... sourceIdentifier Identifier
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes
from the FHIR Standard
Consent.categoryexampleConsent Category Codes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:livingWillexamplePattern: SNOMED CT code 11341000146107
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:typeOfLivingWillrequiredWilsverklaringTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorConsentIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ppc-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C 0..* Consent LivingWill
ppc-1: Either a Policy or PolicyRule
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... disorder 0..* Reference(HCIM Problem) Disorder
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective-Disorder
... comment 0..1 string Comment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Identifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... Slices for category Σ 2..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... category:livingWill Σ 1..1 CodeableConcept Living will and advance directive record
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement



Required Pattern: At least the following
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11341000146107
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... category:typeOfLivingWill Σ 1..1 CodeableConcept TypeOfLivingWill
Binding: WilsverklaringTypeCodelijst (required): List of the different types of living wills.


..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..* Coding Code defined by a terminology system
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(nl-core-patient) Who the consent applies to
... period Σ 0..1 Period Period that this consent applies
... dateTime Σ 1..1 dateTime LivingWillDate
... consentingParty Σ 0..1 Reference(nl-core-relatedperson) Representative
... actor Σ 0..* BackboneElement Who|what controlled by this consent (or group, by role)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

.... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... action Σ 0..* CodeableConcept Actions controlled by this consent
Binding: Consent Action Codes (example): Detailed codes for the consent action.


... organization Σ 0..* Reference(nl-core-organization) Custodian of the consent
... source[x] Σ 0..1 LivingWillDocument
.... sourceAttachment Attachment
.... sourceIdentifier Identifier
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..* BackboneElement Policies covered by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... authority C 0..1 uri Enforcement source for policy
.... uri C 0..1 uri Specific policy covered by this consent
... policyRule ΣC 0..1 uri Policy that this consents to
... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... purpose Σ 0..* Coding Context of activities for which the agreement is made
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels


... dataPeriod Σ 0..1 Period Timeframe for data controlled by this consent
... data Σ 0..* BackboneElement Data controlled by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

.... reference Σ 1..1 Reference(Resource) The actual data reference
... except Σ 0..* BackboneElement Additional rule - addition or removal of permissions
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type Σ 1..1 code deny | permit
Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent

.... period Σ 0..1 Period Timeframe for this exception
.... actor Σ 0..* BackboneElement Who|what controlled by this exception (or group, by role)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

..... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... action Σ 0..* CodeableConcept Actions controlled by this exception
Binding: Consent Action Codes (example): Detailed codes for the consent action.


.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose Σ 0..* Coding Context of activities covered by this exception
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels


.... class Σ 0..* Coding e.g. Resource Type, Profile, or CDA etc
Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers


.... code Σ 0..* Coding e.g. LOINC or SNOMED CT code, etc in the content
Binding: Consent Content Codes (example): If this code is found in an instance, then the exception applies


.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this exception
.... data Σ 0..* BackboneElement Data controlled by this exception
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

..... reference Σ 1..1 Reference(Resource) The actual data reference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes
from the FHIR Standard
Consent.categoryexampleConsent Category Codes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:livingWillexamplePattern: SNOMED CT code 11341000146107
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:typeOfLivingWillrequiredWilsverklaringTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
from this IG
Consent.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.actionexampleConsent Action Codes
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.purposeextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
Consent.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning
from the FHIR Standard
Consent.except.typerequiredConsentExceptType
http://hl7.org/fhir/ValueSet/consent-except-type
from the FHIR Standard
Consent.except.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.except.actionexampleConsent Action Codes
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.except.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.except.purposeextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
Consent.except.classextensibleConsent Content Class
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Consent.except.codeexampleConsent Content Codes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/consent-content-code
from the FHIR Standard
Consent.except.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorConsentIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ppc-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..* Consent LivingWill
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... disorder 0..* Reference(HCIM Problem) Disorder
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective-Disorder
... comment 0..1 string Comment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
... Slices for category 2..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
.... category:livingWill 1..1 CodeableConcept Living will and advance directive record
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11341000146107
..... coding
...... display 0..1 string Representation defined by the system
.... category:typeOfLivingWill 1..1 CodeableConcept TypeOfLivingWill
Binding: WilsverklaringTypeCodelijst (required): List of the different types of living wills.

..... coding 1..* Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
... patient 1..1 Reference(nl-core-patient) Who the consent applies to
... dateTime 1..1 dateTime LivingWillDate
... consentingParty 0..1 Reference(nl-core-relatedperson) Representative
... actor
.... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... organization 0..* Reference(nl-core-organization) Custodian of the consent
... source[x] 0..1 Attachment, Identifier, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) LivingWillDocument
... except
.... actor
..... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Consent.category:typeOfLivingWillrequiredWilsverklaringTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C 0..* Consent LivingWill
ppc-1: Either a Policy or PolicyRule
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... disorder 0..* Reference(HCIM Problem) Disorder
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective-Disorder
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Identifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... Slices for category Σ 2..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... category:livingWill Σ 1..1 CodeableConcept Living will and advance directive record
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement



Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11341000146107
.... category:typeOfLivingWill Σ 1..1 CodeableConcept TypeOfLivingWill
Binding: WilsverklaringTypeCodelijst (required): List of the different types of living wills.


..... coding Σ 1..* Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
... patient Σ 1..1 Reference(nl-core-patient) Who the consent applies to
... dateTime Σ 1..1 dateTime LivingWillDate
... consentingParty Σ 0..1 Reference(nl-core-relatedperson) Representative
... organization Σ 0..* Reference(nl-core-organization) Custodian of the consent
... source[x] Σ 0..1 LivingWillDocument
.... sourceAttachment Attachment
.... sourceIdentifier Identifier
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes
from the FHIR Standard
Consent.categoryexampleConsent Category Codes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:livingWillexamplePattern: SNOMED CT code 11341000146107
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:typeOfLivingWillrequiredWilsverklaringTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorConsentIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ppc-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C 0..* Consent LivingWill
ppc-1: Either a Policy or PolicyRule
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... disorder 0..* Reference(HCIM Problem) Disorder
URL: http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective-Disorder
... comment 0..1 string Comment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Identifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... Slices for category Σ 2..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... category:livingWill Σ 1..1 CodeableConcept Living will and advance directive record
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement



Required Pattern: At least the following
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11341000146107
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... category:typeOfLivingWill Σ 1..1 CodeableConcept TypeOfLivingWill
Binding: WilsverklaringTypeCodelijst (required): List of the different types of living wills.


..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..* Coding Code defined by a terminology system
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(nl-core-patient) Who the consent applies to
... period Σ 0..1 Period Period that this consent applies
... dateTime Σ 1..1 dateTime LivingWillDate
... consentingParty Σ 0..1 Reference(nl-core-relatedperson) Representative
... actor Σ 0..* BackboneElement Who|what controlled by this consent (or group, by role)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

.... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... action Σ 0..* CodeableConcept Actions controlled by this consent
Binding: Consent Action Codes (example): Detailed codes for the consent action.


... organization Σ 0..* Reference(nl-core-organization) Custodian of the consent
... source[x] Σ 0..1 LivingWillDocument
.... sourceAttachment Attachment
.... sourceIdentifier Identifier
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..* BackboneElement Policies covered by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... authority C 0..1 uri Enforcement source for policy
.... uri C 0..1 uri Specific policy covered by this consent
... policyRule ΣC 0..1 uri Policy that this consents to
... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... purpose Σ 0..* Coding Context of activities for which the agreement is made
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels


... dataPeriod Σ 0..1 Period Timeframe for data controlled by this consent
... data Σ 0..* BackboneElement Data controlled by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

.... reference Σ 1..1 Reference(Resource) The actual data reference
... except Σ 0..* BackboneElement Additional rule - addition or removal of permissions
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type Σ 1..1 code deny | permit
Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent

.... period Σ 0..1 Period Timeframe for this exception
.... actor Σ 0..* BackboneElement Who|what controlled by this exception (or group, by role)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

..... reference 1..1 Reference(Device | Group | CareTeam | nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Resource for the actor (or group, by role)
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... action Σ 0..* CodeableConcept Actions controlled by this exception
Binding: Consent Action Codes (example): Detailed codes for the consent action.


.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose Σ 0..* Coding Context of activities covered by this exception
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels


.... class Σ 0..* Coding e.g. Resource Type, Profile, or CDA etc
Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers


.... code Σ 0..* Coding e.g. LOINC or SNOMED CT code, etc in the content
Binding: Consent Content Codes (example): If this code is found in an instance, then the exception applies


.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this exception
.... data Σ 0..* BackboneElement Data controlled by this exception
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

..... reference Σ 1..1 Reference(Resource) The actual data reference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Consent.statusrequiredConsentState
http://hl7.org/fhir/ValueSet/consent-state-codes
from the FHIR Standard
Consent.categoryexampleConsent Category Codes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:livingWillexamplePattern: SNOMED CT code 11341000146107
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:typeOfLivingWillrequiredWilsverklaringTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
from this IG
Consent.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.actionexampleConsent Action Codes
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.purposeextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
Consent.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning
from the FHIR Standard
Consent.except.typerequiredConsentExceptType
http://hl7.org/fhir/ValueSet/consent-except-type
from the FHIR Standard
Consent.except.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.except.actionexampleConsent Action Codes
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.except.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.except.purposeextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
Consent.except.classextensibleConsent Content Class
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Consent.except.codeexampleConsent Content Codes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/consent-content-code
from the FHIR Standard
Consent.except.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorConsentIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ppc-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()

 

Other representations of profile: CSV, Excel, Schematron