{
"description": "De registatie (Consent) dat de patient de RIVO-Noord policy voor toestemming van gegevensuitwisseling heeft geaccepteerd",
"_filename": "StructureDefinition-ToestemmingConsent.json",
"package_name": "hl7.fhir.nl.zorgviewer",
"date": "2024-05-13T07:45:32+00:00",
"derivation": "constraint",
"publisher": "RIVO-NN HL7NL",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "NL",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "ToestemmingConsent",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Consent",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "ToestemmingConsent",
"package_version": "0.25.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
}, {
"key": "ppc-1",
"human": "Either a Policy or PolicyRule",
"xpath": "exists(f:policy) or exists(f:policyRule)",
"source": "http://hl7.org/fhir/StructureDefinition/Consent",
"severity": "error",
"expression": "policy.exists() or policyRule.exists()"
} ],
"path": "Consent",
"min": 0,
"definition": "A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.",
"short": "A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "FinancialConsent",
"identity": "rim"
}, {
"map": "infrastructure.information",
"identity": "w5"
} ],
"max": "*",
"id": "Consent",
"comment": "Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.",
"base": {
"max": "*",
"min": 0,
"path": "Consent"
}
}, {
"path": "Consent.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Consent.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Consent.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Consent.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Consent.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Consent.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Consent.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Consent.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Consent.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Consent.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Consent.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Consent.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Consent.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Consent.identifier",
"min": 0,
"definition": "Unique identifier for this copy of the Consent Statement.",
"short": "Identifier for this record (external references)",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Consent.identifier",
"comment": "This identifier is identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.",
"example": [ {
"label": "General",
"valueIdentifier": {
"value": "Local eCMS identifier",
"system": "urn:ietf:rfc:3986"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Consent.identifier"
},
"isSummary": true
}, {
"path": "Consent.status",
"requirements": "The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.",
"min": 1,
"definition": "Indicates the current state of this consent.",
"isModifier": true,
"short": "draft | proposed | active | rejected | inactive | entered-in-error",
"mapping": [ {
"map": "HL7 Table 0498 - Consent Status",
"identity": "v2"
}, {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentState"
} ],
"description": "Indicates the state of the consent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-state-codes"
}
},
"max": "1",
"id": "Consent.status",
"comment": "This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "Consent.status"
},
"isSummary": true
}, {
"path": "Consent.category",
"min": 0,
"definition": "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.",
"short": "Classification of the consent statement - for indexing/retrieval",
"mapping": [ {
"map": "CNTRCT",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentCategory"
} ],
"description": "A classification of the type of consents found in a consent statement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-category"
}
},
"max": "*",
"id": "Consent.category",
"base": {
"max": "*",
"min": 0,
"path": "Consent.category"
},
"isSummary": true
}, {
"path": "Consent.category.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.category.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.category.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.category.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.category.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Consent.category.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Consent.category.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.category.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.category.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.category.coding.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.category.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.category.coding.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Consent.category.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Consent.category.coding.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Consent.category.coding.code",
"fixedCode": "Doss. delen?",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"max": "1",
"id": "Consent.category.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Consent.category.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Consent.category.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Consent.category.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Consent.category.coding.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Consent.category.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Consent.category.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Consent.patient",
"min": 1,
"definition": "The patient/healthcare consumer to whom this consent applies.",
"short": "Who the consent applies to",
"mapping": [ {
"map": "Role",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.nl/fhir/zorgviewer/StructureDefinition/Patient"
} ],
"mustSupport": true,
"max": "1",
"id": "Consent.patient",
"comment": "Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.",
"base": {
"max": "1",
"min": 1,
"path": "Consent.patient"
},
"isSummary": true
}, {
"path": "Consent.period",
"min": 0,
"definition": "Relevant time or time-period when this Consent is applicable.",
"short": "Period that this consent applies",
"mapping": [ {
"map": "FinancialConsent activityTime",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": true,
"meaningWhenMissing": "all date ranges included",
"max": "1",
"id": "Consent.period",
"comment": "This can be a subset of the period of the original statement.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.period"
},
"isSummary": true
}, {
"path": "Consent.dateTime",
"min": 0,
"definition": "When this Consent was issued / created / indexed.",
"short": "When this Consent was created or indexed",
"mapping": [ {
"map": "FinancialConsent effectiveTime",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Consent.dateTime",
"comment": "This is not the time of the original consent, but the time that this statement was made or derived.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.dateTime"
},
"isSummary": true
}, {
"path": "Consent.consentingParty",
"min": 0,
"definition": "Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.",
"short": "Who is agreeing to the policy and exceptions",
"mapping": [ {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"alias": [ "consentor" ],
"max": "*",
"id": "Consent.consentingParty",
"comment": "Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.consentingParty"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.actor",
"min": 0,
"definition": "Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').",
"short": "Who|what controlled by this consent (or group, by role)",
"mapping": [ {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "There is no specific actor associated with the consent",
"max": "*",
"id": "Consent.actor",
"base": {
"max": "*",
"min": 0,
"path": "Consent.actor"
},
"isSummary": true
}, {
"path": "Consent.actor.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.actor.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.actor.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.actor.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.actor.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.actor.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.actor.role",
"min": 1,
"definition": "How the individual is involved in the resources content that is described in the consent.",
"short": "How the actor is involved",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentActorRole"
} ],
"description": "How an actor is involved in the consent considerations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
"max": "1",
"id": "Consent.actor.role",
"base": {
"max": "1",
"min": 1,
"path": "Consent.actor.role"
}
}, {
"id": "Consent.actor.reference",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Consent.actor.reference"
},
"path": "Consent.actor.reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"short": "Resource for the actor (or group, by role)",
"definition": "The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers')."
}, {
"path": "Consent.action",
"min": 0,
"definition": "Actions controlled by this consent.",
"short": "Actions controlled by this consent",
"type": [ {
"code": "CodeableConcept"
} ],
"meaningWhenMissing": "all actions",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentAction"
} ],
"description": "Detailed codes for the consent action.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
},
"max": "*",
"id": "Consent.action",
"comment": "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.action"
},
"isSummary": true
}, {
"path": "Consent.organization",
"min": 0,
"definition": "The organization that manages the consent, and the framework within which it is executed.",
"short": "Custodian of the consent",
"mapping": [ {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.nl/fhir/zorgviewer/StructureDefinition/Organization"
} ],
"mustSupport": true,
"alias": [ "custodian" ],
"max": "*",
"id": "Consent.organization",
"base": {
"max": "*",
"min": 0,
"path": "Consent.organization"
},
"isSummary": true
}, {
"path": "Consent.source[x]",
"min": 0,
"definition": "The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.",
"short": "Source from which this consent is taken",
"type": [ {
"code": "Attachment"
}, {
"code": "Identifier"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Consent"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Contract"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
} ],
"max": "1",
"id": "Consent.source[x]",
"comment": "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.source[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.policy",
"min": 0,
"definition": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.",
"short": "Policies covered by this consent",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "Consent.policy",
"base": {
"max": "*",
"min": 0,
"path": "Consent.policy"
}
}, {
"path": "Consent.policy.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.policy.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.policy.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.policy.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.policy.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.policy.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.policy.authority",
"min": 0,
"definition": "Entity or Organization having regulatory jurisdiction or accountability for  enforcing policies pertaining to Consent Directives.",
"short": "Enforcement source for policy",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.policy.authority",
"condition": [ "ppc-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Consent.policy.authority"
}
}, {
"path": "Consent.policy.uri",
"min": 0,
"definition": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.",
"short": "Specific policy covered by this consent",
"fixedUri": "https://rivo-noord.nl/zorgviewer/toestemming",
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Consent.policy.uri",
"condition": [ "ppc-1" ],
"comment": "This element is for discoverability / documentation, and does not modify or qualify the policy rules.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.policy.uri"
}
}, {
"path": "Consent.policyRule",
"requirements": "Might be a unique identifier of a policy set in XACML, or other rules engine.",
"min": 0,
"definition": "A referece to the specific computable policy.",
"short": "Policy that this consents to",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.policyRule",
"condition": [ "ppc-1" ],
"comment": "If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in the consent resource.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.policyRule"
},
"isSummary": true
}, {
"path": "Consent.securityLabel",
"min": 0,
"definition": "A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.",
"short": "Security Labels that define affected resources",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "Consent.securityLabel",
"comment": "If the consent specifies a security label of \"R\" then it applies to all resources that are labeled \"R\" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.securityLabel"
},
"isSummary": true
}, {
"path": "Consent.purpose",
"min": 0,
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.",
"short": "Context of activities for which the agreement is made",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PurposeOfUse"
} ],
"description": "What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"max": "*",
"id": "Consent.purpose",
"comment": "This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.purpose"
},
"isSummary": true
}, {
"path": "Consent.dataPeriod",
"min": 0,
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this consent.",
"short": "Timeframe for data controlled by this consent",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Consent.dataPeriod",
"comment": "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.dataPeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.data",
"min": 0,
"definition": "The resources controlled by this consent, if specific resources are referenced.",
"short": "Data controlled by this consent",
"mapping": [ {
"map": "Role",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "all data",
"max": "*",
"id": "Consent.data",
"base": {
"max": "*",
"min": 0,
"path": "Consent.data"
},
"isSummary": true
}, {
"path": "Consent.data.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.data.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.data.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.data.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.data.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.data.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.data.meaning",
"min": 1,
"definition": "How the resource reference is interpreted when testing consent restrictions.",
"short": "instance | related | dependents | authoredby",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentDataMeaning"
} ],
"description": "How a resource reference is interpreted when testing consent restrictions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
},
"max": "1",
"id": "Consent.data.meaning",
"base": {
"max": "1",
"min": 1,
"path": "Consent.data.meaning"
},
"isSummary": true
}, {
"path": "Consent.data.reference",
"min": 1,
"definition": "A reference to a specific resource that defines which resources are covered by this consent.",
"short": "The actual data reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "Consent.data.reference",
"base": {
"max": "1",
"min": 1,
"path": "Consent.data.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.except",
"min": 0,
"definition": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"short": "Additional rule - addition or removal of permissions",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Consent.except",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except"
},
"isSummary": true
}, {
"path": "Consent.except.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.except.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.except.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.except.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.except.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.except.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.except.type",
"min": 1,
"definition": "Action to take - permit or deny - when the exception conditions are met.",
"short": "deny | permit",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentExceptType"
} ],
"description": "How an exception statement is applied, such as adding additional consent or removing consent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-except-type"
}
},
"max": "1",
"id": "Consent.except.type",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.type"
},
"isSummary": true
}, {
"path": "Consent.except.period",
"min": 0,
"definition": "The timeframe in this exception is valid.",
"short": "Timeframe for this exception",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Consent.except.period",
"base": {
"max": "1",
"min": 0,
"path": "Consent.except.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.except.actor",
"min": 0,
"definition": "Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').",
"short": "Who|what controlled by this exception (or group, by role)",
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "There is no specific actor associated with the exception",
"max": "*",
"id": "Consent.except.actor",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.actor"
},
"isSummary": true
}, {
"path": "Consent.except.actor.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.except.actor.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.except.actor.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.except.actor.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.except.actor.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.except.actor.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.except.actor.role",
"min": 1,
"definition": "How the individual is involved in the resources content that is described in the exception.",
"short": "How the actor is involved",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentActorRole"
} ],
"description": "How an actor is involved in the consent considerations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
"max": "1",
"id": "Consent.except.actor.role",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.actor.role"
}
}, {
"id": "Consent.except.actor.reference",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.actor.reference"
},
"path": "Consent.except.actor.reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"short": "Resource for the actor (or group, by role)",
"definition": "The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers')."
}, {
"path": "Consent.except.action",
"min": 0,
"definition": "Actions controlled by this Exception.",
"short": "Actions controlled by this exception",
"type": [ {
"code": "CodeableConcept"
} ],
"meaningWhenMissing": "all actions",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentAction"
} ],
"description": "Detailed codes for the consent action.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
},
"max": "*",
"id": "Consent.except.action",
"comment": "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.action"
},
"isSummary": true
}, {
"path": "Consent.except.securityLabel",
"min": 0,
"definition": "A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.",
"short": "Security Labels that define affected resources",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "Consent.except.securityLabel",
"comment": "If the consent specifies a security label of \"R\" then it applies to all resources that are labeled \"R\" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.securityLabel"
},
"isSummary": true
}, {
"path": "Consent.except.purpose",
"min": 0,
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.",
"short": "Context of activities covered by this exception",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PurposeOfUse"
} ],
"description": "What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"max": "*",
"id": "Consent.except.purpose",
"comment": "E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.purpose"
},
"isSummary": true
}, {
"path": "Consent.except.class",
"min": 0,
"definition": "The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.",
"short": "e.g. Resource Type, Profile, or CDA etc",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentClass"
} ],
"description": "The class (type) of information a consent rule covers",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-class"
}
},
"max": "*",
"id": "Consent.except.class",
"comment": "Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.class"
},
"isSummary": true
}, {
"path": "Consent.except.code",
"min": 0,
"definition": "If this code is found in an instance, then the exception applies.",
"short": "e.g. LOINC or SNOMED CT code, etc in the content",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentCode"
} ],
"description": "If this code is found in an instance, then the exception applies",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-code"
}
},
"max": "*",
"id": "Consent.except.code",
"comment": "Typical use of this is a Document code with class = CDA.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.code"
},
"isSummary": true
}, {
"path": "Consent.except.dataPeriod",
"min": 0,
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this exception.",
"short": "Timeframe for data controlled by this exception",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Consent.except.dataPeriod",
"comment": "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.except.dataPeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.except.data",
"min": 0,
"definition": "The resources controlled by this exception, if specific resources are referenced.",
"short": "Data controlled by this exception",
"mapping": [ {
"map": "Role",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "all data",
"max": "*",
"id": "Consent.except.data",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.data"
},
"isSummary": true
}, {
"path": "Consent.except.data.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.except.data.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.except.data.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.except.data.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.except.data.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.except.data.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.except.data.meaning",
"min": 1,
"definition": "How the resource reference is interpreted when testing consent restrictions.",
"short": "instance | related | dependents | authoredby",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentDataMeaning"
} ],
"description": "How a resource reference is interpreted when testing consent restrictions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
},
"max": "1",
"id": "Consent.except.data.meaning",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.data.meaning"
},
"isSummary": true
}, {
"path": "Consent.except.data.reference",
"min": 1,
"definition": "A reference to a specific resource that defines which resources are covered by this consent.",
"short": "The actual data reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "Consent.except.data.reference",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.data.reference"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "da7c761a-779f-4544-9d9d-eff066176313",
"kind": "resource",
"url": "http://hl7.nl/fhir/zorgviewer/StructureDefinition/ToestemmingConsent",
"version": "0.25.0",
"differential": {
"element": [ {
"id": "Consent",
"path": "Consent"
}, {
"id": "Consent.status",
"path": "Consent.status",
"mustSupport": true
}, {
"id": "Consent.category.coding.code",
"path": "Consent.category.coding.code",
"fixedCode": "Doss. delen?",
"mustSupport": true
}, {
"id": "Consent.patient",
"path": "Consent.patient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.nl/fhir/zorgviewer/StructureDefinition/Patient"
} ],
"mustSupport": true
}, {
"id": "Consent.period",
"path": "Consent.period",
"mustSupport": true
}, {
"id": "Consent.organization",
"path": "Consent.organization",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.nl/fhir/zorgviewer/StructureDefinition/Organization"
} ],
"mustSupport": true
}, {
"id": "Consent.policy",
"path": "Consent.policy",
"mustSupport": true
}, {
"id": "Consent.policy.uri",
"path": "Consent.policy.uri",
"fixedUri": "https://rivo-noord.nl/zorgviewer/toestemming",
"mustSupport": true
} ]
},
"contact": [ {
"name": "RIVO-NN",
"telecom": [ {
"value": "https://rivo-noord.nl",
"system": "url"
} ]
}, {
"name": "HL7NL",
"telecom": [ {
"value": "https://hl7.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent"
}