Advance Care Planning (PZP)
0.1.3-beta3 - consultation
Advance Care Planning (PZP)
0.1.3-beta3 - consultation
Advance Care Planning (PZP) - Local Development build (v0.1.3-beta3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.iknl.nl/fhir/StructureDefinition/ACP-TreatmentDirective | Version: 0.1.3-beta3 | |||
| Draft as of 2025-08-28 | Computable Name: ACPTreatmentDirective | |||
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 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. Based on nl-core-TreatmentDirective2 and HCIM TreatmentDirective2.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter:   |
|---|---|---|---|---|
  Consent |
C | 0..* | NlcoreTreatmentDirective2 | TreatmentDirective Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, zib-TreatmentDirective2-1, zib-TreatmentDirective2-2 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices voor extension |
Content/regels voor alle slices | |||
   extension:comment |
0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1 | |
  url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
 value[x] |
0..1 | string | Comment | |
| extension:additionalAdvanceDirective |
C | 0..* | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective Constraints: ext-1 |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |
 value[x] |
C | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective |
 extension:encounter |
0..1 | (Complex) | ext Encounter Reference Url: https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference Constraints: ext-1 | |
 extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference" | |
| value[x] |
0..1 | Reference(Encounter(0.1.3-beta3)) | Encounter | |
 Slices voor modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Zonder volgorde, Open op value:url Constraints: ext-1 |
| modifierExtension:specificationOther |
?!C | 0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther Constraints: ext-1 |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther" | |
| value[x] |
C | 0..1 | string | 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. Verplicht patroon: Tenminste de volgende |
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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 | |
| Slices voor category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Zonder volgorde, Open op value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
| category:treatmentDirectiveCode |
Σ | 1..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. Verplicht patroon: Tenminste de volgende |
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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(0.1.3-beta3)) | Who the consent applies to |
| dateTime |
Σ | 0..1 | dateTime | MostRecentReviewDate |
 Slices voor source[x] |
ΣC | 0..1 | Source from which this consent is taken Slice: Zonder volgorde, Gesloten op type:$this | |
 sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
 source[x]:sourceReference |
ΣC | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective |
| Documentatie voor dit formaat | ||||
| Pad | Conformance | ValueSet / code | Uri |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | |
| Consent.scope | extensible | Pattern Value: treatmenthttp://hl7.org/fhir/ValueSet/consent-scope|4.0.1From the FHIR Standard | |
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard | |
| Consent.category:treatmentDirectiveCode | extensible | Pattern Value: SNOMED CT code 129125009http://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard |
| Id | Grade | Pad(en) | 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 | Consent.implicitRules, Consent.extension:comment, Consent.extension:comment.value[x], Consent.extension:additionalAdvanceDirective, Consent.extension:additionalAdvanceDirective.value[x], Consent.extension:encounter, Consent.extension:encounter.value[x], Consent.modifierExtension, Consent.modifierExtension:specificationOther, Consent.modifierExtension:specificationOther.value[x], Consent.status, Consent.scope, Consent.category, Consent.category:treatmentDirectiveCode, Consent.patient, Consent.dateTime, Consent.source[x], Consent.source[x]:sourceReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Consent.extension:comment, Consent.extension:additionalAdvanceDirective, Consent.extension:encounter, Consent.modifierExtension, Consent.modifierExtension:specificationOther | 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 NlcoreTreatmentDirective2
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | NlcoreTreatmentDirective2 | TreatmentDirective | |
| Slices voor extension |
Content/regels voor alle slices | |||
| extension:comment |
0..1 | ExtComment | Optional Extensions Element | |
 value[x] |
0..1 | string | Comment | |
| extension:additionalAdvanceDirective |
0..* | ExtTreatmentDirective2AdvanceDirective | Optional Extensions Element | |
| extension |
0..0 | |||
| value[x] |
0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective | |
| extension:encounter |
0..1 | (Complex) | ext Encounter Reference Url: https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference | |
| value[x] |
0..1 | Reference(Encounter(0.1.3-beta3)) | Encounter | |
| Slices voor modifierExtension |
Content/regels voor alle slices | |||
| modifierExtension:specificationOther |
0..1 | ExtTreatmentDirective2SpecificationOther | Optional Extensions Element | |
| value[x] |
0..1 | string | SpecificationOther | |
| patient |
0..1 | Reference(Patient(0.1.3-beta3)) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | MostRecentReviewDate | |
| Slices voor source[x] |
Content/regels voor alle slices | |||
| source[x]:sourceReference |
0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective | |
| provision |
||||
| Slices voor extension |
Content/regels voor alle slices | |||
| extension:reasonForEnding |
0..1 | ExtTreatmentDirective2ReasonForEnding | Optional Extensions Element | |
| value[x] |
0..1 | string | ReasonForEnding | |
| type |
0..1 | code | TreatmentDecision | |
| period |
||||
| end |
0..1 | dateTime | DateExpired | |
| Slices voor actor |
Content/regels voor alle slices | |||
| actor:agreementParty |
0..* | BackboneElement | AgreementParty | |
| reference |
1..1 | Reference(Patient(0.1.3-beta3) | HealthProfessional PractitionerRole(0.1.3-beta3) | ContactPerson(0.1.3-beta3)) | Patient / Representative / HealthProfessional | |
| code |
0..1 | CodeableConcept | Treatment | |
| text |
0..1 | string | Plain text representation of the concept | |
| Documentatie voor dit formaat | ||||
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | NlcoreTreatmentDirective2 | TreatmentDirective Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, zib-TreatmentDirective2-1, zib-TreatmentDirective2-2 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices voor extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| extension:comment |
0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] |
0..1 | string | Comment | |||||
| extension:additionalAdvanceDirective |
C | 0..* | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective Constraints: ext-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |||||
| value[x] |
C | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective | ||||
| extension:encounter |
0..1 | (Complex) | ext Encounter Reference Url: https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference" | |||||
| value[x] |
0..1 | Reference(Encounter(0.1.3-beta3)) | Encounter | |||||
| Slices voor modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | ||||
| modifierExtension:specificationOther |
?!C | 0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther Constraints: ext-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| 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) Voorbeeld 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. Verplicht patroon: Tenminste de volgende | ||||
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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 | |||||
| Slices voor category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Zonder volgorde, Open op value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
| category:treatmentDirectiveCode |
Σ | 1..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. Verplicht patroon: Tenminste de volgende | ||||
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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(0.1.3-beta3)) | 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 voor source[x] |
ΣC | 0..1 | Source from which this consent is taken Slice: Zonder volgorde, Gesloten op type:$this | |||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| source[x]:sourceReference |
ΣC | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 voor extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| extension:reasonForEnding |
0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.ReasonForEnding Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.ReasonForEnding" | |||||
| value[x] |
0..1 | string | ReasonForEnding | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | DateExpired | ||||
| Slices voor actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Zonder volgorde, Open op value:role | |||||
| actor:Alle slices |
Content/regels voor alle slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Verplicht patroon: Tenminste de volgende | |||||
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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 | Reference(Patient(0.1.3-beta3) | HealthProfessional PractitionerRole(0.1.3-beta3) | ContactPerson(0.1.3-beta3)) | 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 (3.1.0) (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: BehandelingCodelijst (2020-09-01T00:00:00) (required): If this code is found in an instance, then the exception applies. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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..* | Zie provision (Consent) | Nested Exception Rules | |||||
| Documentatie voor dit formaat | ||||||||
| Pad | Conformance | ValueSet / code | Uri | |||
| Consent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | ||||
| Consent.scope | extensible | Pattern Value: treatmenthttp://hl7.org/fhir/ValueSet/consent-scope|4.0.1From the FHIR Standard | ||||
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard | ||||
| Consent.category:treatmentDirectiveCode | extensible | Pattern Value: SNOMED CT code 129125009http://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy|4.0.1From the FHIR Standard | ||||
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.actor:agreementParty.role | extensible | Pattern Value: CONSENTERhttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-action|4.0.1From the FHIR Standard | ||||
| Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1From the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 | ||||
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class|4.0.1From the FHIR Standard | ||||
| Consent.provision.code | required | BehandelingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.2.2.1--20200901000000|2020-09-01T00:00:00 | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1From the FHIR Standard |
| Id | Grade | Pad(en) | 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 | Consent.meta, Consent.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:comment, Consent.extension:comment.extension, Consent.extension:comment.value[x], Consent.extension:additionalAdvanceDirective, Consent.extension:additionalAdvanceDirective.value[x], Consent.extension:encounter, Consent.extension:encounter.value[x], Consent.modifierExtension, Consent.modifierExtension:specificationOther, Consent.modifierExtension:specificationOther.extension, Consent.modifierExtension:specificationOther.value[x], Consent.identifier, Consent.status, Consent.scope, Consent.category, Consent.category:treatmentDirectiveCode, Consent.patient, Consent.dateTime, Consent.performer, Consent.organization, Consent.source[x], Consent.source[x]:sourceReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, Consent.verification, Consent.verification.extension, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.extension:reasonForEnding, Consent.provision.extension:reasonForEnding.extension, Consent.provision.extension:reasonForEnding.value[x], Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.period.extension, Consent.provision.period.start, Consent.provision.period.end, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.actor:agreementParty, Consent.provision.actor:agreementParty.extension, Consent.provision.actor:agreementParty.modifierExtension, Consent.provision.actor:agreementParty.role, Consent.provision.actor:agreementParty.reference, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.code.extension, Consent.provision.code.coding, Consent.provision.code.text, Consent.provision.dataPeriod, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.provision | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Consent.extension, Consent.extension:comment, Consent.extension:comment.extension, Consent.extension:additionalAdvanceDirective, Consent.extension:encounter, Consent.modifierExtension, Consent.modifierExtension:specificationOther, Consent.modifierExtension:specificationOther.extension, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.extension:reasonForEnding, Consent.provision.extension:reasonForEnding.extension, Consent.provision.modifierExtension, Consent.provision.period.extension, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor:agreementParty.extension, Consent.provision.actor:agreementParty.modifierExtension, Consent.provision.code.extension, Consent.provision.data.extension, Consent.provision.data.modifierExtension | 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 NlcoreTreatmentDirective2
Samenvatting
Verboden: 1 element
Structuren
Deze structuur verwijst naar deze andere structuren:
Extensies
Deze structuur verwijst naar deze extensies:
Key Elements View
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: |
|---|---|---|---|---|
| Consent |
C | 0..* | NlcoreTreatmentDirective2 | TreatmentDirective Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, zib-TreatmentDirective2-1, zib-TreatmentDirective2-2 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices voor extension |
Content/regels voor alle slices | |||
| extension:comment |
0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1 | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] |
0..1 | string | Comment | |
| extension:additionalAdvanceDirective |
C | 0..* | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective Constraints: ext-1 |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |
| value[x] |
C | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective |
| extension:encounter |
0..1 | (Complex) | ext Encounter Reference Url: https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference Constraints: ext-1 | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference" | |
| value[x] |
0..1 | Reference(Encounter(0.1.3-beta3)) | Encounter | |
| Slices voor modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Zonder volgorde, Open op value:url Constraints: ext-1 |
| modifierExtension:specificationOther |
?!C | 0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther Constraints: ext-1 |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther" | |
| value[x] |
C | 0..1 | string | 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. Verplicht patroon: Tenminste de volgende |
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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 | |
| Slices voor category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Zonder volgorde, Open op value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
| category:treatmentDirectiveCode |
Σ | 1..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. Verplicht patroon: Tenminste de volgende |
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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(0.1.3-beta3)) | Who the consent applies to |
| dateTime |
Σ | 0..1 | dateTime | MostRecentReviewDate |
| Slices voor source[x] |
ΣC | 0..1 | Source from which this consent is taken Slice: Zonder volgorde, Gesloten op type:$this | |
| sourceAttachment |
Attachment | |||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||
| source[x]:sourceReference |
ΣC | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective |
| Documentatie voor dit formaat | ||||
| Pad | Conformance | ValueSet / code | Uri |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | |
| Consent.scope | extensible | Pattern Value: treatmenthttp://hl7.org/fhir/ValueSet/consent-scope|4.0.1From the FHIR Standard | |
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard | |
| Consent.category:treatmentDirectiveCode | extensible | Pattern Value: SNOMED CT code 129125009http://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard |
| Id | Grade | Pad(en) | 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 | Consent.implicitRules, Consent.extension:comment, Consent.extension:comment.value[x], Consent.extension:additionalAdvanceDirective, Consent.extension:additionalAdvanceDirective.value[x], Consent.extension:encounter, Consent.extension:encounter.value[x], Consent.modifierExtension, Consent.modifierExtension:specificationOther, Consent.modifierExtension:specificationOther.value[x], Consent.status, Consent.scope, Consent.category, Consent.category:treatmentDirectiveCode, Consent.patient, Consent.dateTime, Consent.source[x], Consent.source[x]:sourceReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Consent.extension:comment, Consent.extension:additionalAdvanceDirective, Consent.extension:encounter, Consent.modifierExtension, Consent.modifierExtension:specificationOther | 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() |
Differential View
This structure is derived from NlcoreTreatmentDirective2
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: |
|---|---|---|---|---|
| Consent |
0..* | NlcoreTreatmentDirective2 | TreatmentDirective | |
| Slices voor extension |
Content/regels voor alle slices | |||
| extension:comment |
0..1 | ExtComment | Optional Extensions Element | |
| value[x] |
0..1 | string | Comment | |
| extension:additionalAdvanceDirective |
0..* | ExtTreatmentDirective2AdvanceDirective | Optional Extensions Element | |
| extension |
0..0 | |||
| value[x] |
0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective | |
| extension:encounter |
0..1 | (Complex) | ext Encounter Reference Url: https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference | |
| value[x] |
0..1 | Reference(Encounter(0.1.3-beta3)) | Encounter | |
| Slices voor modifierExtension |
Content/regels voor alle slices | |||
| modifierExtension:specificationOther |
0..1 | ExtTreatmentDirective2SpecificationOther | Optional Extensions Element | |
| value[x] |
0..1 | string | SpecificationOther | |
| patient |
0..1 | Reference(Patient(0.1.3-beta3)) | Who the consent applies to | |
| dateTime |
0..1 | dateTime | MostRecentReviewDate | |
| Slices voor source[x] |
Content/regels voor alle slices | |||
| source[x]:sourceReference |
0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective | |
| provision |
||||
| Slices voor extension |
Content/regels voor alle slices | |||
| extension:reasonForEnding |
0..1 | ExtTreatmentDirective2ReasonForEnding | Optional Extensions Element | |
| value[x] |
0..1 | string | ReasonForEnding | |
| type |
0..1 | code | TreatmentDecision | |
| period |
||||
| end |
0..1 | dateTime | DateExpired | |
| Slices voor actor |
Content/regels voor alle slices | |||
| actor:agreementParty |
0..* | BackboneElement | AgreementParty | |
| reference |
1..1 | Reference(Patient(0.1.3-beta3) | HealthProfessional PractitionerRole(0.1.3-beta3) | ContactPerson(0.1.3-beta3)) | Patient / Representative / HealthProfessional | |
| code |
0..1 | CodeableConcept | Treatment | |
| text |
0..1 | string | Plain text representation of the concept | |
| Documentatie voor dit formaat | ||||
Snapshot View
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Consent |
C | 0..* | NlcoreTreatmentDirective2 | TreatmentDirective Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, zib-TreatmentDirective2-1, zib-TreatmentDirective2-2 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices voor extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| extension:comment |
0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] |
0..1 | string | Comment | |||||
| extension:additionalAdvanceDirective |
C | 0..* | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective Constraints: ext-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.AdvanceDirective" | |||||
| value[x] |
C | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | AdvanceDirective | ||||
| extension:encounter |
0..1 | (Complex) | ext Encounter Reference Url: https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "https://fhir.iknl.nl/fhir/StructureDefinition/ext-EncounterReference" | |||||
| value[x] |
0..1 | Reference(Encounter(0.1.3-beta3)) | Encounter | |||||
| Slices voor modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | ||||
| modifierExtension:specificationOther |
?!C | 0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.SpecificationOther Constraints: ext-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| 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) Voorbeeld 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. Verplicht patroon: Tenminste de volgende | ||||
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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 | |||||
| Slices voor category |
Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Zonder volgorde, Open op value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
| category:treatmentDirectiveCode |
Σ | 1..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. Verplicht patroon: Tenminste de volgende | ||||
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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(0.1.3-beta3)) | 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 voor source[x] |
ΣC | 0..1 | Source from which this consent is taken Slice: Zonder volgorde, Gesloten op type:$this | |||||
| sourceAttachment |
Attachment | |||||||
| sourceReference |
Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| source[x]:sourceReference |
ΣC | 0..1 | Reference(AdvanceDirective(0.1.3-beta3)) | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 voor extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| extension:reasonForEnding |
0..1 | (Complex) | Optional Extensions Element Url: http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.ReasonForEnding Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TreatmentDirective2.ReasonForEnding" | |||||
| value[x] |
0..1 | string | ReasonForEnding | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | DateExpired | ||||
| Slices voor actor |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Zonder volgorde, Open op value:role | |||||
| actor:Alle slices |
Content/regels voor alle slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| role |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Verplicht patroon: Tenminste de volgende | |||||
| 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 Vaste waarde: (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 Vaste waarde: 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 Vaste waarde: 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 | Reference(Patient(0.1.3-beta3) | HealthProfessional PractitionerRole(0.1.3-beta3) | ContactPerson(0.1.3-beta3)) | 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 (3.1.0) (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: BehandelingCodelijst (2020-09-01T00:00:00) (required): If this code is found in an instance, then the exception applies. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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..* | Zie provision (Consent) | Nested Exception Rules | |||||
| Documentatie voor dit formaat | ||||||||
| Pad | Conformance | ValueSet / code | Uri | |||
| Consent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | ||||
| Consent.scope | extensible | Pattern Value: treatmenthttp://hl7.org/fhir/ValueSet/consent-scope|4.0.1From the FHIR Standard | ||||
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard | ||||
| Consent.category:treatmentDirectiveCode | extensible | Pattern Value: SNOMED CT code 129125009http://hl7.org/fhir/ValueSet/consent-category|4.0.1From the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy|4.0.1From the FHIR Standard | ||||
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.actor:agreementParty.role | extensible | Pattern Value: CONSENTERhttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-action|4.0.1From the FHIR Standard | ||||
| Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1From the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 | ||||
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class|4.0.1From the FHIR Standard | ||||
| Consent.provision.code | required | BehandelingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.2.2.1--20200901000000|2020-09-01T00:00:00 | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1From the FHIR Standard |
| Id | Grade | Pad(en) | 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 | Consent.meta, Consent.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:comment, Consent.extension:comment.extension, Consent.extension:comment.value[x], Consent.extension:additionalAdvanceDirective, Consent.extension:additionalAdvanceDirective.value[x], Consent.extension:encounter, Consent.extension:encounter.value[x], Consent.modifierExtension, Consent.modifierExtension:specificationOther, Consent.modifierExtension:specificationOther.extension, Consent.modifierExtension:specificationOther.value[x], Consent.identifier, Consent.status, Consent.scope, Consent.category, Consent.category:treatmentDirectiveCode, Consent.patient, Consent.dateTime, Consent.performer, Consent.organization, Consent.source[x], Consent.source[x]:sourceReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, Consent.verification, Consent.verification.extension, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.extension:reasonForEnding, Consent.provision.extension:reasonForEnding.extension, Consent.provision.extension:reasonForEnding.value[x], Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.period.extension, Consent.provision.period.start, Consent.provision.period.end, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.actor:agreementParty, Consent.provision.actor:agreementParty.extension, Consent.provision.actor:agreementParty.modifierExtension, Consent.provision.actor:agreementParty.role, Consent.provision.actor:agreementParty.reference, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.code.extension, Consent.provision.code.coding, Consent.provision.code.text, Consent.provision.dataPeriod, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.provision | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Consent.extension, Consent.extension:comment, Consent.extension:comment.extension, Consent.extension:additionalAdvanceDirective, Consent.extension:encounter, Consent.modifierExtension, Consent.modifierExtension:specificationOther, Consent.modifierExtension:specificationOther.extension, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.extension:reasonForEnding, Consent.provision.extension:reasonForEnding.extension, Consent.provision.modifierExtension, Consent.provision.period.extension, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor:agreementParty.extension, Consent.provision.actor:agreementParty.modifierExtension, Consent.provision.code.extension, Consent.provision.data.extension, Consent.provision.data.modifierExtension | 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 NlcoreTreatmentDirective2
Samenvatting
Verboden: 1 element
Structuren
Deze structuur verwijst naar deze andere structuren:
Extensies
Deze structuur verwijst naar deze extensies:
Other representations of profile: CSV, Excel, Schematron