Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/nl-core-TreatmentDirective2 | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: NlcoreTreatmentDirective2 | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
A treatment directive contains a joint decision between a health professional (for example a general practitioner) and a patient or his representative(s) about the desirability of performing a certain treatment, such as resuscitation, before this treatment becomes (acute) necessary. When the need arises and the treatment cannot be discussed with the patient or representative (s), that decision is an important indication for the treating health professional (for example an ER doctor). The term treatment limit is a synonym of the term treatment directive.
A derived profile from zib-TreatmentDirective2 to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ZibTreatmentDirective2
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Consent | 0..* | ZibTreatmentDirective2 | TreatmentDirective | |
  extension:additionalAdvanceDirective | 0..* | ExtTreatmentDirective2AdvanceDirective | Optional Extensions Element | |
   value[x] | 0..1 | Reference(nl core AdvanceDirective) | AdvanceDirective | |
 patient | 0..1 | Reference(Patient | nl core Patient) | Who the consent applies to | |
| source[x]:sourceReference | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | nl core AdvanceDirective) | AdvanceDirective | |
  provision | ||||
 actor:agreementParty | 0..* | BackboneElement | AgreementParty | |
| reference | 1..1 | PatternNlCoreHealthProfessionalReference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | nl core Patient | nl core ContactPerson | nl core HealthProfessional PractitionerRole) | Patient / Representative / HealthProfessional | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | ZibTreatmentDirective2 | TreatmentDirective |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| additionalAdvanceDirective | C | 0..* | Reference(zib AdvanceDirective) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective |
 url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |
| value[x] | C | 0..1 | Reference(nl core AdvanceDirective) | AdvanceDirective |
 Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| modifierExtension:specificationOther | ?!C | 0..1 | ExtTreatmentDirective2SpecificationOther | Extension |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther" | |
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
 scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. 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://terminology.hl7.org/CodeSystem/consentscope | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: treatment | |
| category | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. 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: 129125009 | |
| patient | Σ | 0..1 | Reference(Patient | nl core Patient) | Who the consent applies to |
 Slices for source[x] | ΣC | 0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this | |
 sourceAttachment | Attachment | |||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
 source[x]:sourceReference | ΣC | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | nl core AdvanceDirective) | AdvanceDirective |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Consent.status | required | ConsentState |
| Consent.scope | extensible | Pattern: treatment |
| Consent.category | extensible | Pattern: SNOMED CT code 129125009 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| zib-TreatmentDirective2-1 | error | Consent | `extension.additionalAdvanceDirective` may only be used for AdvanceDirective references in addition to first reference in `.source[x]`. : extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective').empty() or source.exists() | |
| zib-TreatmentDirective2-2 | error | Consent | If the specificationOther extension is used, `.provision.type` MUST be absent and vice versa : (extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificitionOther').exists() and provision.type.exists()).not() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent | C | 0..* | ZibTreatmentDirective2 | TreatmentDirective | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | Comment | |||||
| additionalAdvanceDirective | C | 0..* | Reference(zib AdvanceDirective) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |||||
| value[x] | C | 0..1 | Reference(nl core AdvanceDirective) | AdvanceDirective | ||||
| Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:specificationOther | ?!C | 0..1 | ExtTreatmentDirective2SpecificationOther | Extension | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther" | |||||
| value[x] | C | 0..1 | string | SpecificationOther | ||||
| identifier | Σ | 0..* | 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. | ||||
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: treatment | |||||
| 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 | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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: 129125009 | |||||
| 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 | Σ | 0..1 | Reference(Patient | nl core Patient) | Who the consent applies to | ||||
| dateTime | Σ | 0..1 | dateTime | MostRecentReviewDate | ||||
| performer | Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
| organization | Σ | 0..* | Reference(Organization) | Custodian of the consent | ||||
| Slices for source[x] | ΣC | 0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this | |||||
| sourceAttachment | Attachment | |||||||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| source[x]:sourceReference | ΣC | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | nl core AdvanceDirective) | AdvanceDirective | ||||
| policy | 0..* | BackboneElement | Policies covered by this consent | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority | C | 0..1 | uri | Enforcement source for policy | ||||
| uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| verified | Σ | 1..1 | boolean | Has been verified | ||||
| verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate | 0..1 | dateTime | When consent verified | |||||
| provision | Σ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| reasonForEnding | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.ReasonForEnding | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | ΣC | 0..1 | code | TreatmentDecision Binding: ConsentProvisionType (required): Use ConceptMap TreatmentDecisionCodelist-to-ConsentProvisionType to translate terminology from the functional model to profile terminology in ValueSet ConsentProvisionType. | ||||
| period | Σ | 0..1 | Period | Timeframe for this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | DateExpired | ||||
| Slices for actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by value:role | |||||
 actor:All Slices | Content/Rules for all slices | |||||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
 actor:agreementParty | 0..* | BackboneElement | AgreementParty | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
 role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CONSENTER | |||||
| 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 | |||||
| reference | 1..1 | PatternNlCoreHealthProfessionalReference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | nl core Patient | nl core ContactPerson | nl core HealthProfessional PractitionerRole) | Patient / Representative / HealthProfessional | |||||
| action | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose | Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code | Σ | 0..1 | CodeableConcept | Treatment Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.2.2.1--20200901000000 (required) | ||||
| dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| data | Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Consent.language | preferred | CommonLanguages
| ||||
| Consent.status | required | ConsentState | ||||
| Consent.scope | extensible | Pattern: treatment | ||||
| Consent.category | extensible | Pattern: SNOMED CT code 129125009 | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodes | ||||
| Consent.provision.type | required | ConsentProvisionType | ||||
| Consent.provision.actor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:agreementParty.role | extensible | Pattern: CONSENTER | ||||
| Consent.provision.action | example | ConsentActionCodes | ||||
| Consent.provision.securityLabel | extensible | All Security Labels | ||||
| Consent.provision.purpose | extensible | PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClass | ||||
| Consent.provision.code | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.2.2.1--20200901000000 | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaning |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| zib-TreatmentDirective2-1 | error | Consent | `extension.additionalAdvanceDirective` may only be used for AdvanceDirective references in addition to first reference in `.source[x]`. : extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective').empty() or source.exists() | |
| zib-TreatmentDirective2-2 | error | Consent | If the specificationOther extension is used, `.provision.type` MUST be absent and vice versa : (extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificitionOther').exists() and provision.type.exists()).not() |
This structure is derived from ZibTreatmentDirective2
Summary
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ZibTreatmentDirective2
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | 0..* | ZibTreatmentDirective2 | TreatmentDirective | |
| extension:additionalAdvanceDirective | 0..* | ExtTreatmentDirective2AdvanceDirective | Optional Extensions Element | |
| value[x] | 0..1 | Reference(nl core AdvanceDirective) | AdvanceDirective | |
| patient | 0..1 | Reference(Patient | nl core Patient) | Who the consent applies to | |
| source[x]:sourceReference | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | nl core AdvanceDirective) | AdvanceDirective | |
| provision | ||||
| actor:agreementParty | 0..* | BackboneElement | AgreementParty | |
| reference | 1..1 | PatternNlCoreHealthProfessionalReference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | nl core Patient | nl core ContactPerson | nl core HealthProfessional PractitionerRole) | Patient / Representative / HealthProfessional | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | ZibTreatmentDirective2 | TreatmentDirective |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| additionalAdvanceDirective | C | 0..* | Reference(zib AdvanceDirective) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |
| value[x] | C | 0..1 | Reference(nl core AdvanceDirective) | AdvanceDirective |
| Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| modifierExtension:specificationOther | ?!C | 0..1 | ExtTreatmentDirective2SpecificationOther | Extension |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther" | |
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. 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://terminology.hl7.org/CodeSystem/consentscope | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: treatment | |
| category | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. 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: 129125009 | |
| patient | Σ | 0..1 | Reference(Patient | nl core Patient) | Who the consent applies to |
| Slices for source[x] | ΣC | 0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this | |
| sourceAttachment | Attachment | |||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
| source[x]:sourceReference | ΣC | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | nl core AdvanceDirective) | AdvanceDirective |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Consent.status | required | ConsentState |
| Consent.scope | extensible | Pattern: treatment |
| Consent.category | extensible | Pattern: SNOMED CT code 129125009 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| zib-TreatmentDirective2-1 | error | Consent | `extension.additionalAdvanceDirective` may only be used for AdvanceDirective references in addition to first reference in `.source[x]`. : extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective').empty() or source.exists() | |
| zib-TreatmentDirective2-2 | error | Consent | If the specificationOther extension is used, `.provision.type` MUST be absent and vice versa : (extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificitionOther').exists() and provision.type.exists()).not() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent | C | 0..* | ZibTreatmentDirective2 | TreatmentDirective | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | Comment | |||||
| additionalAdvanceDirective | C | 0..* | Reference(zib AdvanceDirective) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |||||
| value[x] | C | 0..1 | Reference(nl core AdvanceDirective) | AdvanceDirective | ||||
| Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:specificationOther | ?!C | 0..1 | ExtTreatmentDirective2SpecificationOther | Extension | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther" | |||||
| value[x] | C | 0..1 | string | SpecificationOther | ||||
| identifier | Σ | 0..* | 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. | ||||
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: treatment | |||||
| 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 | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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: 129125009 | |||||
| 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 | Σ | 0..1 | Reference(Patient | nl core Patient) | Who the consent applies to | ||||
| dateTime | Σ | 0..1 | dateTime | MostRecentReviewDate | ||||
| performer | Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
| organization | Σ | 0..* | Reference(Organization) | Custodian of the consent | ||||
| Slices for source[x] | ΣC | 0..1 | Source from which this consent is taken Slice: Unordered, Closed by type:$this | |||||
| sourceAttachment | Attachment | |||||||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| source[x]:sourceReference | ΣC | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse | nl core AdvanceDirective) | AdvanceDirective | ||||
| policy | 0..* | BackboneElement | Policies covered by this consent | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority | C | 0..1 | uri | Enforcement source for policy | ||||
| uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| verified | Σ | 1..1 | boolean | Has been verified | ||||
| verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate | 0..1 | dateTime | When consent verified | |||||
| provision | Σ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| reasonForEnding | 0..1 | string | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.ReasonForEnding | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | ΣC | 0..1 | code | TreatmentDecision Binding: ConsentProvisionType (required): Use ConceptMap TreatmentDecisionCodelist-to-ConsentProvisionType to translate terminology from the functional model to profile terminology in ValueSet ConsentProvisionType. | ||||
| period | Σ | 0..1 | Period | Timeframe for this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | DateExpired | ||||
| Slices for actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Open by value:role | |||||
| actor:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| actor:agreementParty | 0..* | BackboneElement | AgreementParty | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CONSENTER | |||||
| 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 | |||||
| reference | 1..1 | PatternNlCoreHealthProfessionalReference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole | nl core Patient | nl core ContactPerson | nl core HealthProfessional PractitionerRole) | Patient / Representative / HealthProfessional | |||||
| action | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose | Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code | Σ | 0..1 | CodeableConcept | Treatment Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.2.2.1--20200901000000 (required) | ||||
| dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| data | Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Consent.language | preferred | CommonLanguages
| ||||
| Consent.status | required | ConsentState | ||||
| Consent.scope | extensible | Pattern: treatment | ||||
| Consent.category | extensible | Pattern: SNOMED CT code 129125009 | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodes | ||||
| Consent.provision.type | required | ConsentProvisionType | ||||
| Consent.provision.actor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:agreementParty.role | extensible | Pattern: CONSENTER | ||||
| Consent.provision.action | example | ConsentActionCodes | ||||
| Consent.provision.securityLabel | extensible | All Security Labels | ||||
| Consent.provision.purpose | extensible | PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClass | ||||
| Consent.provision.code | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.2.2.1--20200901000000 | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaning |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| zib-TreatmentDirective2-1 | error | Consent | `extension.additionalAdvanceDirective` may only be used for AdvanceDirective references in addition to first reference in `.source[x]`. : extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective').empty() or source.exists() | |
| zib-TreatmentDirective2-2 | error | Consent | If the specificationOther extension is used, `.provision.type` MUST be absent and vice versa : (extension.where(url = 'http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificitionOther').exists() and provision.type.exists()).not() |
This structure is derived from ZibTreatmentDirective2
Summary
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron