Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic en Chipsoft. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

ZIB Wilsverklaring

User-Interface guidance

Belangrijk dat de UI Schets van Behandelaanwijzing en de UI Schets van Wilsverklaring in één scherm te tonen.

Een schets van het scherm met labels en sortering informatie

Kolom definities:

Request

1. Opvragen (search) wilsbeschikkingen

   GET <ontsluiten-bronsysteem-base>/Consent?patient=<fhir_patient_id>&category=http://snomed.info/sct|11341000146107

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de VEKTIS AGB-Z code of de HL7 NL OID van de zorgaanbieder. Dit wordt vervolgens gebruikt in de “Bron” kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

​Optioneel: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Zib AdvanceDirective

Name	Flags	Card.	Type	Description & Constraints
Consent		0..*	Zib AdvanceDirective	LivingWill
Slices for category				Content/Rules for all slices
category:typeOfLivingWill	S	1..1	CodeableConcept	TypeOfLivingWill
dateTime	S	1..1	dateTime	LivingWillDate
consentingParty	S	0..1	Reference(nl-core-relatedperson)	Representative
sourceAttachment	S	0..1	Attachment	LivingWillDocument
data	S	0..1	base64Binary	Data inline, base64ed
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	Zib AdvanceDirective	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				Content/Rules for all slices
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
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	SΣ	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	SΣ	1..1	dateTime	LivingWillDate
consentingParty	SΣ	0..1	Reference(nl-core-relatedperson)	Representative
Slices for source[x]	Σ	0..1	Attachment	LivingWillDocument Slice: Unordered, Closed by type:$this
source[x]:sourceAttachment	SΣ	0..1	Attachment	LivingWillDocument
data	S	0..1	base64Binary	Data inline, base64ed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard
Consent.category	example	Consent Category Codes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:livingWill	example	Pattern: SNOMED CT code 11341000146107 http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:typeOfLivingWill	required	WilsverklaringTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Consent	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	Zib AdvanceDirective	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 Bindings Purpose 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	SΣ	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	SΣ	1..1	dateTime	LivingWillDate
consentingParty	SΣ	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
Slices for source[x]	Σ	0..1	Attachment	LivingWillDocument Slice: Unordered, Closed by type:$this
source[x]:sourceAttachment	SΣ	0..1	Attachment	LivingWillDocument
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data	S	0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	uri	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
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 Example General Dutch Law: http://wetten.overheid.nl/
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard
Consent.category	example	Consent Category Codes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:livingWill	example	Pattern: SNOMED CT code 11341000146107 http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:typeOfLivingWill	required	WilsverklaringTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
Consent.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.action	example	Consent Action Codes http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard
Consent.source[x]:sourceAttachment.contentType	required	http://hl7.org/fhir/ValueSet/mimetypes http://hl7.org/fhir/ValueSet/mimetypes
Consent.source[x]:sourceAttachment.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Consent.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.purpose	extensible	PurposeOfUse http://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard
Consent.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard
Consent.except.type	required	ConsentExceptType http://hl7.org/fhir/ValueSet/consent-except-type from the FHIR Standard
Consent.except.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.except.action	example	Consent Action Codes http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard
Consent.except.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.except.purpose	extensible	PurposeOfUse http://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard
Consent.except.class	extensible	Consent Content Class http://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard
Consent.except.code	example	Consent Content Codes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard
Consent.except.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Consent	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()

Differential View

This structure is derived from Zib AdvanceDirective

Name	Flags	Card.	Type	Description & Constraints
Consent		0..*	Zib AdvanceDirective	LivingWill
Slices for category				Content/Rules for all slices
category:typeOfLivingWill	S	1..1	CodeableConcept	TypeOfLivingWill
dateTime	S	1..1	dateTime	LivingWillDate
consentingParty	S	0..1	Reference(nl-core-relatedperson)	Representative
sourceAttachment	S	0..1	Attachment	LivingWillDocument
data	S	0..1	base64Binary	Data inline, base64ed
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	Zib AdvanceDirective	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				Content/Rules for all slices
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
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	SΣ	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	SΣ	1..1	dateTime	LivingWillDate
consentingParty	SΣ	0..1	Reference(nl-core-relatedperson)	Representative
Slices for source[x]	Σ	0..1	Attachment	LivingWillDocument Slice: Unordered, Closed by type:$this
source[x]:sourceAttachment	SΣ	0..1	Attachment	LivingWillDocument
data	S	0..1	base64Binary	Data inline, base64ed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard
Consent.category	example	Consent Category Codes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:livingWill	example	Pattern: SNOMED CT code 11341000146107 http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:typeOfLivingWill	required	WilsverklaringTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Consent	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	Zib AdvanceDirective	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 Bindings Purpose 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	SΣ	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	SΣ	1..1	dateTime	LivingWillDate
consentingParty	SΣ	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
Slices for source[x]	Σ	0..1	Attachment	LivingWillDocument Slice: Unordered, Closed by type:$this
source[x]:sourceAttachment	SΣ	0..1	Attachment	LivingWillDocument
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data	S	0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	uri	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
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 Example General Dutch Law: http://wetten.overheid.nl/
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes from the FHIR Standard
Consent.category	example	Consent Category Codes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:livingWill	example	Pattern: SNOMED CT code 11341000146107 http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.category:typeOfLivingWill	required	WilsverklaringTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.15.1--20171231000000
Consent.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.action	example	Consent Action Codes http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard
Consent.source[x]:sourceAttachment.contentType	required	http://hl7.org/fhir/ValueSet/mimetypes http://hl7.org/fhir/ValueSet/mimetypes
Consent.source[x]:sourceAttachment.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Consent.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.purpose	extensible	PurposeOfUse http://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard
Consent.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard
Consent.except.type	required	ConsentExceptType http://hl7.org/fhir/ValueSet/consent-except-type from the FHIR Standard
Consent.except.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.except.action	example	Consent Action Codes http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard
Consent.except.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.except.purpose	extensible	PurposeOfUse http://hl7.org/fhir/ValueSet/v3-PurposeOfUse from the FHIR Standard
Consent.except.class	extensible	Consent Content Class http://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard
Consent.except.code	example	Consent Content Codes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard
Consent.except.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Consent	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()

This structure is derived from Zib AdvanceDirective

Summary

Must-Support: 5 elements