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

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/TreatmentDirective Version: 0.2.1
Draft as of 2023-03-22 Computable Name: TreatmentDirective

The minimal ACP TreatmentDirective (Consent) for the Zorgviewer

ACP

Aanvullingen vanuit de ACP set…

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.

Bronsysteem herkennen

De Zorgviewer-backend ZOU na bevragen van het bronsysteem aan elk resultaat resource een meta-tag MOETEN toevoegen met de VEKTIZ code van de zorgaanbieder, zodat dit kan worden gebruikt in de presentatie in de Zorgviewer-frontend.

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

{ ...
  "meta": {
    "tag": [
      { "system": "http://hl7.nl/fhir/zorgviewer-ig/bronsysteem-zorgaanbieder",
        "code": "06020101",
        "display": "UMCG"
      } ] }
  ... }

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Zib TreatmentDirective

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*Zib TreatmentDirectiveTreatmentDirective
... extension:treatment S0..*Zib TreatmentDirective TreatmentOptional Extensions Element
.... valueCodeableConcept:valueCodeableConcept S0..1CodeableConceptTreatment
Binding: ACP-TreatmentCodelist (extensible): The medical treatment to which the treatment instruction applies.

... extension:comments S0..*ExtensionExtension
... modifierExtension:treatmentPermitted S1..1Zib TreatmentDirective TreatmentPermittedExtension

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.extension:treatment.valueCodeableConcept:valueCodeableConceptextensibleACPTreatmentCodelist
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*Zib TreatmentDirectiveTreatmentDirective
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... verification 0..*(Complex)Verification
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification
.... extension:Verified 1..1ExtensionVerified
..... url 1..1uri"Verified"
..... Slices for value[x] 0..1booleanValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueBoolean 0..1booleanVerified
.... extension:VerifiedWith 0..*ExtensionVerifiedWith
..... url 1..1uri"VerifiedWith"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GeverifieerdBijCodelijst (extensible): The person with whom the treatment instruction was discussed and verified.

.... extension:VerificationDate 0..1ExtensionVerificationDate
..... url 1..1uri"VerificationDate"
..... Slices for value[x] 0..1dateTimeValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueDateTime 0..1dateTimeVerificationDate
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification"
... comment 0..1stringComment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S0..1CodeableConceptTreatment
Binding: ACP-TreatmentCodelist (extensible): The medical treatment to which the treatment instruction applies.

... additionalSources 0..*Attachment, Identifier, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources"
... extension:comments S0..*ExtensionExtension
... Slices for modifierExtension ?!0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension:treatmentPermitted ?!S1..1Zib TreatmentDirective TreatmentPermittedExtension
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-TreatmentPermitted"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptTreatmentPermitted
Binding: BehandelingToegestaanCodelijst (extensible): Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints.

... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... category Σ1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:treatmentDirective Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 11291000146105
... patient Σ1..1Reference(nl-core-patient)Who the consent applies to

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Consent.extension:verification.extension:VerifiedWith.value[x]:valueCodeableConceptextensibleGeverifieerdBijCodelijst
Consent.extension:treatment.value[x]:valueCodeableConceptextensibleACPTreatmentCodelist
Consent.modifierExtension:treatmentPermitted.value[x]:valueCodeableConceptextensibleBehandelingToegestaanCodelijst
Consent.statusrequiredConsentState
Consent.categoryexampleConsent Category Codes

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()
hcim-treatmentdirective-1errorConsentextension.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-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*Zib TreatmentDirectiveTreatmentDirective
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... verification 0..*(Complex)Verification
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:Verified 1..1ExtensionVerified
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"Verified"
..... Slices for value[x] 0..1booleanValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueBoolean 0..1booleanVerified
.... extension:VerifiedWith 0..*ExtensionVerifiedWith
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"VerifiedWith"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GeverifieerdBijCodelijst (extensible): The person with whom the treatment instruction was discussed and verified.

.... extension:VerificationDate 0..1ExtensionVerificationDate
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"VerificationDate"
..... Slices for value[x] 0..1dateTimeValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueDateTime 0..1dateTimeVerificationDate
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification"
... comment 0..1stringComment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
... treatment S0..*CodeableConceptOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S0..1CodeableConceptTreatment
Binding: ACP-TreatmentCodelist (extensible): The medical treatment to which the treatment instruction applies.

... additionalSources 0..*Attachment, Identifier, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources"
.... value[x] 0..1AdvanceDirective
..... valueAttachmentAttachment
..... valueIdentifierIdentifier
..... valueReferenceReference(HCIM AdvanceDirective | DocumentReference | Contract | QuestionnaireResponse)
... extension:comments S0..*ExtensionExtension
... Slices for modifierExtension ?!0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension:treatmentPermitted ?!S1..1Zib TreatmentDirective TreatmentPermittedExtension
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-TreatmentPermitted"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptTreatmentPermitted
Binding: BehandelingToegestaanCodelijst (extensible): Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints.

... identifier Σ0..1IdentifierIdentifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... category Σ1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:treatmentDirective Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 11291000146105
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(nl-core-patient)Who the consent applies to
... period Σ0..1PeriodPeriod that this consent applies
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTimeStartDate
.... end ΣC0..1dateTimeEndDate
... dateTime Σ0..1dateTimeWhen this Consent was created or indexed
... consentingParty Σ0..*Reference(nl-core-relatedperson | nl-core-organization | nl-core-patient | nl-core-practitioner)Who is agreeing to the policy and exceptions
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... actor Σ0..*BackboneElementWho|what controlled by this consent (or group, by role)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

.... reference 1..1Reference(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..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... action Σ0..*CodeableConceptActions 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..1AdvanceDirective
.... sourceAttachmentAttachment
.... sourceIdentifierIdentifier
.... sourceReferenceReference(HCIM AdvanceDirective | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..*BackboneElementPolicies covered by this consent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... authority C0..1uriEnforcement source for policy
.... uri C0..1uriSpecific policy covered by this consent
Example General Dutch Law: http://wetten.overheid.nl/
... policyRule ΣC0..1uriPolicy that this consents to
... securityLabel Σ0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... purpose Σ0..*CodingContext 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..1PeriodTimeframe for data controlled by this consent
... data Σ0..*BackboneElementData controlled by this consent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

.... reference Σ1..1Reference(Resource)The actual data reference
... except Σ0..*BackboneElementAdditional rule - addition or removal of permissions
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... restrictions 0..*stringRestrictions
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Restrictions
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1codedeny | permit
Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent

.... period Σ0..1PeriodTimeframe for this exception
.... actor Σ0..*BackboneElementWho|what controlled by this exception (or group, by role)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

..... reference 1..1Reference(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..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
.... action Σ0..*CodeableConceptActions controlled by this exception
Binding: Consent Action Codes (example): Detailed codes for the consent action.


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


.... purpose Σ0..*CodingContext 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..*Codinge.g. Resource Type, Profile, or CDA etc
Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers


.... code Σ0..*Codinge.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..1PeriodTimeframe for data controlled by this exception
.... data Σ0..*BackboneElementData controlled by this exception
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Consent.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.extension:verification.extension:VerifiedWith.value[x]:valueCodeableConceptextensibleGeverifieerdBijCodelijst
Consent.extension:treatment.value[x]:valueCodeableConceptextensibleACPTreatmentCodelist
Consent.modifierExtension:treatmentPermitted.value[x]:valueCodeableConceptextensibleBehandelingToegestaanCodelijst
Consent.statusrequiredConsentState
Consent.categoryexampleConsent Category Codes
Consent.actor.roleextensibleSecurityRoleType
Consent.actionexampleConsent Action Codes
Consent.securityLabelextensibleAll Security Labels
Consent.purposeextensiblePurposeOfUse
Consent.data.meaningrequiredConsentDataMeaning
Consent.except.typerequiredConsentExceptType
Consent.except.actor.roleextensibleSecurityRoleType
Consent.except.actionexampleConsent Action Codes
Consent.except.securityLabelextensibleAll Security Labels
Consent.except.purposeextensiblePurposeOfUse
Consent.except.classextensibleConsent Content Class
Consent.except.codeexampleConsent Content Codes (a valid code from LOINC)
Consent.except.data.meaningrequiredConsentDataMeaning

Constraints

IdGradePath(s)DetailsRequirements
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()

This structure is derived from Zib TreatmentDirective

Summary

Must-Support: 4 elements

Differential View

This structure is derived from Zib TreatmentDirective

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*Zib TreatmentDirectiveTreatmentDirective
... extension:treatment S0..*Zib TreatmentDirective TreatmentOptional Extensions Element
.... valueCodeableConcept:valueCodeableConcept S0..1CodeableConceptTreatment
Binding: ACP-TreatmentCodelist (extensible): The medical treatment to which the treatment instruction applies.

... extension:comments S0..*ExtensionExtension
... modifierExtension:treatmentPermitted S1..1Zib TreatmentDirective TreatmentPermittedExtension

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.extension:treatment.valueCodeableConcept:valueCodeableConceptextensibleACPTreatmentCodelist

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*Zib TreatmentDirectiveTreatmentDirective
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... verification 0..*(Complex)Verification
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification
.... extension:Verified 1..1ExtensionVerified
..... url 1..1uri"Verified"
..... Slices for value[x] 0..1booleanValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueBoolean 0..1booleanVerified
.... extension:VerifiedWith 0..*ExtensionVerifiedWith
..... url 1..1uri"VerifiedWith"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GeverifieerdBijCodelijst (extensible): The person with whom the treatment instruction was discussed and verified.

.... extension:VerificationDate 0..1ExtensionVerificationDate
..... url 1..1uri"VerificationDate"
..... Slices for value[x] 0..1dateTimeValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueDateTime 0..1dateTimeVerificationDate
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification"
... comment 0..1stringComment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S0..1CodeableConceptTreatment
Binding: ACP-TreatmentCodelist (extensible): The medical treatment to which the treatment instruction applies.

... additionalSources 0..*Attachment, Identifier, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources"
... extension:comments S0..*ExtensionExtension
... Slices for modifierExtension ?!0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension:treatmentPermitted ?!S1..1Zib TreatmentDirective TreatmentPermittedExtension
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-TreatmentPermitted"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptTreatmentPermitted
Binding: BehandelingToegestaanCodelijst (extensible): Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints.

... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... category Σ1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:treatmentDirective Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 11291000146105
... patient Σ1..1Reference(nl-core-patient)Who the consent applies to

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Consent.extension:verification.extension:VerifiedWith.value[x]:valueCodeableConceptextensibleGeverifieerdBijCodelijst
Consent.extension:treatment.value[x]:valueCodeableConceptextensibleACPTreatmentCodelist
Consent.modifierExtension:treatmentPermitted.value[x]:valueCodeableConceptextensibleBehandelingToegestaanCodelijst
Consent.statusrequiredConsentState
Consent.categoryexampleConsent Category Codes

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()
hcim-treatmentdirective-1errorConsentextension.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-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*Zib TreatmentDirectiveTreatmentDirective
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... verification 0..*(Complex)Verification
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:Verified 1..1ExtensionVerified
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"Verified"
..... Slices for value[x] 0..1booleanValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueBoolean 0..1booleanVerified
.... extension:VerifiedWith 0..*ExtensionVerifiedWith
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"VerifiedWith"
..... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GeverifieerdBijCodelijst (extensible): The person with whom the treatment instruction was discussed and verified.

.... extension:VerificationDate 0..1ExtensionVerificationDate
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"VerificationDate"
..... Slices for value[x] 0..1dateTimeValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueDateTime 0..1dateTimeVerificationDate
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Verification"
... comment 0..1stringComment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
... treatment S0..*CodeableConceptOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Treatment"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S0..1CodeableConceptTreatment
Binding: ACP-TreatmentCodelist (extensible): The medical treatment to which the treatment instruction applies.

... additionalSources 0..*Attachment, Identifier, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/consent-additionalSources"
.... value[x] 0..1AdvanceDirective
..... valueAttachmentAttachment
..... valueIdentifierIdentifier
..... valueReferenceReference(HCIM AdvanceDirective | DocumentReference | Contract | QuestionnaireResponse)
... extension:comments S0..*ExtensionExtension
... Slices for modifierExtension ?!0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension:treatmentPermitted ?!S1..1Zib TreatmentDirective TreatmentPermittedExtension
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-TreatmentPermitted"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptTreatmentPermitted
Binding: BehandelingToegestaanCodelijst (extensible): Indication of permission for the treatment, no permission for the treatment, or permission for the treatment with constraints.

... identifier Σ0..1IdentifierIdentifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent

... category Σ1..*CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:treatmentDirective Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 11291000146105
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(nl-core-patient)Who the consent applies to
... period Σ0..1PeriodPeriod that this consent applies
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTimeStartDate
.... end ΣC0..1dateTimeEndDate
... dateTime Σ0..1dateTimeWhen this Consent was created or indexed
... consentingParty Σ0..*Reference(nl-core-relatedperson | nl-core-organization | nl-core-patient | nl-core-practitioner)Who is agreeing to the policy and exceptions
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... actor Σ0..*BackboneElementWho|what controlled by this consent (or group, by role)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

.... reference 1..1Reference(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..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... action Σ0..*CodeableConceptActions 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..1AdvanceDirective
.... sourceAttachmentAttachment
.... sourceIdentifierIdentifier
.... sourceReferenceReference(HCIM AdvanceDirective | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..*BackboneElementPolicies covered by this consent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... authority C0..1uriEnforcement source for policy
.... uri C0..1uriSpecific policy covered by this consent
Example General Dutch Law: http://wetten.overheid.nl/
... policyRule ΣC0..1uriPolicy that this consents to
... securityLabel Σ0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... purpose Σ0..*CodingContext 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..1PeriodTimeframe for data controlled by this consent
... data Σ0..*BackboneElementData controlled by this consent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

.... reference Σ1..1Reference(Resource)The actual data reference
... except Σ0..*BackboneElementAdditional rule - addition or removal of permissions
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... restrictions 0..*stringRestrictions
URL: http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective-Restrictions
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1codedeny | permit
Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent

.... period Σ0..1PeriodTimeframe for this exception
.... actor Σ0..*BackboneElementWho|what controlled by this exception (or group, by role)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations

..... reference 1..1Reference(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..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
.... action Σ0..*CodeableConceptActions controlled by this exception
Binding: Consent Action Codes (example): Detailed codes for the consent action.


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


.... purpose Σ0..*CodingContext 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..*Codinge.g. Resource Type, Profile, or CDA etc
Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers


.... code Σ0..*Codinge.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..1PeriodTimeframe for data controlled by this exception
.... data Σ0..*BackboneElementData controlled by this exception
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Consent.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.extension:verification.extension:VerifiedWith.value[x]:valueCodeableConceptextensibleGeverifieerdBijCodelijst
Consent.extension:treatment.value[x]:valueCodeableConceptextensibleACPTreatmentCodelist
Consent.modifierExtension:treatmentPermitted.value[x]:valueCodeableConceptextensibleBehandelingToegestaanCodelijst
Consent.statusrequiredConsentState
Consent.categoryexampleConsent Category Codes
Consent.actor.roleextensibleSecurityRoleType
Consent.actionexampleConsent Action Codes
Consent.securityLabelextensibleAll Security Labels
Consent.purposeextensiblePurposeOfUse
Consent.data.meaningrequiredConsentDataMeaning
Consent.except.typerequiredConsentExceptType
Consent.except.actor.roleextensibleSecurityRoleType
Consent.except.actionexampleConsent Action Codes
Consent.except.securityLabelextensibleAll Security Labels
Consent.except.purposeextensiblePurposeOfUse
Consent.except.classextensibleConsent Content Class
Consent.except.codeexampleConsent Content Codes (a valid code from LOINC)
Consent.except.data.meaningrequiredConsentDataMeaning

Constraints

IdGradePath(s)DetailsRequirements
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()

This structure is derived from Zib TreatmentDirective

Summary

Must-Support: 4 elements

 

Other representations of profile: CSV, Excel, Schematron